freenet.client.async

Class ClientRequestScheduler

java.lang.Object

freenet.client.async.ClientRequestScheduler

All Implemented Interfaces:

RequestScheduler

public class ClientRequestScheduler
extends java.lang.Object
implements RequestScheduler

Every X seconds, the RequestSender calls the ClientRequestScheduler to ask for a request to start. A request is then started, in its own thread. It is removed at that point.

Field Summary

Fields

Modifier and Type	Field and Description
ClientContext	clientContext
java.lang.String	name
static java.lang.String	PRIORITY_HARD
static java.lang.String	PRIORITY_NONE
static java.lang.String	PRIORITY_SOFT

Fields inherited from interface freenet.node.RequestScheduler

COOLDOWN_PERIOD, COOLDOWN_RETRIES

Constructor Summary

Constructors

Constructor and Description
ClientRequestScheduler(boolean forInserts, boolean forSSKs, boolean forRT, RandomSource random, RequestStarter starter, Node node, NodeClientCore core, java.lang.String name, ClientContext context)

Method Summary

Modifier and Type	Method and Description
boolean	addRunningInsert(SendableInsert insert, SendableRequestItemKey token)
boolean	addToFetching(Key key)
void	callFailure(SendableGet get, LowLevelGetException e, int prio, boolean persistent)
void	callFailure(SendableInsert insert, LowLevelPutException e, int prio, boolean persistent)
long	countPersistentWaitingKeys()
long	countQueuedRequests()
void	dequeueOfferedKey(Key key)
KeysFetchingLocally	fetchingKeys()
java.lang.String	getChoosenPriorityScheduler()
ClientContext	getContext()
KeySalter	getGlobalKeySalter(boolean persistent)
ClientRequestSelector	getSelector()
ChosenBlock	grabRequest() Called by RequestStarter to find a request to run.
boolean	hasFetchingKey(Key key, BaseSendableGet getterWaiting, boolean persistent) Check whether a key is already being fetched.
boolean	isInsertScheduler()
boolean	isRunningOrQueuedPersistentRequest(SendableRequest request) This only works for persistent requests, because transient requests are not selected on a SendableRequest level, they are selected on a {SendableRequest, token} level.
void	queueOfferedKey(Key key, boolean realTime) Queue the offered key
void	register(HasKeyListener hasListener, SendableGet[] getters, boolean persistent, BlockSet blocks, boolean noCheckStore) Register a group of requests (not inserts): a GotKeyListener and/or one or more SendableGet's.
void	registerInsert(SendableRequest req, boolean persistent)
void	removeFetchingKey(Key key)
void	removePendingKeys(HasKeyListener getter, boolean complain) Remove a KeyListener from the list of KeyListeners.
void	removePendingKeys(KeyListener getter, boolean complain) Remove a KeyListener from the list of KeyListeners.
void	removeRunningInsert(SendableInsert insert, SendableRequestItemKey token)
void	removeRunningRequest(SendableRequest request)
void	reregisterAll(ClientRequester request, short oldPrio)
byte[]	saltKey(boolean persistent, Key key)
void	setPriorityScheduler(java.lang.String val) Called by the config.
void	startCore(byte[] globalSaltPersistent)
void	succeeded(BaseSendableGet succeeded, boolean persistent) Tell the scheduler that a request from a specific RandomGrabArray succeeded.
void	tripPendingKey(KeyBlock block)
void	wakeStarter()
boolean	wantKey(Key key)

Methods inherited from class java.lang.Object

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

Field Detail

name

public final java.lang.String name

clientContext

public final ClientContext clientContext

PRIORITY_NONE

public static final java.lang.String PRIORITY_NONE

See Also:

Constant Field Values

PRIORITY_SOFT

public static final java.lang.String PRIORITY_SOFT

See Also:

Constant Field Values

PRIORITY_HARD

public static final java.lang.String PRIORITY_HARD

See Also:

Constant Field Values

Constructor Detail

ClientRequestScheduler

public ClientRequestScheduler(boolean forInserts,
                              boolean forSSKs,
                              boolean forRT,
                              RandomSource random,
                              RequestStarter starter,
                              Node node,
                              NodeClientCore core,
                              java.lang.String name,
                              ClientContext context)

Method Detail

startCore

public void startCore(byte[] globalSaltPersistent)

setPriorityScheduler

public void setPriorityScheduler(java.lang.String val)

Called by the config. Callback

Parameters:

val -

registerInsert

public void registerInsert(SendableRequest req,
                           boolean persistent)

register

public void register(HasKeyListener hasListener,
                     SendableGet[] getters,
                     boolean persistent,
                     BlockSet blocks,
                     boolean noCheckStore)

Register a group of requests (not inserts): a GotKeyListener and/or one or more SendableGet's.

Parameters:

hasListener - Listens for specific keys. Can be null if the listener is already registered i.e. on retrying.

getters - The actual requests to register to the request sender queue.

persistent - True if the request is persistent.

onDatabaseThread - True if we are running on the database thread. NOTE: delayedStoreCheck/probablyNotInStore is unnecessary because we only register the listener once.

Throws:

FetchException

removeRunningRequest

public void removeRunningRequest(SendableRequest request)

Specified by:

removeRunningRequest in interface RequestScheduler

isRunningOrQueuedPersistentRequest

public boolean isRunningOrQueuedPersistentRequest(SendableRequest request)

Description copied from interface: RequestScheduler

This only works for persistent requests, because transient requests are not selected on a SendableRequest level, they are selected on a {SendableRequest, token} level.

Specified by:

isRunningOrQueuedPersistentRequest in interface RequestScheduler

grabRequest

public ChosenBlock grabRequest()

Called by RequestStarter to find a request to run.

Specified by:

grabRequest in interface RequestScheduler

removePendingKeys

public void removePendingKeys(KeyListener getter,
                              boolean complain)

Remove a KeyListener from the list of KeyListeners.

Parameters:

getter -

complain -

removePendingKeys

public void removePendingKeys(HasKeyListener getter,
                              boolean complain)

Remove a KeyListener from the list of KeyListeners.

Parameters:

getter -

complain -

reregisterAll

public void reregisterAll(ClientRequester request,
                          short oldPrio)

getChoosenPriorityScheduler

public java.lang.String getChoosenPriorityScheduler()

succeeded

public void succeeded(BaseSendableGet succeeded,
                      boolean persistent)

Description copied from interface: RequestScheduler

Tell the scheduler that a request from a specific RandomGrabArray succeeded. Definition of "succeeded" will vary, but the point is most schedulers will run another request from the parentGrabArray in the near future on the theory that if one works, another may also work.

Specified by:

succeeded in interface RequestScheduler

Parameters:

succeeded - The request we ran, which must be deleted.

tripPendingKey

public void tripPendingKey(KeyBlock block)

wantKey

public boolean wantKey(Key key)

Specified by:

wantKey in interface RequestScheduler

queueOfferedKey

public void queueOfferedKey(Key key,
                            boolean realTime)

Queue the offered key

dequeueOfferedKey

public void dequeueOfferedKey(Key key)

countQueuedRequests

public long countQueuedRequests()

Specified by:

countQueuedRequests in interface RequestScheduler

fetchingKeys

public KeysFetchingLocally fetchingKeys()

Specified by:

fetchingKeys in interface RequestScheduler

removeFetchingKey

public void removeFetchingKey(Key key)

Specified by:

removeFetchingKey in interface RequestScheduler

removeRunningInsert

public void removeRunningInsert(SendableInsert insert,
                                SendableRequestItemKey token)

Specified by:

removeRunningInsert in interface RequestScheduler

callFailure

public void callFailure(SendableGet get,
                        LowLevelGetException e,
                        int prio,
                        boolean persistent)

Specified by:

callFailure in interface RequestScheduler

callFailure

public void callFailure(SendableInsert insert,
                        LowLevelPutException e,
                        int prio,
                        boolean persistent)

Specified by:

callFailure in interface RequestScheduler

getContext

public ClientContext getContext()

Specified by:

getContext in interface RequestScheduler

addToFetching

public boolean addToFetching(Key key)

Specified by:

addToFetching in interface RequestScheduler

Returns:

True unless the key was already present.

addRunningInsert

public boolean addRunningInsert(SendableInsert insert,
                                SendableRequestItemKey token)

Specified by:

addRunningInsert in interface RequestScheduler

hasFetchingKey

public boolean hasFetchingKey(Key key,
                              BaseSendableGet getterWaiting,
                              boolean persistent)

Description copied from interface: RequestScheduler

Check whether a key is already being fetched. If it is, optionally remember who is asking so we can wake them up (on the cooldown queue) when the key fetch completes.

Specified by:

hasFetchingKey in interface RequestScheduler

Returns:

countPersistentWaitingKeys

public long countPersistentWaitingKeys()

isInsertScheduler

public boolean isInsertScheduler()

wakeStarter

public void wakeStarter()

Specified by:

wakeStarter in interface RequestScheduler

saltKey

public byte[] saltKey(boolean persistent,
                      Key key)

getGlobalKeySalter

public KeySalter getGlobalKeySalter(boolean persistent)

getSelector

public ClientRequestSelector getSelector()

Specified by:

getSelector in interface RequestScheduler