org.apache.hc.core5.reactive

Class ReactiveResponseConsumer

java.lang.Object

org.apache.hc.core5.reactive.ReactiveResponseConsumer

All Implemented Interfaces:

AsyncDataConsumer, AsyncResponseConsumer<Void>, ResourceHolder

@Contract(threading=SAFE)
public final class ReactiveResponseConsumer
extends Object
implements AsyncResponseConsumer<Void>

An AsyncResponseConsumer that publishes the response body through a Publisher, as defined by the Reactive Streams specification. The response is represented as a Message consisting of a HttpResponse representing the headers and a Publisher representing the response body as an asynchronous stream of ByteBuffer instances.

Since:

5.0

Constructor Summary

Constructors

Constructor and Description
ReactiveResponseConsumer() Creates a ReactiveResponseConsumer.
ReactiveResponseConsumer(FutureCallback<Message<HttpResponse,org.reactivestreams.Publisher<ByteBuffer>>> responseCallback) Creates a ReactiveResponseConsumer that will call back the supplied FutureCallback with a streamable response.

Method Summary

Modifier and Type	Method and Description
void	consume(ByteBuffer src)
void	consumeResponse(HttpResponse response, EntityDetails entityDetails, HttpContext httpContext, FutureCallback<Void> resultCallback)
void	failed(Exception cause)
EntityDetails	getEntityDetails() Returns the response entity details.
HttpResponse	getInformationResponse() Returns the intermediate (1xx) HTTP response if one was received.
Future<Message<HttpResponse,org.reactivestreams.Publisher<ByteBuffer>>>	getResponseFuture()
List<Header>	getTrailers() Returns the trailers received at the end of the response.
void	informationResponse(HttpResponse response, HttpContext httpContext)
void	releaseResources()
void	streamEnd(List<? extends Header> trailers)
void	updateCapacity(CapacityChannel capacityChannel)

Methods inherited from class java.lang.Object

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

Constructor Detail

ReactiveResponseConsumer

public ReactiveResponseConsumer()

Creates a ReactiveResponseConsumer.

ReactiveResponseConsumer

public ReactiveResponseConsumer(FutureCallback<Message<HttpResponse,org.reactivestreams.Publisher<ByteBuffer>>> responseCallback)

Creates a ReactiveResponseConsumer that will call back the supplied FutureCallback with a streamable response.

Parameters:

responseCallback - the callback to invoke when the response is available for consumption.

Method Detail

getResponseFuture

public Future<Message<HttpResponse,org.reactivestreams.Publisher<ByteBuffer>>> getResponseFuture()

getInformationResponse

public HttpResponse getInformationResponse()

Returns the intermediate (1xx) HTTP response if one was received.

Returns:

the information response, or null if none.

getEntityDetails

public EntityDetails getEntityDetails()

Returns the response entity details.

Returns:

the entity details, or null if none.

getTrailers

public List<Header> getTrailers()

Returns the trailers received at the end of the response.

Returns:

a non-null list of zero or more trailers.

consumeResponse

public void consumeResponse(HttpResponse response,
                            EntityDetails entityDetails,
                            HttpContext httpContext,
                            FutureCallback<Void> resultCallback)

Specified by:

consumeResponse in interface AsyncResponseConsumer<Void>

informationResponse

public void informationResponse(HttpResponse response,
                                HttpContext httpContext)

Specified by:

informationResponse in interface AsyncResponseConsumer<Void>

failed

public void failed(Exception cause)

Specified by:

failed in interface AsyncResponseConsumer<Void>

updateCapacity

public void updateCapacity(CapacityChannel capacityChannel)
                    throws IOException

Specified by:

updateCapacity in interface AsyncDataConsumer

Throws:

IOException

consume

public void consume(ByteBuffer src)
             throws IOException

Specified by:

consume in interface AsyncDataConsumer

Throws:

IOException

streamEnd

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

Specified by:

streamEnd in interface AsyncDataConsumer

releaseResources

public void releaseResources()

Specified by:

releaseResources in interface ResourceHolder