reactor.ipc.netty.channel.data

Interface FileChunkedStrategy<T>

All Known Implementing Classes:

AbstractFileChunkedStrategy

public interface FileChunkedStrategy<T>

A strategy applied by NettyOutbound when sending a file should be done using a ChunkedInput instead of zero-copy (typically when SSL is used). This in turn allows to manipulate the pipeline and adapt the exact ChunkedInput used to different situation, like TCP vs HTTP.

Author:

Simon Baslé

Method Summary

Modifier and Type	Method and Description
ChunkedInput<T>	chunkFile(FileChannel fileChannel, long offset, long length, int chunkSize) Given the sent file as a RandomAccessFile, return a ChunkedInput "view" of the file, eg.
void	cleanupPipeline(NettyContext context) Once the file has been written, allows to clean the pipeline (see preparePipeline(NettyContext)) and do other operations.
void	preparePipeline(NettyContext context) Allow for preparing the pipeline (eg.

Method Detail

preparePipeline

void preparePipeline(NettyContext context)

Allow for preparing the pipeline (eg. by adding handlers dynamically) before sending the chunked file. The NettyContext is provided and can be used to get the channel() then pipeline().

Parameters:

context - the context from which to obtain the channel and pipeline

chunkFile

ChunkedInput<T> chunkFile(FileChannel fileChannel,
                          long offset,
                          long length,
                          int chunkSize)

Given the sent file as a RandomAccessFile, return a ChunkedInput "view" of the file, eg. as a ChunkedFile or a HttpChunkedInput around a ChunkedFile.

Parameters:

fileChannel - the FileChannel for the file being sent

offset - the offset of the file where the transfer begins

length - the number of bytes to transfer

chunkSize - the number of bytes to fetch on each ChunkedInput.readChunk(ByteBufAllocator) call

Returns:

the file, as a ChunkedInput

cleanupPipeline

void cleanupPipeline(NettyContext context)

Once the file has been written, allows to clean the pipeline (see preparePipeline(NettyContext)) and do other operations.

Parameters:

context - the context from which to obtain the channel and pipeline