SendableRequest (fred API)

java.lang.Object
- freenet.node.SendableRequest

All Implemented Interfaces:

RequestSelectionTreeNode, RandomGrabArrayItem, java.io.Serializable

Direct Known Subclasses:

BaseSendableGet, SendableInsert
```
public abstract class SendableRequest
extends java.lang.Object
implements RandomGrabArrayItem, java.io.Serializable
```
A low-level request which can be sent immediately. These are registered on the ClientRequestScheduler. LOCKING: Because some subclasses may do wierd things like locking on an external object (see e.g. SplitFileFetcherSubSegment), if we do take the lock we need to do it last i.e. not call any subclass methods inside it. WARNING: Changing non-transient members on classes that are Serializable can result in restarting downloads or losing uploads. Not all subclasses of this class are actually persisted.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected RandomGrabArray`	`parentGrabArray`
`protected boolean`	`persistent` Member because must be accessible when only marginally activated
`protected boolean`	`realTimeFlag`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract SendableRequestItem`	`chooseKey(KeysFetchingLocally keys, ClientContext context)` Choose a key to fetch.
`void`	`clearWakeupTime(ClientContext context)` When a request becomes fetchable, set all the wakeup times above it to 0.
`abstract long`	`countAllKeys(ClientContext context)` All key identifiers.
`abstract long`	`countSendableKeys(ClientContext context)` All key identifiers currently eligible to be sent.
`abstract RequestClient`	`getClient()` Get client context object.
`abstract ClientRequester`	`getClientRequest()` Get the ClientRequest.
`RandomGrabArray`	`getParentGrabArray()` Return the parent RequestSelectionTreeNode or null if it's not in the tree or is the root (e.g.
`abstract short`	`getPriorityClass()` Get the priority class of the request.
`abstract ClientRequestScheduler`	`getScheduler(ClientContext context)`
`ClientRequestSchedulerGroup`	`getSchedulerGroup()`
`abstract SendableRequestSender`	`getSender(ClientContext context)` Get or create a SendableRequestSender for this object.
`int`	`hashCode()`
`abstract void`	`internalError(java.lang.Throwable t, RequestScheduler sched, ClientContext context, boolean persistent)` Requeue after an internal error
`abstract boolean`	`isCancelled()` If true, the request has been cancelled, or has completed, either way it need not be registered any more.
`abstract boolean`	`isInsert()` Is this an insert? For purposes of determining which scheduler to use.
`abstract boolean`	`isSSK()` Is this an SSK? For purposes of determining which scheduler to use.
`boolean`	`knowsParentGrabArray()` Does this RandomGrabArrayItem support remembering where it is registered?
`protected java.lang.String`	`objectToString()`
`boolean`	`persistent()` Is this request persistent? MUST NOT CHANGE.
`boolean`	`realTimeFlag()`
`boolean`	`reduceWakeupTime(long wakeupTime, ClientContext context)` If the current cooldown time is larger than the parameter, reduce it and recurse up the tree.
`void`	`setParentGrabArray(RandomGrabArray parent)` Notify the item that it has been registered on a specific RandomGrabArray
`void`	`unregister(ClientContext context, short oldPrio)` Unregister the request.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface freenet.support.RandomGrabArrayItem
getWakeupTime

- Field Detail
  - realTimeFlag
```
protected final boolean realTimeFlag
```
  - parentGrabArray
```
protected transient RandomGrabArray parentGrabArray
```
  - persistent
```
protected final boolean persistent
```
    Member because must be accessible when only marginally activated
- Method Detail
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - getPriorityClass
```
public abstract short getPriorityClass()
```
    Get the priority class of the request.
  - chooseKey
```
public abstract SendableRequestItem chooseKey(KeysFetchingLocally keys,
                                              ClientContext context)
```
    Choose a key to fetch. Must not modify any persisted structures, but will update cooldowns etc to avoid it being chosen again soon. There is a separate callback for when a fetch fails, succeeds, etc. Hence it is safe to call these outside of the PersistentJobRunner.
    
    Returns:
    
    An object identifying a specific key. null indicates no keys available.
  - countAllKeys
```
public abstract long countAllKeys(ClientContext context)
```
    All key identifiers. Including those not currently eligible to be sent because they are on a cooldown queue, requests for them are in progress, etc.
  - countSendableKeys
```
public abstract long countSendableKeys(ClientContext context)
```
    All key identifiers currently eligible to be sent. Does not include those currently running, on the cooldown queue etc.
  - getSender
```
public abstract SendableRequestSender getSender(ClientContext context)
```
    Get or create a SendableRequestSender for this object. This is a non-persistent object used to send the requests. @see SendableGet.getSender().
    
    Parameters:
    
    context - A client context may also be necessary.
    
    Returns:
  - isCancelled
```
public abstract boolean isCancelled()
```
    If true, the request has been cancelled, or has completed, either way it need not be registered any more. isEmpty() on the other hand means there are no queued blocks.
  - getClient
```
public abstract RequestClient getClient()
```
    Get client context object. This isn't called as frequently as you might expect - once on registration, and then when there is an error. So it doesn't need to be stored on the request itself, hence we pass in a container.
  - persistent
```
public final boolean persistent()
```
    Is this request persistent? MUST NOT CHANGE.
  - getClientRequest
```
public abstract ClientRequester getClientRequest()
```
    Get the ClientRequest. This DOES need to be cached on the request itself.
  - getParentGrabArray
```
public RandomGrabArray getParentGrabArray()
```
    Description copied from interface: RequestSelectionTreeNode
    
    Return the parent RequestSelectionTreeNode or null if it's not in the tree or is the root (e.g. priority classes are kept in an array on ClientRequestSelector).
    
    Specified by:
    
    getParentGrabArray in interface RequestSelectionTreeNode
    
    Specified by:
    
    getParentGrabArray in interface RandomGrabArrayItem
  - knowsParentGrabArray
```
public boolean knowsParentGrabArray()
```
    Description copied from interface: RandomGrabArrayItem
    
    Does this RandomGrabArrayItem support remembering where it is registered?
    
    Specified by:
    
    knowsParentGrabArray in interface RandomGrabArrayItem
  - setParentGrabArray
```
public void setParentGrabArray(RandomGrabArray parent)
```
    Description copied from interface: RandomGrabArrayItem
    
    Notify the item that it has been registered on a specific RandomGrabArray
    
    Specified by:
    
    setParentGrabArray in interface RandomGrabArrayItem
  - unregister
```
public void unregister(ClientContext context,
                       short oldPrio)
```
    Unregister the request.
    
    Parameters:
    
    context -
    
    oldPrio - If we are changing priorities it can matter what the old priority is. However the parent method, SendableRequest, ignores this. In any case, (short)-1 means not specified (look it up).
  - getScheduler
```
public abstract ClientRequestScheduler getScheduler(ClientContext context)
```
  - isSSK
```
public abstract boolean isSSK()
```
    Is this an SSK? For purposes of determining which scheduler to use.
  - isInsert
```
public abstract boolean isInsert()
```
    Is this an insert? For purposes of determining which scheduler to use.
  - internalError
```
public abstract void internalError(java.lang.Throwable t,
                                   RequestScheduler sched,
                                   ClientContext context,
                                   boolean persistent)
```
    Requeue after an internal error
  - realTimeFlag
```
public boolean realTimeFlag()
```
  - objectToString
```
protected final java.lang.String objectToString()
```
  - reduceWakeupTime
```
public boolean reduceWakeupTime(long wakeupTime,
                                ClientContext context)
```
    Description copied from interface: RequestSelectionTreeNode
    
    If the current cooldown time is larger than the parameter, reduce it and recurse up the tree. If we reach the root and wake it up, then wake up the scheduler. Returns true if anything changed.
    
    Specified by:
    
    reduceWakeupTime in interface RequestSelectionTreeNode
  - clearWakeupTime
```
public void clearWakeupTime(ClientContext context)
```
    Description copied from interface: RequestSelectionTreeNode
    
    When a request becomes fetchable, set all the wakeup times above it to 0. Will recurse up the tree.
    
    Specified by:
    
    clearWakeupTime in interface RequestSelectionTreeNode
  - getSchedulerGroup
```
public ClientRequestSchedulerGroup getSchedulerGroup()
```

Class SendableRequest

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface freenet.support.RandomGrabArrayItem

Field Detail

realTimeFlag

parentGrabArray

persistent

Method Detail

hashCode

getPriorityClass

chooseKey

countAllKeys

countSendableKeys

getSender

isCancelled

getClient

persistent

getClientRequest

getParentGrabArray

knowsParentGrabArray

setParentGrabArray

unregister

getScheduler

isSSK

isInsert

internalError

realTimeFlag

objectToString

reduceWakeupTime

clearWakeupTime

getSchedulerGroup