Class DiscardingEntityConsumer<T>
- java.lang.Object
-
- org.apache.hc.core5.http.nio.entity.DiscardingEntityConsumer<T>
-
- All Implemented Interfaces:
AsyncDataConsumer
,AsyncEntityConsumer<T>
,ResourceHolder
public final class DiscardingEntityConsumer<T> extends java.lang.Object implements AsyncEntityConsumer<T>
No-opAsyncEntityConsumer
that discards all data from the data stream.- Since:
- 5.2
-
-
Field Summary
Fields Modifier and Type Field Description private FutureCallback<T>
resultCallback
-
Constructor Summary
Constructors Constructor Description DiscardingEntityConsumer()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
consume(java.nio.ByteBuffer src)
Triggered to pass incoming data to the data consumer.void
failed(java.lang.Exception cause)
Triggered to signal a failure in data processing.T
getContent()
Returns the result of entity processing when it becomes available ornull
if the entity is still being received.void
releaseResources()
void
streamEnd(java.util.List<? extends Header> trailers)
Triggered to signal termination of the data stream.void
streamStart(EntityDetails entityDetails, FutureCallback<T> resultCallback)
Signals beginning of an incoming request entity stream.void
updateCapacity(CapacityChannel capacityChannel)
Triggered to signal ability of the underlying data stream to receive data capacity update.
-
-
-
Field Detail
-
resultCallback
private volatile FutureCallback<T> resultCallback
-
-
Method Detail
-
streamStart
public void streamStart(EntityDetails entityDetails, FutureCallback<T> resultCallback) throws java.io.IOException, HttpException
Description copied from interface:AsyncEntityConsumer
Signals beginning of an incoming request entity stream.- Specified by:
streamStart
in interfaceAsyncEntityConsumer<T>
- Parameters:
entityDetails
- the details of the incoming message entity.resultCallback
- the result callback.- Throws:
java.io.IOException
HttpException
-
updateCapacity
public void updateCapacity(CapacityChannel capacityChannel) throws java.io.IOException
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:
java.io.IOException
-
consume
public void consume(java.nio.ByteBuffer src) throws java.io.IOException
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:
java.io.IOException
-
streamEnd
public void streamEnd(java.util.List<? extends Header> trailers) throws java.io.IOException
Description copied from interface:AsyncDataConsumer
Triggered to signal termination of the data stream.- Specified by:
streamEnd
in interfaceAsyncDataConsumer
- Parameters:
trailers
- data stream trailers.- Throws:
java.io.IOException
-
failed
public void failed(java.lang.Exception cause)
Description copied from interface:AsyncEntityConsumer
Triggered to signal a failure in data processing.- Specified by:
failed
in interfaceAsyncEntityConsumer<T>
- Parameters:
cause
- the cause of the failure.
-
getContent
public T getContent()
Description copied from interface:AsyncEntityConsumer
Returns the result of entity processing when it becomes available ornull
if the entity is still being received.- Specified by:
getContent
in interfaceAsyncEntityConsumer<T>
- Returns:
- the response processing result.
-
releaseResources
public void releaseResources()
- Specified by:
releaseResources
in interfaceResourceHolder
-
-