Top Description Fields Constructors Methods
io.netty5.handler.stream

public Class ChunkedNioFile

extends Object
implements ChunkedInput<Buffer>
Class Inheritance
All Implemented Interfaces
io.netty5.handler.stream.ChunkedInput, java.lang.AutoCloseable
Imports
io.netty5.buffer.Buffer, .BufferAllocator, io.netty5.channel.FileRegion, java.io.File, .IOException, java.nio.channels.ClosedChannelException, .FileChannel, java.nio.file.StandardOpenOption
A 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.

Field Summary

Modifier and TypeField and Description
private final int
chunkSize

private final long
endOffset

private final FileChannel
in

private long
offset

private final long
startOffset

Constructor Summary

AccessConstructor and Description
public
ChunkedNioFile(File in)

Creates a new instance that fetches data from the specified file.

public
ChunkedNioFile(File in, int
the number of bytes to fetch on each readChunk(BufferAllocator) call.
chunkSize)

Creates a new instance that fetches data from the specified file.

public
ChunkedNioFile(FileChannel in)

Creates a new instance that fetches data from the specified file.

public
ChunkedNioFile(FileChannel in, int
the number of bytes to fetch on each readChunk(BufferAllocator) call.
chunkSize)

Creates a new instance that fetches data from the specified file.

public
ChunkedNioFile(FileChannel in, long
the offset of the file where the transfer begins
offset, long
the number of bytes to transfer
length, int
the number of bytes to fetch on each readChunk(BufferAllocator) call.
chunkSize)

Creates a new instance that fetches data from the specified file.

Method Summary

Modifier and TypeMethod and Description
public void
close()

Implements java.lang.AutoCloseable.close.

Closes this resource, relinquishing any underlying resources.
public long
currentOffset()

Returns the offset in the file where the transfer is happening currently.

public long
endOffset()

Returns the offset in the file where the transfer will end.

public boolean
isEndOfInput()

Implements io.netty5.handler.stream.ChunkedInput.isEndOfInput.

Return true if and only if there is no data left in the stream and the stream has reached at its end.
public long
length()

Implements io.netty5.handler.stream.ChunkedInput.length.

Returns the length of the input.
public long
progress()

Implements io.netty5.handler.stream.ChunkedInput.progress.

Returns current transfer progress.
public Buffer
readChunk(BufferAllocator
BufferAllocator if buffer allocation is necessary.
allocator)

Implements io.netty5.handler.stream.ChunkedInput.readChunk.

Fetches a chunked data from the stream.
public long
startOffset()

Returns the offset in the file where the transfer began.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

chunkSizeback to summary
private final int chunkSize
endOffsetback to summary
private final long endOffset
inback to summary
private final FileChannel in
offsetback to summary
private long offset
startOffsetback to summary
private final long startOffset

Constructor Detail

ChunkedNioFileback to summary
public ChunkedNioFile(File in) throws IOException

Creates a new instance that fetches data from the specified file.

ChunkedNioFileback to summary
public ChunkedNioFile(File in, int chunkSize) throws IOException

Creates a new instance that fetches data from the specified file.

Parameters
chunkSize:int

the number of bytes to fetch on each readChunk(BufferAllocator) call.

ChunkedNioFileback to summary
public ChunkedNioFile(FileChannel in) throws IOException

Creates a new instance that fetches data from the specified file.

ChunkedNioFileback to summary
public ChunkedNioFile(FileChannel in, int chunkSize) throws IOException

Creates a new instance that fetches data from the specified file.

Parameters
chunkSize:int

the number of bytes to fetch on each readChunk(BufferAllocator) call.

ChunkedNioFileback to summary
public ChunkedNioFile(FileChannel in, long offset, long length, int chunkSize) throws IOException

Creates a new instance that fetches data from the specified file.

Parameters
offset:long

the offset of the file where the transfer begins

length:long

the number of bytes to transfer

chunkSize:int

the number of bytes to fetch on each readChunk(BufferAllocator) call.

Method Detail

closeback to summary
public void close() throws Exception

Implements java.lang.AutoCloseable.close.

Doc from java.lang.AutoCloseable.close.

Closes this resource, relinquishing any underlying resources. This method is invoked automatically on objects managed by the try-with-resources statement.

Annotations
@Override
Exceptions
Exception:
if this resource cannot be closed
currentOffsetback to summary
public long currentOffset()

Returns the offset in the file where the transfer is happening currently.

endOffsetback to summary
public long endOffset()

Returns the offset in the file where the transfer will end.

isEndOfInputback to summary
public boolean isEndOfInput() throws Exception

Implements io.netty5.handler.stream.ChunkedInput.isEndOfInput.

Doc from io.netty5.handler.stream.ChunkedInput.isEndOfInput.

Return true if and only if there is no data left in the stream and the stream has reached at its end.

Annotations
@Override
lengthback to summary
public long length()

Implements io.netty5.handler.stream.ChunkedInput.length.

Doc from io.netty5.handler.stream.ChunkedInput.length.

Returns the length of the input.

Returns:long

the length of the input if the length of the input is known. a negative value if the length of the input is unknown.

Annotations
@Override
progressback to summary
public long progress()

Implements io.netty5.handler.stream.ChunkedInput.progress.

Doc from io.netty5.handler.stream.ChunkedInput.progress.

Returns current transfer progress.

Annotations
@Override
readChunkback to summary
public Buffer readChunk(BufferAllocator allocator) throws Exception

Implements io.netty5.handler.stream.ChunkedInput.readChunk.

Doc from io.netty5.handler.stream.ChunkedInput.readChunk.

Fetches a chunked data from the stream. Once this method returns the last chunk and thus the stream has reached at its end, any subsequent isEndOfInput() call must return true.

Parameters
allocator:BufferAllocator

BufferAllocator if buffer allocation is necessary.

Returns:Buffer

the fetched chunk. 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.

Annotations
@Override
startOffsetback to summary
public long startOffset()

Returns the offset in the file where the transfer began.