freenet.client.async

Class SimpleHealingQueue

java.lang.Object

freenet.client.async.ClientRequester

freenet.client.async.BaseClientPutter

freenet.client.async.SimpleHealingQueue

All Implemented Interfaces:

ClientRequestSchedulerGroup, HealingQueue, PutCompletionCallback, java.io.Serializable

public class SimpleHealingQueue
extends BaseClientPutter
implements HealingQueue, PutCompletionCallback

See Also:

Serialized Form

Field Summary

Fields inherited from class freenet.client.async.ClientRequester

blockSetFinalized, cancelled, client, creationTime, failedBlocks, fatallyFailedBlocks, latestFailure, latestSuccess, minSuccessBlocks, priorityClass, realTimeFlag, sentToNetwork, successfulBlocks, totalBlocks

Constructor Summary

Constructors

Constructor and Description
SimpleHealingQueue(InsertContext context, short prio, int maxRunning)

Method Summary

Modifier and Type	Method and Description
void	cancel(ClientContext context) Cancel the request.
protected ClientBaseCallback	getCallback()
int	getMinSuccessFetchBlocks()
FreenetURI	getURI() Get the URI for the request or insert.
protected void	innerNotifyClients(ClientContext context) Notify clients, usually via a SplitfileProgressEvent, of the current progress.
void	innerOnResume(ClientContext context) Called by onResume() once and only once after restarting.
boolean	innerQueue(Bucket data, byte[] cryptoKey, byte cryptoAlgorithm, ClientContext context)
protected void	innerToNetwork(ClientContext context) Notify clients that a request has gone to the network, for the first time, i.e.
boolean	isFinished() Is the request or insert completed (succeeded, failed, or cancelled, which is a kind of failure)?
void	onBlockSetFinished(ClientPutState state, ClientContext context) Called when the ClientPutState knows that it knows about all the blocks it will need to put.
void	onEncode(BaseClientKey usk, ClientPutState state, ClientContext context) Called when we know the final URI of the state in question.
void	onFailure(InsertException e, ClientPutState state, ClientContext context)
void	onFetchable(ClientPutState state) Called when enough data has been inserted that the file can be retrieved, even if not all data has been inserted yet.
void	onMetadata(Bucket meta, ClientPutState state, ClientContext context) Called as an alternative to onEncode, if a metadata length threshold was specified.
void	onMetadata(Metadata m, ClientPutState state, ClientContext context) Only called if explicitly asked for, in which case, generally the metadata won't be inserted.
void	onSuccess(ClientPutState state, ClientContext context)
void	onTransition(ClientGetState oldState, ClientGetState newState, ClientContext context)
void	onTransition(ClientPutState oldState, ClientPutState newState, ClientContext context)
void	queue(Bucket data, byte[] cryptoKey, byte cryptoAlgorithm, ClientContext context) Queue a Bucket of data to insert as a CHK.

Methods inherited from class freenet.client.async.BaseClientPutter

dump

Methods inherited from class freenet.client.async.ClientRequester

addBlock, addBlocks, addMustSucceedBlocks, addRedundantBlocksInsert, blockSetFinalized, cancel, clearCountersOnRestart, completedBlock, failedBlock, failedBlock, fatallyFailedBlock, getAll, getClient, getClientDetail, getClientDetail, getLatestFailure, getLatestSuccess, getPriorityClass, getSchedulerGroup, getTotalBlocks, hashCode, isCancelled, isCurrentState, notifyClients, onResume, onShutdown, persistent, realTimeFlag, resetBlocks, setPriorityClass, toNetwork

Methods inherited from class java.lang.Object

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

Methods inherited from interface freenet.client.async.PutCompletionCallback

onResume

Constructor Detail

SimpleHealingQueue

public SimpleHealingQueue(InsertContext context,
                          short prio,
                          int maxRunning)

Method Detail

innerQueue

public boolean innerQueue(Bucket data,
                          byte[] cryptoKey,
                          byte cryptoAlgorithm,
                          ClientContext context)

queue

public void queue(Bucket data,
                  byte[] cryptoKey,
                  byte cryptoAlgorithm,
                  ClientContext context)

Description copied from interface: HealingQueue

Queue a Bucket of data to insert as a CHK.

Specified by:

queue in interface HealingQueue

getURI

public FreenetURI getURI()

Description copied from class: ClientRequester

Get the URI for the request or insert. For a request this is set at creation, but for an insert, it is set when we know what the final URI will be.

Specified by:

getURI in class ClientRequester

isFinished

public boolean isFinished()

Description copied from class: ClientRequester

Is the request or insert completed (succeeded, failed, or cancelled, which is a kind of failure)?

Specified by:

isFinished in class ClientRequester

innerNotifyClients

protected void innerNotifyClients(ClientContext context)

Description copied from class: ClientRequester

Notify clients, usually via a SplitfileProgressEvent, of the current progress. Called off-thread. Please do not change SimpleEventProducer to always produce events off-thread, it is better to deal with that here, because events could be re-ordered, which matters for some events notably SimpleProgressEvent.

Specified by:

innerNotifyClients in class ClientRequester

onSuccess

public void onSuccess(ClientPutState state,
                      ClientContext context)

Specified by:

onSuccess in interface PutCompletionCallback

onFailure

public void onFailure(InsertException e,
                      ClientPutState state,
                      ClientContext context)

Specified by:

onFailure in interface PutCompletionCallback

onEncode

public void onEncode(BaseClientKey usk,
                     ClientPutState state,
                     ClientContext context)

Description copied from interface: PutCompletionCallback

Called when we know the final URI of the state in question. The currentState eventually calls this on the ClientPutter, which relays to the fcp layer, which sends a URIGenerated message.

Specified by:

onEncode in interface PutCompletionCallback

onTransition

public void onTransition(ClientPutState oldState,
                         ClientPutState newState,
                         ClientContext context)

Specified by:

onTransition in interface PutCompletionCallback

Specified by:

onTransition in class BaseClientPutter

onMetadata

public void onMetadata(Metadata m,
                       ClientPutState state,
                       ClientContext context)

Description copied from interface: PutCompletionCallback

Only called if explicitly asked for, in which case, generally the metadata won't be inserted. Won't be called if there isn't any!

Specified by:

onMetadata in interface PutCompletionCallback

onBlockSetFinished

public void onBlockSetFinished(ClientPutState state,
                               ClientContext context)

Description copied from interface: PutCompletionCallback

Called when the ClientPutState knows that it knows about all the blocks it will need to put.

Specified by:

onBlockSetFinished in interface PutCompletionCallback

onFetchable

public void onFetchable(ClientPutState state)

Description copied from interface: PutCompletionCallback

Called when enough data has been inserted that the file can be retrieved, even if not all data has been inserted yet. Note that this is only supported for splitfiles; if you get onSuccess() first, assume that onFetchable() isn't coming.

Specified by:

onFetchable in interface PutCompletionCallback

onTransition

public void onTransition(ClientGetState oldState,
                         ClientGetState newState,
                         ClientContext context)

Specified by:

onTransition in class ClientRequester

innerToNetwork

protected void innerToNetwork(ClientContext context)

Description copied from class: ClientRequester

Notify clients that a request has gone to the network, for the first time, i.e. we have finished checking the datastore for at least one part of the request.

Specified by:

innerToNetwork in class ClientRequester

cancel

public void cancel(ClientContext context)

Description copied from class: ClientRequester

Cancel the request. Subclasses must implement to actually tell the ClientGetState's or ClientPutState's to cancel.

Specified by:

cancel in class ClientRequester

Parameters:

context - The ClientContext object including essential but non-persistent objects such as the schedulers.

getMinSuccessFetchBlocks

public int getMinSuccessFetchBlocks()

Specified by:

getMinSuccessFetchBlocks in class BaseClientPutter

onMetadata

public void onMetadata(Bucket meta,
                       ClientPutState state,
                       ClientContext context)

Description copied from interface: PutCompletionCallback

Called as an alternative to onEncode, if a metadata length threshold was specified. Lower-level insert states, such as SplitFileInserter, will call onMetadata() instead. Higher level insert states will call this version or onEncode. Callee must free the Bucket. FIXME arguably we should split the interface, it might simplify e.g. SingleFileInserter.SplitHandler.

Specified by:

onMetadata in interface PutCompletionCallback

innerOnResume

public void innerOnResume(ClientContext context)

Description copied from class: ClientRequester

Called by onResume() once and only once after restarting. Must be overridden, and must call super.innerOnResume().

Overrides:

innerOnResume in class ClientRequester

getCallback

protected ClientBaseCallback getCallback()

Specified by:

getCallback in class ClientRequester