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

类 BasicResponseConsumer<T>

java.lang.Object

org.apache.hc.core5.http.nio.support.BasicResponseConsumer<T>

所有已实现的接口:

AsyncDataConsumer, AsyncResponseConsumer<Message<HttpResponse,T>>, ResourceHolder

public class BasicResponseConsumer<T>
extends Object
implements AsyncResponseConsumer<Message<HttpResponse,T>>

Basic implementation of AsyncResponseConsumer that represents response message as a Message and relies on a AsyncEntityConsumer to process response entity stream.

从以下版本开始:

5.0

构造器概要

构造器

构造器和说明
BasicResponseConsumer(AsyncEntityConsumer<T> dataConsumer)
BasicResponseConsumer(Supplier<AsyncEntityConsumer<T>> dataConsumerSupplier)

方法概要

限定符和类型	方法和说明
void	consume(ByteBuffer src) Triggered to pass incoming data to the data consumer.
void	consumeResponse(HttpResponse response, EntityDetails entityDetails, HttpContext httpContext, FutureCallback<Message<HttpResponse,T>> resultCallback) Triggered to signal receipt of a response message head.
void	failed(Exception cause) Triggered to signal a failure in data processing.
void	informationResponse(HttpResponse response, HttpContext httpContext) Triggered to signal receipt of an intermediate (1xx) HTTP response.
void	releaseResources()
void	streamEnd(List<? extends Header> trailers) Triggered to signal termination of the data stream.
void	updateCapacity(CapacityChannel capacityChannel) Triggered to signal ability of the underlying data stream to receive data capacity update.

从类继承的方法 java.lang.Object

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

构造器详细资料

BasicResponseConsumer

public BasicResponseConsumer(Supplier<AsyncEntityConsumer<T>> dataConsumerSupplier)

BasicResponseConsumer

public BasicResponseConsumer(AsyncEntityConsumer<T> dataConsumer)

方法详细资料

consumeResponse

public void consumeResponse(HttpResponse response,
                            EntityDetails entityDetails,
                            HttpContext httpContext,
                            FutureCallback<Message<HttpResponse,T>> resultCallback)
                     throws HttpException,
                            IOException

从接口复制的说明: AsyncResponseConsumer

Triggered to signal receipt of a response message head.

指定者:

consumeResponse 在接口中 AsyncResponseConsumer<Message<HttpResponse,T>>

参数:

response - the response message head.

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

httpContext - the actual execution context.

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

抛出:

HttpException

IOException

informationResponse

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

从接口复制的说明: AsyncResponseConsumer

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

指定者:

informationResponse 在接口中 AsyncResponseConsumer<Message<HttpResponse,T>>

参数:

response - the intermediate (1xx) HTTP response.

httpContext - the actual execution context.

抛出:

HttpException

IOException

updateCapacity

public void updateCapacity(CapacityChannel capacityChannel)
                    throws IOException

从接口复制的说明: 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.

指定者:

updateCapacity 在接口中 AsyncDataConsumer

参数:

capacityChannel - the channel for capacity updates.

抛出:

IOException

consume

public void consume(ByteBuffer src)
             throws IOException

从接口复制的说明: 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.

指定者:

consume 在接口中 AsyncDataConsumer

参数:

src - data source.

抛出:

IOException

streamEnd

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

从接口复制的说明: AsyncDataConsumer

Triggered to signal termination of the data stream.

指定者:

streamEnd 在接口中 AsyncDataConsumer

参数:

trailers - data stream trailers.

抛出:

HttpException

IOException

failed

public void failed(Exception cause)

从接口复制的说明: AsyncResponseConsumer

Triggered to signal a failure in data processing.

指定者:

failed 在接口中 AsyncResponseConsumer<Message<HttpResponse,T>>

参数:

cause - the cause of the failure.

releaseResources

public void releaseResources()

指定者:

releaseResources 在接口中 ResourceHolder