public class ChunkedNioFile extends Object implements ChunkedInput
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.
Constructor and Description |
---|
ChunkedNioFile(File in)
Creates a new instance that fetches data from the specified file.
|
ChunkedNioFile(FileChannel in)
Creates a new instance that fetches data from the specified file.
|
ChunkedNioFile(FileChannel in,
int chunkSize)
Creates a new instance that fetches data from the specified file.
|
ChunkedNioFile(FileChannel in,
long offset,
long length,
int chunkSize)
Creates a new instance that fetches data from the specified file.
|
ChunkedNioFile(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 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()
Returns
true if and only if there is any data left in the
stream. |
boolean |
isEndOfInput()
Return
true 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.
|
public ChunkedNioFile(File in) throws IOException
IOException
public ChunkedNioFile(File in, int chunkSize) throws IOException
chunkSize
- the number of bytes to fetch on each
nextChunk()
callIOException
public ChunkedNioFile(FileChannel in) throws IOException
IOException
public ChunkedNioFile(FileChannel in, int chunkSize) throws IOException
chunkSize
- the number of bytes to fetch on each
nextChunk()
callIOException
public ChunkedNioFile(FileChannel in, long offset, long length, int chunkSize) throws 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
nextChunk()
callIOException
public long getStartOffset()
public long getEndOffset()
public long getCurrentOffset()
public boolean hasNextChunk() throws Exception
ChunkedInput
true
if and only if there is any data left in the
stream. Please note that false
does not necessarily mean that
the stream has reached at its end. In a slow stream, the next chunk
might be unavailable just momentarily.hasNextChunk
in interface ChunkedInput
Exception
public boolean isEndOfInput() throws Exception
ChunkedInput
true
if and only if there is no data left in the stream
and the stream has reached at its end.isEndOfInput
in interface ChunkedInput
Exception
public void close() throws Exception
ChunkedInput
close
in interface ChunkedInput
Exception
public Object nextChunk() throws Exception
ChunkedInput
ChannelBuffer
, but you could extend an existing implementation
to convert the ChannelBuffer
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 subsequent ChunkedInput.isEndOfInput()
call must return false
.nextChunk
in interface ChunkedInput
ChannelBuffer
.
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.Exception
Copyright © 2008-2013 The Netty Project. All Rights Reserved.