org.jboss.netty.handler.stream

类 ChunkedFile

java.lang.Object

org.jboss.netty.handler.stream.ChunkedFile

所有已实现的接口:

ChunkedInput

public class ChunkedFile
extends java.lang.Object
implements 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.

构造器概要

构造器

构造器和说明
ChunkedFile(java.io.File file) Creates a new instance that fetches data from the specified file.
ChunkedFile(java.io.File file, int chunkSize) Creates a new instance that fetches data from the specified file.
ChunkedFile(java.io.RandomAccessFile file) Creates a new instance that fetches data from the specified file.
ChunkedFile(java.io.RandomAccessFile file, int chunkSize) Creates a new instance that fetches data from the specified file.
ChunkedFile(java.io.RandomAccessFile file, long offset, long length, int chunkSize) Creates a new instance that fetches data from the specified file.

方法概要

方法

限定符和类型	方法和说明
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.
java.lang.Object	nextChunk() Fetches a chunked data from the stream.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

ChunkedFile

public ChunkedFile(java.io.File file)
            throws java.io.IOException

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

抛出:

java.io.IOException

ChunkedFile

public ChunkedFile(java.io.File file,
           int chunkSize)
            throws java.io.IOException

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

参数:

chunkSize - the number of bytes to fetch on each nextChunk() call

抛出:

java.io.IOException

ChunkedFile

public ChunkedFile(java.io.RandomAccessFile file)
            throws java.io.IOException

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

抛出:

java.io.IOException

ChunkedFile

public ChunkedFile(java.io.RandomAccessFile file,
           int chunkSize)
            throws java.io.IOException

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

参数:

chunkSize - the number of bytes to fetch on each nextChunk() call

抛出:

java.io.IOException

ChunkedFile

public ChunkedFile(java.io.RandomAccessFile file,
           long offset,
           long length,
           int chunkSize)
            throws java.io.IOException

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

参数:

offset - the offset of the file where the transfer begins

length - the number of bytes to transfer

chunkSize - the number of bytes to fetch on each nextChunk() call

抛出:

java.io.IOException

方法详细资料

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 java.lang.Exception

从接口复制的说明: ChunkedInput

Returns 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 在接口中 ChunkedInput

抛出:

java.lang.Exception

isEndOfInput

public boolean isEndOfInput()
                     throws java.lang.Exception

从接口复制的说明: ChunkedInput

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

指定者:

isEndOfInput 在接口中 ChunkedInput

抛出:

java.lang.Exception

close

public void close()
           throws java.lang.Exception

从接口复制的说明: ChunkedInput

Releases the resources associated with the stream.

指定者:

close 在接口中 ChunkedInput

抛出:

java.lang.Exception

nextChunk

public java.lang.Object nextChunk()
                           throws java.lang.Exception

从接口复制的说明: ChunkedInput

Fetches a chunked data from the stream. The returned chunk is usually a 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 在接口中 ChunkedInput

返回:

the fetched chunk, which is usually 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.

抛出:

java.lang.Exception