Package io.netty.handler.stream
Class ChunkedFile
java.lang.Object
io.netty.handler.stream.ChunkedFile
- All Implemented Interfaces:
ChunkedInput<ByteBuf>
A
ChunkedInput
that fetches data from a file chunk by chunk.
If your operating system supports
zero-copy file transfer
such as sendfile()
, you might want to use FileRegion
instead.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final int
private final long
private final RandomAccessFile
private long
private final long
-
Constructor Summary
ConstructorsConstructorDescriptionChunkedFile
(File file) Creates a new instance that fetches data from the specified file.ChunkedFile
(File file, int chunkSize) Creates a new instance that fetches data from the specified file.ChunkedFile
(RandomAccessFile file) Creates a new instance that fetches data from the specified file.ChunkedFile
(RandomAccessFile file, int chunkSize) Creates a new instance that fetches data from the specified file.ChunkedFile
(RandomAccessFile file, long offset, long length, int chunkSize) Creates a new instance that fetches data from the specified file. -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Releases the resources associated with the input.long
Returns the offset in the file where the transfer is happening currently.long
Returns the offset in the file where the transfer will end.boolean
Returntrue
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.readChunk
(ByteBufAllocator allocator) Fetches a chunked data from the stream.Deprecated.long
Returns the offset in the file where the transfer began.
-
Field Details
-
file
-
startOffset
private final long startOffset -
endOffset
private final long endOffset -
chunkSize
private final int chunkSize -
offset
private long offset
-
-
Constructor Details
-
ChunkedFile
Creates a new instance that fetches data from the specified file.- Throws:
IOException
-
ChunkedFile
Creates a new instance that fetches data from the specified file.- Parameters:
chunkSize
- the number of bytes to fetch on eachreadChunk(ChannelHandlerContext)
call- Throws:
IOException
-
ChunkedFile
Creates a new instance that fetches data from the specified file.- Throws:
IOException
-
ChunkedFile
Creates a new instance that fetches data from the specified file.- Parameters:
chunkSize
- the number of bytes to fetch on eachreadChunk(ChannelHandlerContext)
call- Throws:
IOException
-
ChunkedFile
public ChunkedFile(RandomAccessFile file, long offset, long length, int chunkSize) throws IOException Creates a new instance that fetches data from the specified file.- Parameters:
offset
- the offset of the file where the transfer beginslength
- the number of bytes to transferchunkSize
- the number of bytes to fetch on eachreadChunk(ChannelHandlerContext)
call- Throws:
IOException
-
-
Method Details
-
startOffset
public long startOffset()Returns the offset in the file where the transfer began. -
endOffset
public long endOffset()Returns the offset in the file where the transfer will end. -
currentOffset
public long currentOffset()Returns the offset in the file where the transfer is happening currently. -
isEndOfInput
Description copied from interface:ChunkedInput
Returntrue
if and only if there is no data left in the stream and the stream has reached at its end.- Specified by:
isEndOfInput
in interfaceChunkedInput<ByteBuf>
- Throws:
Exception
-
close
Description copied from interface:ChunkedInput
Releases the resources associated with the input.- Specified by:
close
in interfaceChunkedInput<ByteBuf>
- Throws:
Exception
-
readChunk
Deprecated.- Specified by:
readChunk
in interfaceChunkedInput<ByteBuf>
- Parameters:
ctx
- The context which provides aByteBufAllocator
if buffer allocation is necessary.- Returns:
- the fetched chunk.
null
if there is no data left in the stream. Please note thatnull
does not necessarily mean that the stream has reached at its end. In a slow stream, the next chunk might be unavailable just momentarily. - Throws:
Exception
-
readChunk
Description copied from interface:ChunkedInput
Fetches a chunked data from the stream. Once this method returns the last chunk and thus the stream has reached at its end, any subsequentChunkedInput.isEndOfInput()
call must returntrue
.- Specified by:
readChunk
in interfaceChunkedInput<ByteBuf>
- Parameters:
allocator
-ByteBufAllocator
if buffer allocation is necessary.- Returns:
- the fetched chunk.
null
if there is no data left in the stream. Please note thatnull
does not necessarily mean that the stream has reached at its end. In a slow stream, the next chunk might be unavailable just momentarily. - Throws:
Exception
-
length
public long length()Description copied from interface:ChunkedInput
Returns the length of the input.- Specified by:
length
in interfaceChunkedInput<ByteBuf>
- Returns:
- the length of the input if the length of the input is known. a negative value if the length of the input is unknown.
-
progress
public long progress()Description copied from interface:ChunkedInput
Returns current transfer progress.- Specified by:
progress
in interfaceChunkedInput<ByteBuf>
-