Package org.jboss.netty.handler.stream
Class ChunkedFile
- java.lang.Object
-
- org.jboss.netty.handler.stream.ChunkedFile
-
- All Implemented Interfaces:
ChunkedInput
public class ChunkedFile extends Object implements ChunkedInput
AChunkedInput
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 useFileRegion
instead.
-
-
Constructor Summary
Constructors Constructor Description ChunkedFile(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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
Releases the resources associated with the stream.long
getCurrentOffset()
Returns the offset in the file where the transfer is happening currently.long
getEndOffset()
Returns the offset in the file where the transfer will end.long
getStartOffset()
Returns the offset in the file where the transfer began.boolean
hasNextChunk()
Returnstrue
if and only if there is any data left in the stream.boolean
isEndOfInput()
Returntrue
if and only if there is no data left in the stream and the stream has reached at its end.Object
nextChunk()
Fetches a chunked data from the stream.
-
-
-
Constructor Detail
-
ChunkedFile
public ChunkedFile(File file) throws IOException
Creates a new instance that fetches data from the specified file.- Throws:
IOException
-
ChunkedFile
public ChunkedFile(File file, int chunkSize) throws IOException
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) throws IOException
Creates a new instance that fetches data from the specified file.- Throws:
IOException
-
ChunkedFile
public ChunkedFile(RandomAccessFile file, int chunkSize) throws IOException
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 Detail
-
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
public boolean hasNextChunk() throws Exception
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
public boolean isEndOfInput() throws Exception
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
public void close() throws Exception
Description copied from interface:ChunkedInput
Releases the resources associated with the stream.- Specified by:
close
in interfaceChunkedInput
- Throws:
Exception
-
nextChunk
public Object nextChunk() throws Exception
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
-
-