freenet.client.async

Class OfferedKeysList

java.lang.Object

freenet.node.SendableRequest

freenet.node.BaseSendableGet

freenet.client.async.OfferedKeysList

All Implemented Interfaces:

RequestSelectionTreeNode, RequestClient, RandomGrabArrayItem, java.io.Serializable

public class OfferedKeysList
extends BaseSendableGet
implements RequestClient

All the keys at a given priority which we have received key offers from other nodes for. This list needs to be kept up to date when: - A request is removed. - A request's priority changes. - A key is found. - A node disconnects or restarts (through the BlockOffer objects on the FailureTable). And of course, when an offer is received, we need to add an element.

See Also:

Serialized Form

Field Summary

Fields inherited from class freenet.node.SendableRequest

parentGrabArray, persistent, realTimeFlag

Method Summary

Modifier and Type	Method and Description
SendableRequestItem	chooseKey(KeysFetchingLocally fetching, 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.
ClientRequester	getClientRequest() Get the ClientRequest.
Key	getNodeKey(SendableRequestItem token) Get a numbered key to fetch.
short	getPriorityClass() Get the priority class of the request.
ClientRequestScheduler	getScheduler(ClientContext context)
SendableRequestSender	getSender(ClientContext context) Get or create a SendableRequestSender for this object.
long	getWakeupTime(ClientContext context, long now) Unless this is a RandomGrabArrayItem, this will return the wakeup time for the subtree rooted at this node.
void	internalError(java.lang.Throwable t, RequestScheduler sched, ClientContext context, boolean persistent) Requeue after an internal error
boolean	isCancelled() If true, the request has been cancelled, or has completed, either way it need not be registered any more.
boolean	isEmpty()
boolean	isInsert() Is this an insert? For purposes of determining which scheduler to use.
boolean	isSSK() Is this an SSK? For purposes of determining which scheduler to use.
boolean	preRegister(ClientContext context, boolean toNetwork) Called after checking the datastore and before registering the request to be sent.
void	queueKey(Key key)
void	remove(Key key) Called when a key is found, when it no longer belongs to this list etc.

Methods inherited from class freenet.node.SendableRequest

clearWakeupTime, getParentGrabArray, getSchedulerGroup, hashCode, knowsParentGrabArray, objectToString, persistent, realTimeFlag, reduceWakeupTime, setParentGrabArray, unregister

Methods inherited from class java.lang.Object

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

Methods inherited from interface freenet.node.RequestClient

persistent, realTimeFlag

Method Detail

remove

public void remove(Key key)

Called when a key is found, when it no longer belongs to this list etc.

isEmpty

public boolean isEmpty()

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

chooseKey

public SendableRequestItem chooseKey(KeysFetchingLocally fetching,
                                     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.

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

getPriorityClass

public short getPriorityClass()

Description copied from class: SendableRequest

Get the priority class of the request.

Specified by:

getPriorityClass in class SendableRequest

internalError

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

Description copied from class: SendableRequest

Requeue after an internal error

Specified by:

internalError in class SendableRequest

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:

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 class SendableRequest

queueKey

public void queueKey(Key key)

getNodeKey

public Key getNodeKey(SendableRequestItem token)

Description copied from class: BaseSendableGet

Get a numbered key to fetch.

Specified by:

getNodeKey in class BaseSendableGet

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

isInsert

public 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

getScheduler

public ClientRequestScheduler getScheduler(ClientContext context)

Specified by:

getScheduler in class SendableRequest

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

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