Class AbstractBinDataConsumer
java.lang.Object
org.apache.hc.core5.http.nio.entity.AbstractBinDataConsumer
- All Implemented Interfaces:
AsyncDataConsumer
,ResourceHolder
- Direct Known Subclasses:
AbstractBinAsyncEntityConsumer
Abstract binary data consumer.
- Since:
- 5.0
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract int
Triggered to obtain the capacity increment.protected abstract void
Triggered to signal completion of data processing.final void
consume
(ByteBuffer src) Triggered to pass incoming data to the data consumer.protected abstract void
data
(ByteBuffer src, boolean endOfStream) Triggered to pass incoming data packet to the data consumer.final void
Triggered to signal termination of the data stream.final void
updateCapacity
(CapacityChannel capacityChannel) Triggered to signal ability of the underlying data stream to receive data capacity update.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apache.hc.core5.http.nio.ResourceHolder
releaseResources
-
Field Details
-
EMPTY
-
-
Constructor Details
-
AbstractBinDataConsumer
public AbstractBinDataConsumer()
-
-
Method Details
-
capacityIncrement
protected abstract int capacityIncrement()Triggered to obtain the capacity increment.- Returns:
- the number of bytes this consumer is prepared to process.
-
data
Triggered to pass incoming data packet to the data consumer.- Parameters:
src
- the data packet.endOfStream
- flag indicating whether this data packet is the last in the data stream.- Throws:
IOException
-
completed
Triggered to signal completion of data processing.- Throws:
IOException
-
updateCapacity
Description copied from interface: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.- Specified by:
updateCapacity
in interfaceAsyncDataConsumer
- Parameters:
capacityChannel
- the channel for capacity updates.- Throws:
IOException
-
consume
Description copied from interface: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.- Specified by:
consume
in interfaceAsyncDataConsumer
- Parameters:
src
- data source.- Throws:
IOException
-
streamEnd
Description copied from interface:AsyncDataConsumer
Triggered to signal termination of the data stream.- Specified by:
streamEnd
in interfaceAsyncDataConsumer
- Parameters:
trailers
- data stream trailers.- Throws:
HttpException
IOException
-