io.netty.handler.stream

类 ChunkedFile

java.lang.Object

io.netty.handler.stream.ChunkedFile

所有已实现的接口:

ChunkedInput<ByteBuf>

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

构造器概要

构造器

构造器和说明
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 input.
long	currentOffset() Returns the offset in the file where the transfer is happening currently.
long	endOffset() Returns the offset in the file where the transfer will end.
boolean	isEndOfInput() Return true 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.
ByteBuf	readChunk(ByteBufAllocator allocator) Fetches a chunked data from the stream.
ByteBuf	readChunk(ChannelHandlerContext ctx) 已过时。
long	startOffset() Returns the offset in the file where the transfer began.

从类继承的方法 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 readChunk(ChannelHandlerContext) 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 readChunk(ChannelHandlerContext) 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 readChunk(ChannelHandlerContext) call

抛出:

java.io.IOException

方法详细资料

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

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<ByteBuf>

抛出:

java.lang.Exception

close

public void close()
           throws java.lang.Exception

从接口复制的说明: ChunkedInput

Releases the resources associated with the input.

指定者:

close 在接口中 ChunkedInput<ByteBuf>

抛出:

java.lang.Exception

readChunk

@Deprecated
public ByteBuf readChunk(ChannelHandlerContext ctx)
                               throws java.lang.Exception

已过时。

指定者:

readChunk 在接口中 ChunkedInput<ByteBuf>

参数:

ctx - The context which provides a ByteBufAllocator if buffer allocation is necessary.

返回:

the fetched chunk. 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

readChunk

public ByteBuf readChunk(ByteBufAllocator allocator)
                  throws java.lang.Exception

从接口复制的说明: 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 subsequent ChunkedInput.isEndOfInput() call must return true.

指定者:

readChunk 在接口中 ChunkedInput<ByteBuf>

参数:

allocator - ByteBufAllocator if buffer allocation is necessary.

返回:

the fetched chunk. 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

length

public long length()

从接口复制的说明: ChunkedInput

Returns the length of the input.

指定者:

length 在接口中 ChunkedInput<ByteBuf>

返回:

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()

从接口复制的说明: ChunkedInput

Returns current transfer progress.

指定者:

progress 在接口中 ChunkedInput<ByteBuf>