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

类 AbstractAsyncRequesterConsumer<T,E>

java.lang.Object

org.apache.hc.core5.http.nio.support.AbstractAsyncRequesterConsumer<T,E>

类型参数:

T - request processing result representation.

E - request entity representation.

所有已实现的接口:

AsyncDataConsumer, AsyncRequestConsumer<T>, ResourceHolder

public abstract class AbstractAsyncRequesterConsumer<T,E>
extends Object
implements AsyncRequestConsumer<T>

Abstract asynchronous request consumer that makes use of AsyncEntityConsumer to process request message content.

从以下版本开始:

5.0

构造器概要

构造器

构造器和说明
AbstractAsyncRequesterConsumer(AsyncEntityConsumer<E> dataConsumer)
AbstractAsyncRequesterConsumer(Supplier<AsyncEntityConsumer<E>> dataConsumerSupplier)

方法概要

限定符和类型	方法和说明
protected abstract T	buildResult(HttpRequest request, E entity, ContentType contentType) Triggered to generate object that represents a result of request message processing.
void	consume(ByteBuffer src) Triggered to pass incoming data to the data consumer.
void	consumeRequest(HttpRequest request, EntityDetails entityDetails, HttpContext httpContext, FutureCallback<T> resultCallback) Triggered to signal receipt of a request message head.
void	failed(Exception cause) Triggered to signal a failure in data processing.
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

构造器详细资料

AbstractAsyncRequesterConsumer

public AbstractAsyncRequesterConsumer(Supplier<AsyncEntityConsumer<E>> dataConsumerSupplier)

AbstractAsyncRequesterConsumer

public AbstractAsyncRequesterConsumer(AsyncEntityConsumer<E> dataConsumer)

方法详细资料

buildResult

protected abstract T buildResult(HttpRequest request,
                                 E entity,
                                 ContentType contentType)

Triggered to generate object that represents a result of request message processing.

参数:

request - the request message.

entity - the request entity.

contentType - the request content type.

返回:

the result of request processing.

consumeRequest

public final void consumeRequest(HttpRequest request,
                                 EntityDetails entityDetails,
                                 HttpContext httpContext,
                                 FutureCallback<T> resultCallback)
                          throws HttpException,
                                 IOException

从接口复制的说明: AsyncRequestConsumer

Triggered to signal receipt of a request message head.

指定者:

consumeRequest 在接口中 AsyncRequestConsumer<T>

参数:

request - the request message head.

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

httpContext - the actual execution context.

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

抛出:

HttpException

IOException

updateCapacity

public final 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 final 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 final 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 final void failed(Exception cause)

从接口复制的说明: AsyncRequestConsumer

Triggered to signal a failure in data processing.

指定者:

failed 在接口中 AsyncRequestConsumer<T>

参数:

cause - the cause of the failure.

releaseResources

public final void releaseResources()

指定者:

releaseResources 在接口中 ResourceHolder