public class ChunkedNioFile extends java.lang.Object implements ChunkedInput<ByteBuf>
ChunkedInput that fetches data from a file chunk by chunk using
NIO FileChannel.
If your operating system supports
zero-copy file transfer
such as sendfile(), you might want to use FileRegion instead.
| Modifier and Type | Field and Description |
|---|---|
private int |
chunkSize |
private long |
endOffset |
private java.nio.channels.FileChannel |
in |
private long |
offset |
private long |
startOffset |
| Constructor and Description |
|---|
ChunkedNioFile(java.io.File in)
Creates a new instance that fetches data from the specified file.
|
ChunkedNioFile(java.nio.channels.FileChannel in)
Creates a new instance that fetches data from the specified file.
|
ChunkedNioFile(java.nio.channels.FileChannel in,
int chunkSize)
Creates a new instance that fetches data from the specified file.
|
ChunkedNioFile(java.nio.channels.FileChannel in,
long offset,
long length,
int chunkSize)
Creates a new instance that fetches data from the specified file.
|
ChunkedNioFile(java.io.File in,
int chunkSize)
Creates a new instance that fetches data from the specified file.
|
| Modifier and Type | Method and Description |
|---|---|
void |
close()
Releases the resources associated with the input.
|
long |
currentOffset()
Returns the offset in the file where the transfer is happening currently.
|
long |
endOffset()
Returns the offset in the file where the transfer will end.
|
boolean |
isEndOfInput()
Return
true if and only if there is no data left in the stream
and the stream has reached at its end. |
long |
length()
Returns the length of the input.
|
long |
progress()
Returns current transfer progress.
|
ByteBuf |
readChunk(ByteBufAllocator allocator)
Fetches a chunked data from the stream.
|
ByteBuf |
readChunk(ChannelHandlerContext ctx)
Deprecated.
|
long |
startOffset()
Returns the offset in the file where the transfer began.
|
private final java.nio.channels.FileChannel in
private final long startOffset
private final long endOffset
private final int chunkSize
private long offset
public ChunkedNioFile(java.io.File in)
throws java.io.IOException
java.io.IOExceptionpublic ChunkedNioFile(java.io.File in,
int chunkSize)
throws java.io.IOException
chunkSize - the number of bytes to fetch on each
readChunk(ChannelHandlerContext) calljava.io.IOExceptionpublic ChunkedNioFile(java.nio.channels.FileChannel in)
throws java.io.IOException
java.io.IOExceptionpublic ChunkedNioFile(java.nio.channels.FileChannel in,
int chunkSize)
throws java.io.IOException
chunkSize - the number of bytes to fetch on each
readChunk(ChannelHandlerContext) calljava.io.IOExceptionpublic ChunkedNioFile(java.nio.channels.FileChannel in,
long offset,
long length,
int chunkSize)
throws java.io.IOException
offset - the offset of the file where the transfer beginslength - the number of bytes to transferchunkSize - the number of bytes to fetch on each
readChunk(ChannelHandlerContext) calljava.io.IOExceptionpublic long startOffset()
public long endOffset()
public long currentOffset()
public boolean isEndOfInput()
throws java.lang.Exception
ChunkedInputtrue if and only if there is no data left in the stream
and the stream has reached at its end.isEndOfInput in interface ChunkedInput<ByteBuf>java.lang.Exceptionpublic void close()
throws java.lang.Exception
ChunkedInputclose in interface ChunkedInput<ByteBuf>java.lang.Exception@Deprecated public ByteBuf readChunk(ChannelHandlerContext ctx) throws java.lang.Exception
readChunk in interface ChunkedInput<ByteBuf>ctx - The context which provides a ByteBufAllocator if buffer allocation is necessary.null if there is no data left in the stream.
Please note that null does not necessarily mean that the
stream has reached at its end. In a slow stream, the next chunk
might be unavailable just momentarily.java.lang.Exceptionpublic ByteBuf readChunk(ByteBufAllocator allocator) throws java.lang.Exception
ChunkedInputChunkedInput.isEndOfInput()
call must return true.readChunk in interface ChunkedInput<ByteBuf>allocator - ByteBufAllocator if buffer allocation is necessary.null if there is no data left in the stream.
Please note that null does not necessarily mean that the
stream has reached at its end. In a slow stream, the next chunk
might be unavailable just momentarily.java.lang.Exceptionpublic long length()
ChunkedInputlength in interface ChunkedInput<ByteBuf>public long progress()
ChunkedInputprogress in interface ChunkedInput<ByteBuf>