freenet.client.async

Class SplitFileInserter

java.lang.Object

freenet.client.async.SplitFileInserter

All Implemented Interfaces:

ClientPutState, SplitFileInserterStorageCallback, java.io.Serializable

public class SplitFileInserter
extends java.lang.Object
implements ClientPutState, java.io.Serializable, SplitFileInserterStorageCallback

Top level class for a splitfile insert. Note that Storage is not persistent, it will be recreated here on resume, like in splitfile fetches. The actual status is stored in a RAF.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
void	cancel(ClientContext context) Cancel the request.
void	clearCooldown() Called when a block becomes fetchable (unless because of an encode, in which case we only call encodingProgress() )
void	encodingProgress() Called after finishing encoding the check blocks and block keys for another segment.
long	getLength()
BaseClientPutter	getParent() Get the BaseClientPutter responsible for this request state.
short	getPriorityClass() Get request priority class for FEC jobs etc
java.lang.Object	getToken() Get the token, an object which is passed around with the insert and may be used by callers.
void	onFailed(InsertException e) Called if the insert fails.
void	onFinishedEncode() All the segments (and possibly cross-segments) have been encoded.
void	onHasKeys() Called when all segments have been encoded.
void	onInsertedBlock() Called when a block is inserted successfully
void	onResume(ClientContext context) Called on restarting the node for a persistent request.
void	onShutdown(ClientContext context) Called just before the final write of client.dat before the node shuts down.
void	onSucceeded(Metadata metadata) Called when the whole insert has succeeded, i.e.
protected void	reportMetadata(Metadata metadata)
void	schedule(ClientContext context) Schedule the request.
protected void	unregisterSender()

Methods inherited from class java.lang.Object

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

Method Detail

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

schedule

public void schedule(ClientContext context)
              throws InsertException

Description copied from interface: ClientPutState

Schedule the request.

Specified by:

schedule in interface ClientPutState

Throws:

InsertException

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

onResume

public void onResume(ClientContext context)
              throws InsertException,
                     ResumeFailedException

Description copied from interface: ClientPutState

Called on restarting the node for a persistent request. The request must re-schedule itself. Caller must ensure that it is safe to call this method more than once, as we recurse through the graph of dependencies.

Specified by:

onResume in interface ClientPutState

Throws:

InsertException

ResumeFailedException

onFinishedEncode

public void onFinishedEncode()

Description copied from interface: SplitFileInserterStorageCallback

All the segments (and possibly cross-segments) have been encoded.

Specified by:

onFinishedEncode in interface SplitFileInserterStorageCallback

encodingProgress

public void encodingProgress()

Description copied from interface: SplitFileInserterStorageCallback

Called after finishing encoding the check blocks and block keys for another segment. The callback might need to reschedule as there are more blocks available to insert. When this has been called once for each segment we will call onHasKeys().

Specified by:

encodingProgress in interface SplitFileInserterStorageCallback

onHasKeys

public void onHasKeys()

Description copied from interface: SplitFileInserterStorageCallback

Called when all segments have been encoded. So we have all the check blocks and have a CHK for every block. The callback must decide whether to complete / start the next insert level, or whether to wait for all the blocks to insert.

Specified by:

onHasKeys in interface SplitFileInserterStorageCallback

onSucceeded

public void onSucceeded(Metadata metadata)

Description copied from interface: SplitFileInserterStorageCallback

Called when the whole insert has succeeded, i.e. when all blocks have been inserted.

Specified by:

onSucceeded in interface SplitFileInserterStorageCallback

unregisterSender

protected void unregisterSender()

reportMetadata

protected void reportMetadata(Metadata metadata)

onFailed

public void onFailed(InsertException e)

Description copied from interface: SplitFileInserterStorageCallback

Called if the insert fails. All encodes will have finished by the time this is called.

Specified by:

onFailed in interface SplitFileInserterStorageCallback

getLength

public long getLength()

onInsertedBlock

public void onInsertedBlock()

Description copied from interface: SplitFileInserterStorageCallback

Called when a block is inserted successfully

Specified by:

onInsertedBlock in interface SplitFileInserterStorageCallback

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

clearCooldown

public void clearCooldown()

Description copied from interface: SplitFileInserterStorageCallback

Called when a block becomes fetchable (unless because of an encode, in which case we only call encodingProgress() )

Specified by:

clearCooldown in interface SplitFileInserterStorageCallback

getPriorityClass

public short getPriorityClass()

Description copied from interface: SplitFileInserterStorageCallback

Get request priority class for FEC jobs etc

Specified by:

getPriorityClass in interface SplitFileInserterStorageCallback