freenet.node

Class SimpleSendableInsert

java.lang.Object

freenet.node.SendableRequest

freenet.node.SendableInsert

freenet.node.SimpleSendableInsert

All Implemented Interfaces:

RequestSelectionTreeNode, RandomGrabArrayItem, java.io.Serializable

public class SimpleSendableInsert
extends SendableInsert

Simple SendableInsert implementation. No feedback, no retries, just insert the block. Not designed for use by the client layer (and not persistent). Used by the node layer for the 1 in every 200 successful requests which starts an insert.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
KeyBlock	block
RequestClient	client
short	prioClass
ClientRequestScheduler	scheduler

Fields inherited from class freenet.node.SendableRequest

parentGrabArray, persistent, realTimeFlag

Constructor Summary

Constructors

Constructor and Description
SimpleSendableInsert(KeyBlock block, short prioClass, RequestClient client, ClientRequestScheduler scheduler)
SimpleSendableInsert(NodeClientCore core, KeyBlock block, short prioClass)

Method Summary

Modifier and Type	Method and Description
void	cancel(ClientContext context)
boolean	canWriteClientCache()
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.
boolean	forkOnCacheable()
RequestClient	getClient() Get client context object.
ClientRequester	getClientRequest() Get the ClientRequest.
short	getPriorityClass() Get the priority class of the request.
ClientRequestSchedulerGroup	getSchedulerGroup()
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.
protected void	innerOnResume(ClientContext context)
boolean	isCancelled() If true, the request has been cancelled, or has completed, either way it need not be registered any more.
boolean	isEmpty()
boolean	isSSK() Is this an SSK? For purposes of determining which scheduler to use.
boolean	localRequestOnly()
void	onEncode(SendableRequestItem token, ClientKey key, ClientContext context) Encoded a key
void	onFailure(LowLevelPutException e, SendableRequestItem keyNum, ClientContext context) Called when we don't!
void	onSuccess(SendableRequestItem keyNum, ClientKey key, ClientContext context) Called when we successfully insert the data
void	schedule()

Methods inherited from class freenet.node.SendableInsert

getScheduler, internalError, isInsert, onResume

Methods inherited from class freenet.node.SendableRequest

clearWakeupTime, getParentGrabArray, 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

Field Detail

block

public final KeyBlock block

prioClass

public final short prioClass

client

public final RequestClient client

scheduler

public final ClientRequestScheduler scheduler

Constructor Detail

SimpleSendableInsert

public SimpleSendableInsert(NodeClientCore core,
                            KeyBlock block,
                            short prioClass)

SimpleSendableInsert

public SimpleSendableInsert(KeyBlock block,
                            short prioClass,
                            RequestClient client,
                            ClientRequestScheduler scheduler)

Method Detail

onSuccess

public void onSuccess(SendableRequestItem keyNum,
                      ClientKey key,
                      ClientContext context)

Description copied from class: SendableInsert

Called when we successfully insert the data

Specified by:

onSuccess in class SendableInsert

onFailure

public void onFailure(LowLevelPutException e,
                      SendableRequestItem keyNum,
                      ClientContext context)

Description copied from class: SendableInsert

Called when we don't!

Specified by:

onFailure in class SendableInsert

getPriorityClass

public short getPriorityClass()

Description copied from class: SendableRequest

Get the priority class of the request.

Specified by:

getPriorityClass 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:

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

getSchedulerGroup

public ClientRequestSchedulerGroup getSchedulerGroup()

Overrides:

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

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in class SendableInsert

schedule

public void schedule()

cancel

public void cancel(ClientContext context)

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

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

Overrides:

getWakeupTime in class SendableInsert

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

canWriteClientCache

public boolean canWriteClientCache()

Specified by:

canWriteClientCache in class SendableInsert

forkOnCacheable

public boolean forkOnCacheable()

Specified by:

forkOnCacheable in class SendableInsert

onEncode

public void onEncode(SendableRequestItem token,
                     ClientKey key,
                     ClientContext context)

Description copied from class: SendableInsert

Encoded a key

Specified by:

onEncode in class SendableInsert

localRequestOnly

public boolean localRequestOnly()

Specified by:

localRequestOnly in class SendableInsert

innerOnResume

protected void innerOnResume(ClientContext context)
                      throws InsertException

Specified by:

innerOnResume in class SendableInsert

Throws:

InsertException