freenet.client.async

Interface GetCompletionCallback

All Known Subinterfaces:

FileGetCompletionCallback

All Known Implementing Classes:

BaseClientGetter, ClientGetter, USKFetcherWrapper, USKProxyCompletionCallback, USKRetriever

public interface GetCompletionCallback

Callback called when part of a get request completes - either with a StreamGenerator full of data, or with an error.

Method Summary

Modifier and Type	Method and Description
void	onBlockSetFinished(ClientGetState state, ClientContext context) Called when the ClientGetState knows that it knows about all the blocks it will need to fetch.
void	onExpectedMIME(ClientMetadata metadata, ClientContext context) Called when we know the MIME type of the final data.
void	onExpectedSize(long size, ClientContext context) Called when we know the size of the final data.
void	onExpectedTopSize(long size, long compressed, int blocksReq, int blocksTotal, ClientContext context) Called when we know the size of the final file, and the number of blocks needed etc.
void	onFailure(FetchException e, ClientGetState state, ClientContext context)
void	onFinalizedMetadata()
void	onHashes(HashResult[] hashes, ClientContext context) Called when we know the HashResult of the final file.
void	onSplitfileCompatibilityMode(InsertContext.CompatibilityMode min, InsertContext.CompatibilityMode max, byte[] customSplitfileKey, boolean compressed, boolean bottomLayer, boolean definitiveAnyway, ClientContext context) Called when we know the settings for the splitfile.
void	onSuccess(StreamGenerator streamGenerator, ClientMetadata clientMetadata, java.util.List<? extends Compressor> decompressors, ClientGetState state, ClientContext context)
void	onTransition(ClientGetState oldState, ClientGetState newState, ClientContext context) Called when the ClientGetState handling the request yields control to another ClientGetState.

Method Detail

onSuccess

void onSuccess(StreamGenerator streamGenerator,
               ClientMetadata clientMetadata,
               java.util.List<? extends Compressor> decompressors,
               ClientGetState state,
               ClientContext context)

onFailure

void onFailure(FetchException e,
               ClientGetState state,
               ClientContext context)

onBlockSetFinished

void onBlockSetFinished(ClientGetState state,
                        ClientContext context)

Called when the ClientGetState knows that it knows about all the blocks it will need to fetch.

onTransition

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

Called when the ClientGetState handling the request yields control to another ClientGetState.

Parameters:

oldState - The old ClientGetState.

newState - The new ClientGetState.

context - The database handle. Must not be used by other threads.

onExpectedSize

void onExpectedSize(long size,
                    ClientContext context)

Called when we know the size of the final data. Not the same as onExpectedTopSize(), which is called for new metadata and gives more information. This might be called much later on for older content.

Parameters:

size - The expected size of the final data.

context - Utility object containing helpers, mostly not persistent, such as the Ticker, temporary storage factories etc.

onExpectedMIME

void onExpectedMIME(ClientMetadata metadata,
                    ClientContext context)
             throws FetchException

Called when we know the MIME type of the final data. Useful for e.g. determining whether it is safe to handle etc, although the client can ask for the client layer to handle filtering.

Parameters:

metadata - The MIME type, possibly including parameters, as a String. E.g. "text/html; charset=ISO-8859-1".

context - Utility object containing helpers, mostly not persistent, such as the Ticker, temporary storage factories etc.

Throws:

FetchException - The callee can throw a FetchException to terminate the download e.g. if they can't handle the MIME type.

onFinalizedMetadata

void onFinalizedMetadata()

onExpectedTopSize

void onExpectedTopSize(long size,
                       long compressed,
                       int blocksReq,
                       int blocksTotal,
                       ClientContext context)

Called when we know the size of the final file, and the number of blocks needed etc. For recent metadata, this is known at the time of handling the top block.

Parameters:

size - The final size of the data.

compressed - The size of the data after compression / before decompression.

blocksReq - The number of blocks needed to decode the file.

blocksTotal - The total number of blocks available.

context - Utility object containing helpers, mostly not persistent, such as the Ticker, temporary storage factories etc.

onSplitfileCompatibilityMode

void onSplitfileCompatibilityMode(InsertContext.CompatibilityMode min,
                                  InsertContext.CompatibilityMode max,
                                  byte[] customSplitfileKey,
                                  boolean compressed,
                                  boolean bottomLayer,
                                  boolean definitiveAnyway,
                                  ClientContext context)

Called when we know the settings for the splitfile.

Parameters:

min - The lowest CompatibilityMode that appears to be valid based on what we've fetched so far.

max - The highest CompatibilityMode that appears to be valid based on what we've fetched so far.

customSplitfileKey - The fixed byte[] encryption key used on insert. On anything recent, we generate a single key, randomly for an SSK, or based on the content for a CHK, and use it for everything. This saves metadata space and improves security for SSKs.

compressed - Whether the content is compressed. If false, the dontCompress option was used.

bottomLayer - Whether this report originates at the bottom layer of the splitfile pyramid. I.e. the actual file, not the file containing the metadata to fetch the file (this can recurse for several levels!)

definitiveAnyway - Whether this report is definitive even though it's not from the bottom layer. This is true of recent splitfiles, where we store all the data in the top key.

context - Utility object containing helpers, mostly not persistent, such as the Ticker, temporary storage factories etc.

onHashes

void onHashes(HashResult[] hashes,
              ClientContext context)

Called when we know the HashResult of the final file. This will be checked when we actually fetch it, so is guaranteed to be correct. For recent metadata this is known at the top layer/block.

Parameters:

hashes - A set of hashes for the final file content.

context - Utility object containing helpers, mostly not persistent, such as the Ticker, temporary storage factories etc.