freenet.node

Class SendableGet

java.lang.Object

freenet.node.SendableRequest

freenet.node.BaseSendableGet

freenet.node.SendableGet

All Implemented Interfaces:

RequestSelectionTreeNode, RandomGrabArrayItem, java.io.Serializable

Direct Known Subclasses:

BaseSingleFileFetcher, SplitFileFetcherGet

public abstract class SendableGet
extends BaseSendableGet

A low-level key fetch which can be sent immediately. @see SendableRequest WARNING: Changing non-transient members on classes that are Serializable can result in restarting downloads or losing uploads. (Some children of this class are actually stored)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
ClientRequester	parent Parent BaseClientGetter.

Fields inherited from class freenet.node.SendableRequest

parentGrabArray, persistent, realTimeFlag

Constructor Summary

Constructors

Constructor and Description
SendableGet(ClientRequester parent, boolean realTimeFlag)

Method Summary

Modifier and Type	Method and Description
void	clearWakeupTime(ClientContext context) When a request becomes fetchable, set all the wakeup times above it to 0.
protected abstract ClientGetState	getClientGetState()
abstract FetchContext	getContext() Get the fetch context (settings) object.
abstract long	getCooldownWakeup(SendableRequestItem token, ClientContext context) Get the time at which the key specified by the given token will wake up from the cooldown queue.
abstract ClientKey	getKey(SendableRequestItem token) Get a numbered key to fetch.
Key	getNodeKey(SendableRequestItem token) Get a numbered key to fetch.
ClientRequestScheduler	getScheduler(ClientContext context)
SendableRequestSender	getSender(ClientContext context) Get or create a SendableRequestSender for this object.
void	internalError(java.lang.Throwable t, RequestScheduler sched, ClientContext context, boolean persistent) An internal error occurred, effecting this SendableGet, independantly of any ChosenBlock's.
boolean	isInsert() Is this an insert? For purposes of determining which scheduler to use.
abstract Key[]	listKeys() What keys are we interested in? For purposes of checking the datastore.
abstract void	onFailure(LowLevelGetException e, SendableRequestItem token, ClientContext context) Called when/if the low-level request fails.
boolean	reduceWakeupTime(long wakeupTime, ClientContext context) If the current cooldown time is larger than the parameter, reduce it and recurse up the tree.
static FetchException	translateException(LowLevelGetException e)
void	unregister(ClientContext context, short oldPrio) Unregister the request.

Methods inherited from class freenet.node.BaseSendableGet

preRegister

Methods inherited from class freenet.node.SendableRequest

chooseKey, countAllKeys, countSendableKeys, getClient, getClientRequest, getParentGrabArray, getPriorityClass, getSchedulerGroup, hashCode, isCancelled, isSSK, knowsParentGrabArray, objectToString, persistent, realTimeFlag, setParentGrabArray

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

parent

public final ClientRequester parent

Parent BaseClientGetter. Required for schedulers.

Constructor Detail

SendableGet

public SendableGet(ClientRequester parent,
                   boolean realTimeFlag)

Method Detail

getKey

public abstract ClientKey getKey(SendableRequestItem token)

Get a numbered key to fetch.

getNodeKey

public Key getNodeKey(SendableRequestItem token)

Description copied from class: BaseSendableGet

Get a numbered key to fetch.

Specified by:

getNodeKey in class BaseSendableGet

listKeys

public abstract Key[] listKeys()

What keys are we interested in? For purposes of checking the datastore. This is in SendableGet, *not* KeyListener, in order to deal with it in smaller chunks.

getContext

public abstract FetchContext getContext()

Get the fetch context (settings) object.

onFailure

public abstract void onFailure(LowLevelGetException e,
                               SendableRequestItem token,
                               ClientContext context)

Called when/if the low-level request fails.

getSender

public SendableRequestSender getSender(ClientContext context)

Description copied from class: SendableRequest

Get or create a SendableRequestSender for this object. This is a non-persistent object used to send the requests. @see SendableGet.getSender().

Specified by:

getSender in class SendableRequest

Parameters:

context - A client context may also be necessary.

Returns:

getScheduler

public ClientRequestScheduler getScheduler(ClientContext context)

Specified by:

getScheduler in class SendableRequest

getCooldownWakeup

public abstract long getCooldownWakeup(SendableRequestItem token,
                                       ClientContext context)

Get the time at which the key specified by the given token will wake up from the cooldown queue.

Parameters:

token -

Returns:

internalError

public void internalError(java.lang.Throwable t,
                          RequestScheduler sched,
                          ClientContext context,
                          boolean persistent)

An internal error occurred, effecting this SendableGet, independantly of any ChosenBlock's.

Specified by:

internalError in class SendableRequest

isInsert

public final boolean isInsert()

Description copied from class: SendableRequest

Is this an insert? For purposes of determining which scheduler to use.

Specified by:

isInsert in class SendableRequest

unregister

public void unregister(ClientContext context,
                       short oldPrio)

Description copied from class: SendableRequest

Unregister the request.

Overrides:

unregister in class SendableRequest

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).

translateException

public static FetchException translateException(LowLevelGetException e)

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

Overrides:

reduceWakeupTime in class SendableRequest

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

Overrides:

clearWakeupTime in class SendableRequest

getClientGetState

protected abstract ClientGetState getClientGetState()