org.apache.hc.core5.http.nio.entity

类 AbstractCharDataConsumer

java.lang.Object

org.apache.hc.core5.http.nio.entity.AbstractCharDataConsumer

所有已实现的接口:

AsyncDataConsumer, ResourceHolder

直接已知子类:

AbstractCharAsyncEntityConsumer, AbstractCharPushConsumer, AbstractCharResponseConsumer

public abstract class AbstractCharDataConsumer
extends Object
implements AsyncDataConsumer

Abstract text data consumer.

从以下版本开始:

5.0

字段概要

字段

限定符和类型	字段和说明
protected static int	DEF_BUF_SIZE

构造器概要

构造器

限定符	构造器和说明
	AbstractCharDataConsumer()
protected	AbstractCharDataConsumer(int bufSize, CharCodingConfig charCodingConfig)

方法概要

限定符和类型	方法和说明
protected abstract int	capacityIncrement() Triggered to obtain the capacity increment.
protected abstract void	completed() Triggered to signal completion of data processing.
void	consume(ByteBuffer src) Triggered to pass incoming data to the data consumer.
protected abstract void	data(CharBuffer src, boolean endOfStream) Triggered to pass incoming data packet to the data consumer.
protected void	setCharset(Charset charset)
void	streamEnd(List<? extends Header> trailers) Triggered to signal termination of the data stream.
void	updateCapacity(CapacityChannel capacityChannel) Triggered to signal ability of the underlying data stream to receive data capacity update.

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

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

从接口继承的方法 org.apache.hc.core5.http.nio.ResourceHolder

releaseResources

字段详细资料

DEF_BUF_SIZE

protected static final int DEF_BUF_SIZE

另请参阅:

常量字段值

构造器详细资料

AbstractCharDataConsumer

protected AbstractCharDataConsumer(int bufSize,
                                   CharCodingConfig charCodingConfig)

AbstractCharDataConsumer

public AbstractCharDataConsumer()

方法详细资料

capacityIncrement

protected abstract int capacityIncrement()

Triggered to obtain the capacity increment.

返回:

the number of bytes this consumer is prepared to process.

data

protected abstract void data(CharBuffer src,
                             boolean endOfStream)
                      throws IOException

Triggered to pass incoming data packet to the data consumer.

参数:

src - the data packet.

endOfStream - flag indicating whether this data packet is the last in the data stream.

抛出:

IOException

completed

protected abstract void completed()
                           throws IOException

Triggered to signal completion of data processing.

抛出:

IOException

setCharset

protected final void setCharset(Charset charset)

updateCapacity

public final void updateCapacity(CapacityChannel capacityChannel)
                          throws IOException

从接口复制的说明: AsyncDataConsumer

Triggered to signal ability of the underlying data stream to receive data capacity update. The data consumer can choose to write data immediately inside the call or asynchronously at some later point.

指定者:

updateCapacity 在接口中 AsyncDataConsumer

参数:

capacityChannel - the channel for capacity updates.

抛出:

IOException

consume

public final void consume(ByteBuffer src)
                   throws IOException

从接口复制的说明: AsyncDataConsumer

Triggered to pass incoming data to the data consumer. The consumer must consume the entire content of the data buffer. The consumer must stop incrementing its capacity on the capacity channel if it is unable to accept more data. Once the data consumer has handled accumulated data or allocated more intermediate storage it can update its capacity information on the capacity channel.

指定者:

consume 在接口中 AsyncDataConsumer

参数:

src - data source.

抛出:

IOException

streamEnd

public final void streamEnd(List<? extends Header> trailers)
                     throws HttpException,
                            IOException

从接口复制的说明: AsyncDataConsumer

Triggered to signal termination of the data stream.

指定者:

streamEnd 在接口中 AsyncDataConsumer

参数:

trailers - data stream trailers.

抛出:

HttpException

IOException