freenet.client

Class PutWaiter

java.lang.Object

freenet.client.PutWaiter

All Implemented Interfaces:

ClientBaseCallback, ClientPutCallback

public class PutWaiter
extends java.lang.Object
implements ClientPutCallback

Provides a blocking wrapper for an insert. Used for simple blocking APIs such as HighLevelSimpleClient.

Constructor Summary

Constructors

Constructor and Description
PutWaiter(RequestClient client)

Method Summary

Modifier and Type	Method and Description
RequestClient	getRequestClient() Get the RequestClient context object used to indicate which requests are related to each other for scheduling purposes.
void	onFailure(InsertException e, BaseClientPutter state) Called on failed/canceled insert.
void	onFetchable(BaseClientPutter state) Called when the inserted data is fetchable (just a hint, don't rely on this).
void	onGeneratedMetadata(Bucket metadata, BaseClientPutter state) Called when we are returning metadata rather than a URI.
void	onGeneratedURI(FreenetURI uri, BaseClientPutter state) Called when URI is known (e.g.
void	onResume(ClientContext context) Called for a persistent request when the node is restarted.
void	onSuccess(BaseClientPutter state) Called on successful insert.
FreenetURI	waitForCompletion() Waits for the insert to finish, returns the URI generated, throws if it failed.

Methods inherited from class java.lang.Object

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

Constructor Detail

PutWaiter

public PutWaiter(RequestClient client)

Method Detail

onSuccess

public void onSuccess(BaseClientPutter state)

Description copied from interface: ClientPutCallback

Called on successful insert. In this callback you must free the Bucket which you specified for the insert!

Specified by:

onSuccess in interface ClientPutCallback

Parameters:

state - The original BaseClientPutter object which was returned by the .insert() method which started this insert. Can be casted to the return type of that .insert() (to obtain the Bucket).

onFailure

public void onFailure(InsertException e,
                      BaseClientPutter state)

Description copied from interface: ClientPutCallback

Called on failed/canceled insert. In this callback you must free the Bucket which you specified for the insert!

Specified by:

onFailure in interface ClientPutCallback

state - The original BaseClientPutter object which was returned by the .insert() method which started this insert. Can be casted to the return type of that .insert() (to obtain the Bucket).

onGeneratedURI

public void onGeneratedURI(FreenetURI uri,
                           BaseClientPutter state)

Description copied from interface: ClientPutCallback

Called when URI is known (e.g. after encode all CHK blocks). Won't be called if we are returning metadata instead.

Specified by:

onGeneratedURI in interface ClientPutCallback

state - The original BaseClientPutter object which was returned by the .insert() method which started this insert. Can be casted to the return type of that .insert().

waitForCompletion

public FreenetURI waitForCompletion()
                             throws InsertException

Waits for the insert to finish, returns the URI generated, throws if it failed.

Throws:

InsertException

onFetchable

public void onFetchable(BaseClientPutter state)

Description copied from interface: ClientPutCallback

Called when the inserted data is fetchable (just a hint, don't rely on this).

Specified by:

onFetchable in interface ClientPutCallback

Parameters:

state - The original BaseClientPutter object which was returned by the .insert() method which started this insert. Can be casted to the return type of that .insert().

onGeneratedMetadata

public void onGeneratedMetadata(Bucket metadata,
                                BaseClientPutter state)

Description copied from interface: ClientPutCallback

Called when we are returning metadata rather than a URI. This only happens if the originator specified a metadata threshold, and we can get the metadata below that threshold without inserting a single top block.

Specified by:

onGeneratedMetadata in interface ClientPutCallback

Parameters:

metadata - Bucket containing the metadata. Persistent if the insert is persistent. Recipient may keep it, but must eventually free it. The caller will not free it.

state - The original BaseClientPutter object which was returned by the .insert() method which started this insert. Can be casted to the return type of that .insert().

onResume

public void onResume(ClientContext context)

Description copied from interface: ClientBaseCallback

Called for a persistent request when the node is restarted. Must re-register with whatever infrastructure the request is using, e.g. PersistentRequestRoot, persistent temp buckets etc.

Specified by:

onResume in interface ClientBaseCallback

getRequestClient

public RequestClient getRequestClient()

Description copied from interface: ClientBaseCallback

Get the RequestClient context object used to indicate which requests are related to each other for scheduling purposes.

Specified by:

getRequestClient in interface ClientBaseCallback