io.netty.handler.stream

类 ChunkedStream

java.lang.Object

io.netty.handler.stream.ChunkedStream

所有已实现的接口:

ChunkedInput<ByteBuf>

public class ChunkedStream
extends java.lang.Object
implements ChunkedInput<ByteBuf>

A ChunkedInput that fetches data from an InputStream chunk by chunk.

Please note that the InputStream instance that feeds data into ChunkedStream must implement InputStream.available() as accurately as possible, rather than using the default implementation. Otherwise, ChunkedStream will generate many too small chunks or block unnecessarily often.

构造器概要

构造器

构造器和说明
ChunkedStream(java.io.InputStream in) Creates a new instance that fetches data from the specified stream.
ChunkedStream(java.io.InputStream in, int chunkSize) Creates a new instance that fetches data from the specified stream.

方法概要

限定符和类型	方法和说明
void	close() Releases the resources associated with the input.
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	transferredBytes() Returns the number of transferred bytes.

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

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

构造器详细资料

ChunkedStream

public ChunkedStream(java.io.InputStream in)

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

ChunkedStream

public ChunkedStream(java.io.InputStream in,
                     int chunkSize)

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

参数:

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

方法详细资料

transferredBytes

public long transferredBytes()

Returns the number of transferred bytes.

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>