Class ClassicToAsyncResponseConsumer

java.lang.Object

org.apache.hc.core5.http.nio.support.classic.ClassicToAsyncResponseConsumer

All Implemented Interfaces:

AsyncDataConsumer, AsyncResponseConsumer<Void>, ResourceHolder

@Experimental
public class ClassicToAsyncResponseConsumer
extends Object
implements AsyncResponseConsumer<Void>

Since:

5.4

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	ClassicToAsyncResponseConsumer.IncomingHttpEntity
(package private) class	ClassicToAsyncResponseConsumer.InternalInputStream
(package private) static class	ClassicToAsyncResponseConsumer.ResponseData

Field Summary

Fields

Modifier and Type	Field	Description
private final AtomicReference<SharedInputBuffer>	bufferRef
private final AtomicReference<FutureCallback<Void>>	callbackRef
private final CountDownLatch	countDownLatch
private final AtomicReference<Exception>	exceptionRef
private final int	initialBufferSize
private final AtomicReference<ClassicToAsyncResponseConsumer.ResponseData>	responseRef
private final Timeout	timeout

Constructor Summary

Constructors

Constructor	Description
ClassicToAsyncResponseConsumer(int initialBufferSize, Timeout timeout)
ClassicToAsyncResponseConsumer(Timeout timeout)

Method Summary

Modifier and Type	Method	Description
ClassicHttpResponse	blockWaiting()
final void	consume(ByteBuffer src)	Triggered to pass incoming data to the data consumer.
void	consumeResponse(HttpResponse asyncResponse, EntityDetails entityDetails, HttpContext context, FutureCallback<Void> resultCallback)	Triggered to signal receipt of a response message head.
final void	failed(Exception cause)	Triggered to signal a failure in data processing.
(package private) void	fireComplete()
void	informationResponse(HttpResponse response, HttpContext context)	Triggered to signal receipt of an intermediate (1xx) HTTP response.
(package private) void	propagateException()
void	releaseResources()
final void	streamEnd(List<? extends Header> trailers)	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 Object

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

Field Details

initialBufferSize

private final int initialBufferSize

timeout

private final Timeout timeout

countDownLatch

private final CountDownLatch countDownLatch

responseRef

private final AtomicReference<ClassicToAsyncResponseConsumer.ResponseData> responseRef

callbackRef

private final AtomicReference<FutureCallback<Void>> callbackRef

bufferRef

private final AtomicReference<SharedInputBuffer> bufferRef

exceptionRef

private final AtomicReference<Exception> exceptionRef

Constructor Details

ClassicToAsyncResponseConsumer

public ClassicToAsyncResponseConsumer(int initialBufferSize,
 Timeout timeout)

ClassicToAsyncResponseConsumer

public ClassicToAsyncResponseConsumer(Timeout timeout)

Method Details

propagateException

void propagateException()
                 throws IOException

Throws:

IOException

fireComplete

void fireComplete()
           throws IOException

Throws:

IOException

blockWaiting

public ClassicHttpResponse blockWaiting()
                                 throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

consumeResponse

public void consumeResponse(HttpResponse asyncResponse,
 EntityDetails entityDetails,
 HttpContext context,
 FutureCallback<Void> resultCallback)
                     throws HttpException,
IOException

Description copied from interface: AsyncResponseConsumer

Triggered to signal receipt of a response message head.

Specified by:

consumeResponse in interface AsyncResponseConsumer<Void>

Parameters:

asyncResponse - the response message head.

entityDetails - the response entity details or null if the response does not enclose an entity.

context - the actual execution context.

resultCallback - the result callback called when response processing has been completed successfully or unsuccessfully.

Throws:

HttpException - in case of an HTTP protocol violation.

IOException - in case of an I/O error.

informationResponse

public void informationResponse(HttpResponse response,
 HttpContext context)
                         throws HttpException,
IOException

Description copied from interface: AsyncResponseConsumer

Triggered to signal receipt of an intermediate (1xx) HTTP response.

Specified by:

informationResponse in interface AsyncResponseConsumer<Void>

Parameters:

response - the intermediate (1xx) HTTP response.

context - the actual execution context.

Throws:

HttpException - in case of an HTTP protocol violation.

IOException - in case of an I/O error.

updateCapacity

public final void updateCapacity(CapacityChannel capacityChannel)
                          throws 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 interface AsyncDataConsumer

Parameters:

capacityChannel - the channel for capacity updates.

Throws:

IOException - in case of an I/O error.

consume

public final void consume(ByteBuffer src)
                   throws 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 interface AsyncDataConsumer

Parameters:

src - data source.

Throws:

IOException - in case of an I/O error.

streamEnd

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

Description copied from interface: AsyncDataConsumer

Triggered to signal termination of the data stream.

Specified by:

streamEnd in interface AsyncDataConsumer

Parameters:

trailers - data stream trailers.

Throws:

HttpException - in case of an HTTP protocol violation.

IOException - in case of an I/O error.

failed

public final void failed(Exception cause)

Description copied from interface: AsyncResponseConsumer

Triggered to signal a failure in data processing.

Specified by:

failed in interface AsyncResponseConsumer<Void>

Parameters:

cause - the cause of the failure.

releaseResources

public void releaseResources()

Specified by:

releaseResources in interface ResourceHolder