freenet.client.async

Class SingleBlockInserter

java.lang.Object

freenet.node.SendableRequest

freenet.node.SendableInsert

freenet.client.async.SingleBlockInserter

All Implemented Interfaces:

ClientPutState, RequestSelectionTreeNode, RandomGrabArrayItem, java.io.Serializable

public class SingleBlockInserter
extends SendableInsert
implements ClientPutState, java.io.Serializable

Insert a single block. WARNING: Changing non-transient members on classes that are Serializable can result in restarting downloads or losing uploads.

See Also:

Serialized Form

Field Summary

Fields inherited from class freenet.node.SendableRequest

parentGrabArray, persistent, realTimeFlag

Constructor Summary

Constructors

Constructor and Description

SingleBlockInserter(BaseClientPutter parent, Bucket data, short compressionCodec, FreenetURI uri, InsertContext ctx, boolean realTimeFlag, PutCompletionCallback cb, boolean isMetadata, int sourceLength, int token, boolean addToParent, boolean dontSendEncoded, java.lang.Object tokenObject, ClientContext context, boolean persistent, boolean freeData, int extraInserts, byte cryptoAlgorithm, byte[] cryptoKey) Create a SingleBlockInserter.

Method Summary

Modifier and Type	Method and Description
void	cancel(ClientContext context) Cancel the request.
boolean	canWriteClientCache()
SendableRequestItem	chooseKey(KeysFetchingLocally ignored, 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.
protected ClientKeyBlock	encode(ClientContext context, boolean calledByCB)
boolean	forkOnCacheable()
ClientKeyBlock	getBlock(ClientContext context, boolean calledByCB)
RequestClient	getClient() Get client context object.
ClientRequester	getClientRequest() Get the ClientRequest.
ClientKey	getKeyNoEncode()
BaseClientPutter	getParent() Get the BaseClientPutter responsible for this request state.
short	getPriorityClass() Get the priority class of the request.
SendableRequestSender	getSender(ClientContext context) Get or create a SendableRequestSender for this object.
java.lang.Object	getToken() Get the token, an object which is passed around with the insert and may be used by callers.
FreenetURI	getURI(ClientContext context)
FreenetURI	getURINoEncode()
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 ClientKeyBlock	innerEncode(RandomSource random)
protected static ClientKeyBlock	innerEncode(RandomSource random, FreenetURI uri, Bucket sourceData, boolean isMetadata, short compressionCodec, int sourceLength, java.lang.String compressorDescriptor, byte cryptoAlgorithm, byte[] cryptoKey)
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()
protected void	onEncode(ClientKey key, ClientContext context)
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	onShutdown(ClientContext context) Called just before the final write of client.dat before the node shuts down.
void	onSuccess(SendableRequestItem keyNum, ClientKey key, ClientContext context) Called when we successfully insert the data
void	schedule(ClientContext context) Schedule the request.
void	tryEncode(ClientContext context) Attempt to encode the block, if necessary

Methods inherited from class freenet.node.SendableInsert

getScheduler, internalError, isInsert, onResume

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.client.async.ClientPutState

onResume

Constructor Detail

SingleBlockInserter

public SingleBlockInserter(BaseClientPutter parent,
                           Bucket data,
                           short compressionCodec,
                           FreenetURI uri,
                           InsertContext ctx,
                           boolean realTimeFlag,
                           PutCompletionCallback cb,
                           boolean isMetadata,
                           int sourceLength,
                           int token,
                           boolean addToParent,
                           boolean dontSendEncoded,
                           java.lang.Object tokenObject,
                           ClientContext context,
                           boolean persistent,
                           boolean freeData,
                           int extraInserts,
                           byte cryptoAlgorithm,
                           byte[] cryptoKey)

Create a SingleBlockInserter.

Parameters:

parent - The parent. Must be activated.

data -

compressionCodec - The compression codec.

uri -

ctx -

realTimeFlag -

cb -

isMetadata -

sourceLength - The length of the original, uncompressed data.

token -

addToParent -

dontSendEncoded -

tokenObject -

context -

persistent -

freeData -

extraInserts -

cryptoAlgorithm -

cryptoKey -

Method Detail

innerEncode

protected ClientKeyBlock innerEncode(RandomSource random)
                              throws InsertException

Throws:

InsertException

innerEncode

protected static ClientKeyBlock innerEncode(RandomSource random,
                                            FreenetURI uri,
                                            Bucket sourceData,
                                            boolean isMetadata,
                                            short compressionCodec,
                                            int sourceLength,
                                            java.lang.String compressorDescriptor,
                                            byte cryptoAlgorithm,
                                            byte[] cryptoKey)
                                     throws InsertException,
                                            CHKEncodeException,
                                            java.io.IOException,
                                            SSKEncodeException,
                                            java.net.MalformedURLException,
                                            InvalidCompressionCodecException

Throws:

InsertException

CHKEncodeException

java.io.IOException

SSKEncodeException

java.net.MalformedURLException

InvalidCompressionCodecException

onEncode

protected void onEncode(ClientKey key,
                        ClientContext context)

encode

protected ClientKeyBlock encode(ClientContext context,
                                boolean calledByCB)
                         throws InsertException

Throws:

InsertException

getPriorityClass

public short getPriorityClass()

Description copied from class: SendableRequest

Get the priority class of the request.

Specified by:

getPriorityClass in class SendableRequest

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

getBlock

public ClientKeyBlock getBlock(ClientContext context,
                               boolean calledByCB)

schedule

public void schedule(ClientContext context)
              throws InsertException

Description copied from interface: ClientPutState

Schedule the request.

Specified by:

schedule in interface ClientPutState

Throws:

InsertException

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

getURI

public FreenetURI getURI(ClientContext context)

getURINoEncode

public FreenetURI getURINoEncode()

getKeyNoEncode

public ClientKey getKeyNoEncode()

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

getParent

public BaseClientPutter getParent()

Description copied from interface: ClientPutState

Get the BaseClientPutter responsible for this request state.

Specified by:

getParent in interface ClientPutState

cancel

public void cancel(ClientContext context)

Description copied from interface: ClientPutState

Cancel the request.

Specified by:

cancel in interface ClientPutState

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in class SendableInsert

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

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

getToken

public java.lang.Object getToken()

Description copied from interface: ClientPutState

Get the token, an object which is passed around with the insert and may be used by callers.

Specified by:

getToken in interface ClientPutState

tryEncode

public void tryEncode(ClientContext context)

Attempt to encode the block, if necessary

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

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

chooseKey

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

canWriteClientCache

public boolean canWriteClientCache()

Specified by:

canWriteClientCache in class SendableInsert

localRequestOnly

public boolean localRequestOnly()

Specified by:

localRequestOnly 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

innerOnResume

public void innerOnResume(ClientContext context)
                   throws InsertException,
                          ResumeFailedException

Specified by:

innerOnResume in class SendableInsert

Throws:

InsertException

ResumeFailedException

onShutdown

public void onShutdown(ClientContext context)

Description copied from interface: ClientPutState

Called just before the final write of client.dat before the node shuts down. Should write any dirty data to disk etc.

Specified by:

onShutdown in interface ClientPutState