Apache HttpComponents Core HTTP/1.1 5.2.4 · org.apache.hc.core5.http.nio.entity.AbstractCharDataConsumer

Modifier and Type	Field and Description
private volatile ByteBuffer	byteBuffer
private final CharBuffer	charBuffer
private final CharCodingConfig	charCodingConfig
private volatile Charset	charset
private volatile CharsetDecoder	charsetDecoder
protected static final int	DEF_BUF_SIZE
private static final ByteBuffer	EMPTY_BIN

Access	Constructor and Description
protected	AbstractCharDataConsumer(final int bufSize, final CharCodingConfig charCodingConfig)
public	AbstractCharDataConsumer()

Method Summary

Modifier and Type	Method and Description
protected abstract int	Returns: the number of bytes this consumer is prepared to process. capacityIncrement() Triggered to obtain the capacity increment.
private void	checkResult(final CoderResult result)
protected abstract void	completed() Triggered to signal completion of data processing.
public final void	consume(final ByteBuffer data source. src) Implements org.apache.hc.core5.http.nio.AsyncDataConsumer.consume. Triggered to pass incoming data to the data consumer.
protected abstract void	data(CharBuffer the data packet. src, boolean flag indicating whether this data packet is the last in the data stream. endOfStream) Triggered to pass incoming data packet to the data consumer.
private void	doDecode(final boolean endOfStream)
private CharsetDecoder	getCharsetDecoder()
protected final void	setCharset(final Charset charset)
public final void	streamEnd(final List<? extends Header> data stream trailers. trailers) Implements org.apache.hc.core5.http.nio.AsyncDataConsumer.streamEnd. Triggered to signal termination of the data stream.
public final void	updateCapacity(final CapacityChannel the channel for capacity updates. capacityChannel) Implements org.apache.hc.core5.http.nio.AsyncDataConsumer.updateCapacity. Triggered to signal ability of the underlying data stream to receive data capacity update.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

byteBuffer	back to summary
private volatile ByteBuffer byteBuffer

charBuffer	back to summary
private final CharBuffer charBuffer

charCodingConfig	back to summary
private final CharCodingConfig charCodingConfig

charset	back to summary
private volatile Charset charset

charsetDecoder	back to summary
private volatile CharsetDecoder charsetDecoder

DEF_BUF_SIZE	back to summary
protected static final int DEF_BUF_SIZE

EMPTY_BIN	back to summary
private static final ByteBuffer EMPTY_BIN

AbstractCharDataConsumer	back to summary
protected AbstractCharDataConsumer(final int bufSize, final CharCodingConfig charCodingConfig)

AbstractCharDataConsumer	back to summary
public AbstractCharDataConsumer()

Method Detail

capacityIncrement	back to summary
protected abstract int capacityIncrement() Triggered to obtain the capacity increment. Returns:int the number of bytes this consumer is prepared to process.

capacityIncrement

back to summary

protected abstract int capacityIncrement()

Triggered to obtain the capacity increment.

Returns:int: the number of bytes this consumer is prepared to process.

checkResult	back to summary
private void checkResult(final CoderResult result) throws IOException

completed	back to summary
protected abstract void completed() throws IOException Triggered to signal completion of data processing.

consume	back to summary
public final void consume(final ByteBuffer src) throws IOException Implements org.apache.hc.core5.http.nio.AsyncDataConsumer.consume. Doc from org.apache.hc.core5.http.nio.AsyncDataConsumer.consume. 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. Parameters src:ByteBuffer data source. Annotations @Override

consume

back to summary

public final void consume(final ByteBuffer src) throws IOException

Implements org.apache.hc.core5.http.nio.AsyncDataConsumer.consume.

Doc from org.apache.hc.core5.http.nio.AsyncDataConsumer.consume.

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.

Parameters

src:ByteBuffer: data source.

Annotations

@Override

data	back to summary
protected abstract void data(CharBuffer src, boolean endOfStream) throws IOException Triggered to pass incoming data packet to the data consumer. Parameters src:CharBuffer the data packet. endOfStream:boolean flag indicating whether this data packet is the last in the data stream.

doDecode	back to summary
private void doDecode(final boolean endOfStream) throws IOException

getCharsetDecoder	back to summary
private CharsetDecoder getCharsetDecoder()

setCharset	back to summary
protected final void setCharset(final Charset charset)

streamEnd	back to summary
public final void streamEnd(final List<? extends Header> trailers) throws HttpException, IOException Implements org.apache.hc.core5.http.nio.AsyncDataConsumer.streamEnd. Doc from org.apache.hc.core5.http.nio.AsyncDataConsumer.streamEnd. Triggered to signal termination of the data stream. Parameters trailers:List<? extends Header> data stream trailers. Annotations @Override

streamEnd

back to summary

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

Implements org.apache.hc.core5.http.nio.AsyncDataConsumer.streamEnd.

Doc from org.apache.hc.core5.http.nio.AsyncDataConsumer.streamEnd.

Triggered to signal termination of the data stream.

Parameters

trailers:List<? extends Header>: data stream trailers.

Annotations

@Override

updateCapacity	back to summary
public final void updateCapacity(final CapacityChannel capacityChannel) throws IOException Implements org.apache.hc.core5.http.nio.AsyncDataConsumer.updateCapacity. Doc from org.apache.hc.core5.http.nio.AsyncDataConsumer.updateCapacity. 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. Parameters capacityChannel:CapacityChannel the channel for capacity updates. Annotations @Override

updateCapacity

back to summary

public final void updateCapacity(final CapacityChannel capacityChannel) throws IOException

Implements org.apache.hc.core5.http.nio.AsyncDataConsumer.updateCapacity.

Doc from org.apache.hc.core5.http.nio.AsyncDataConsumer.updateCapacity.

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.

Parameters

capacityChannel:CapacityChannel: the channel for capacity updates.

Annotations

@Override

public abstract Class AbstractCharDataConsumer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail