freenet.client.async

Class SplitFileFetcherGet

java.lang.Object

freenet.node.SendableRequest

freenet.node.BaseSendableGet

freenet.node.SendableGet

freenet.client.async.SplitFileFetcherGet

All Implemented Interfaces:

HasKeyListener, RequestSelectionTreeNode, RandomGrabArrayItem, java.io.Serializable

public class SplitFileFetcherGet
extends SendableGet
implements HasKeyListener

Actually does the splitfile fetch. Only one fetcher object for an entire splitfile. PERSISTENCE: Not persistent, recreated on startup by SplitFileFetcher.

See Also:

Serialized Form

Field Summary

Fields inherited from class freenet.node.SendableRequest

parentGrabArray, persistent, realTimeFlag

Constructor Summary

Constructors

Constructor and Description
SplitFileFetcherGet(SplitFileFetcher fetcher, SplitFileFetcherStorage storage)

Method Summary

Modifier and Type	Method and Description
void	cancel(ClientContext context)
SendableRequestItem	chooseKey(KeysFetchingLocally keys, ClientContext context) Choose a key to fetch.
long	countAllKeys(ClientContext context) All key identifiers.
long	countSendableKeys(ClientContext context) All key identifiers currently eligible to be sent.
RequestClient	getClient() Get client context object.
protected ClientGetState	getClientGetState()
ClientRequester	getClientRequest() Get the ClientRequest.
FetchContext	getContext() Get the fetch context (settings) object.
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.
ClientKey	getKey(SendableRequestItem token) Get a numbered key to fetch.
short	getPriorityClass() Get the priority class of the request.
long	getWakeupTime(ClientContext context, long now) Unless this is a RandomGrabArrayItem, this will return the wakeup time for the subtree rooted at this node.
boolean	hasQueued() Has preRegister() been called?
boolean	isCancelled() If true, the request has been cancelled, or has completed, either way it need not be registered any more.
boolean	isSSK() Is this an SSK? For purposes of determining which scheduler to use.
Key[]	listKeys() What keys are we interested in? For purposes of checking the datastore.
KeyListener	makeKeyListener(ClientContext context, boolean onStartup) Create a KeyListener, a transient object used to determine which keys we want, and to handle any blocks found.
void	onFailure(LowLevelGetException e, SendableRequestItem token, ClientContext context) Called when/if the low-level request fails.
boolean	preRegister(ClientContext context, boolean toNetwork) Called after checking the datastore and before registering the request to be sent.
void	schedule(ClientContext context, boolean ignoreStore) Schedule the fetch.

Methods inherited from class freenet.node.SendableGet

clearWakeupTime, getNodeKey, getScheduler, getSender, internalError, isInsert, reduceWakeupTime, translateException, unregister

Methods inherited from class freenet.node.SendableRequest

getParentGrabArray, getSchedulerGroup, hashCode, knowsParentGrabArray, objectToString, persistent, realTimeFlag, setParentGrabArray

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SplitFileFetcherGet

public SplitFileFetcherGet(SplitFileFetcher fetcher,
                           SplitFileFetcherStorage storage)

Method Detail

getKey

public ClientKey getKey(SendableRequestItem token)

Description copied from class: SendableGet

Get a numbered key to fetch.

Specified by:

getKey in class SendableGet

listKeys

public Key[] listKeys()

Description copied from class: SendableGet

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.

Specified by:

listKeys in class SendableGet

getContext

public FetchContext getContext()

Description copied from class: SendableGet

Get the fetch context (settings) object.

Specified by:

getContext in class SendableGet

onFailure

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

Description copied from class: SendableGet

Called when/if the low-level request fails.

Specified by:

onFailure in class SendableGet

getWakeupTime

public long getWakeupTime(ClientContext context,
                          long now)

Description copied from interface: RequestSelectionTreeNode

Unless this is a RandomGrabArrayItem, this will return the wakeup time for the subtree rooted at this node. For a RandomGrabArrayItem it returns the wakeup time for just that single request.

Specified by:

getWakeupTime in interface RequestSelectionTreeNode

Specified by:

getWakeupTime in interface RandomGrabArrayItem

getCooldownWakeup

public long getCooldownWakeup(SendableRequestItem token,
                              ClientContext context)

Description copied from class: SendableGet

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

Specified by:

getCooldownWakeup in class SendableGet

Returns:

preRegister

public boolean preRegister(ClientContext context,
                           boolean toNetwork)

Description copied from class: BaseSendableGet

Called after checking the datastore and before registering the request to be sent. Some gets may want to cancel here, some may want to send an event to FCP.

Specified by:

preRegister in class BaseSendableGet

toNetwork - If true, we are actually going to send requests (unless we cancel in this callback). If false, we completed all the work assigned.

Returns:

True to cancel the request at this stage i.e. not go to network, in which case *the BSG must handle the failure itself*.

getPriorityClass

public short getPriorityClass()

Description copied from class: SendableRequest

Get the priority class of the request.

Specified by:

getPriorityClass in class SendableRequest

chooseKey

public SendableRequestItem chooseKey(KeysFetchingLocally keys,
                                     ClientContext context)

Description copied from class: SendableRequest

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.

Specified by:

chooseKey in class SendableRequest

Returns:

An object identifying a specific key. null indicates no keys available.

countAllKeys

public long countAllKeys(ClientContext context)

Description copied from class: SendableRequest

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.

Specified by:

countAllKeys in class SendableRequest

countSendableKeys

public long countSendableKeys(ClientContext context)

Description copied from class: SendableRequest

All key identifiers currently eligible to be sent. Does not include those currently running, on the cooldown queue etc.

Specified by:

countSendableKeys in class SendableRequest

isCancelled

public boolean isCancelled()

Description copied from class: SendableRequest

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.

Specified by:

isCancelled in interface HasKeyListener

Specified by:

isCancelled in class SendableRequest

getClient

public RequestClient getClient()

Description copied from class: SendableRequest

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.

Specified by:

getClient in class SendableRequest

getClientRequest

public ClientRequester getClientRequest()

Description copied from class: SendableRequest

Get the ClientRequest. This DOES need to be cached on the request itself.

Specified by:

getClientRequest in class SendableRequest

isSSK

public boolean isSSK()

Description copied from class: SendableRequest

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

Specified by:

isSSK in class SendableRequest

schedule

public void schedule(ClientContext context,
                     boolean ignoreStore)

Schedule the fetch.

Parameters:

context -

ignoreStore - If true, don't check the datastore before re-registering the requests to run. Should be true when rescheduling after a normal cooldown, false after recovering from data corruption (the blocks may still be in the store), false otherwise.

makeKeyListener

public KeyListener makeKeyListener(ClientContext context,
                                   boolean onStartup)

Description copied from interface: HasKeyListener

Create a KeyListener, a transient object used to determine which keys we want, and to handle any blocks found.

Specified by:

makeKeyListener in interface HasKeyListener

Returns:

Null if the HasKeyListener is finished/cancelled/etc.

cancel

public void cancel(ClientContext context)

hasQueued

public boolean hasQueued()

Has preRegister() been called?

getClientGetState

protected ClientGetState getClientGetState()

Specified by:

getClientGetState in class SendableGet