Top Description Methods
org.apache.hc.core5.http.nio

public Interface AsyncDataConsumer

extends ResourceHolder
Known Direct Subinterfaces
org.apache.hc.core5.http.nio.AsyncDataExchangeHandler, org.apache.hc.core5.http.nio.AsyncEntityConsumer, org.apache.hc.core5.http.nio.AsyncPushConsumer, org.apache.hc.core5.http.nio.AsyncRequestConsumer, org.apache.hc.core5.http.nio.AsyncResponseConsumer
Known Direct Implementers
org.apache.hc.core5.http.nio.entity.AbstractBinDataConsumer, org.apache.hc.core5.http.nio.entity.AbstractCharDataConsumer
Imports
java.io.IOException, java.nio.ByteBuffer, java.util.List, org.apache.hc.core5.http.Header, .HttpException

Abstract asynchronous data consumer.
Since
5.0

Method Summary

Modifier and TypeMethod and Description
public void
consume(ByteBuffer
data source.
src
)

Triggered to pass incoming data to the data consumer.

public void
streamEnd(List<? extends Header>
data stream trailers.
trailers
)

Triggered to signal termination of the data stream.

public void
updateCapacity(CapacityChannel
the channel for capacity updates.
capacityChannel
)

Triggered to signal ability of the underlying data stream to receive data capacity update.

Inherited from org.apache.hc.core5.http.nio.ResourceHolder:
releaseResources

Method Detail

consumeback to summary
public void consume(ByteBuffer src) throws IOException

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.

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

Triggered to signal termination of the data stream.

Parameters
trailers:List<? extends Header>

data stream trailers.

updateCapacityback to summary
public void updateCapacity(CapacityChannel capacityChannel) throws IOException

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.