freenet.client.async

Interface PutCompletionCallback

All Known Implementing Classes:

ClientPutter, MultiPutCompletionCallback, SimpleHealingQueue, USKInserter

public interface PutCompletionCallback

Callback called when part of a put request completes.

Method Summary

Modifier and Type	Method and Description
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	onResume(ClientContext context) Called on restarting the node for a persistent request.
void	onSuccess(ClientPutState state, ClientContext context)
void	onTransition(ClientPutState oldState, ClientPutState newState, ClientContext context)

Method Detail

onSuccess

void onSuccess(ClientPutState state,
               ClientContext context)

onFailure

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

onEncode

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

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.

onTransition

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

onMetadata

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

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!

onMetadata

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

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.

onFetchable

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. Note that this is only supported for splitfiles; if you get onSuccess() first, assume that onFetchable() isn't coming.

onBlockSetFinished

void onBlockSetFinished(ClientPutState state,
                        ClientContext context)

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

onResume

void onResume(ClientContext context)
       throws InsertException,
              ResumeFailedException

Called on restarting the node for a persistent request. The request must re-schedule itself.

Throws:

InsertException

ResumeFailedException