Package org.jboss.netty.handler.stream
Class ChunkedFile
java.lang.Object
org.jboss.netty.handler.stream.ChunkedFile
- All Implemented Interfaces:
ChunkedInput
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 stream.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.long
Returns the offset in the file where the transfer began.boolean
Returnstrue
if and only if there is any data left in the stream.boolean
Returntrue
if and only if there is no data left in the stream and the stream has reached at its end.Fetches a chunked data from the stream.
-
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 eachnextChunk()
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 eachnextChunk()
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 eachnextChunk()
call- Throws:
IOException
-
-
Method Details
-
getStartOffset
public long getStartOffset()Returns the offset in the file where the transfer began. -
getEndOffset
public long getEndOffset()Returns the offset in the file where the transfer will end. -
getCurrentOffset
public long getCurrentOffset()Returns the offset in the file where the transfer is happening currently. -
hasNextChunk
Description copied from interface:ChunkedInput
Returnstrue
if and only if there is any data left in the stream. Please note thatfalse
does not necessarily mean that the stream has reached at its end. In a slow stream, the next chunk might be unavailable just momentarily.- Specified by:
hasNextChunk
in interfaceChunkedInput
- Throws:
Exception
-
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
- Throws:
Exception
-
close
Description copied from interface:ChunkedInput
Releases the resources associated with the stream.- Specified by:
close
in interfaceChunkedInput
- Throws:
Exception
-
nextChunk
Description copied from interface:ChunkedInput
Fetches a chunked data from the stream. The returned chunk is usually aChannelBuffer
, but you could extend an existing implementation to convert theChannelBuffer
into a different type that your handler or encoder understands. Once this method returns the last chunk and thus the stream has reached at its end, any subsequentChunkedInput.isEndOfInput()
call must returnfalse
.- Specified by:
nextChunk
in interfaceChunkedInput
- Returns:
- the fetched chunk, which is usually
ChannelBuffer
.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
-