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

类 AbstractServerExchangeHandler<T>

java.lang.Object

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

所有已实现的接口:

AsyncDataConsumer, AsyncDataExchangeHandler, AsyncDataProducer, AsyncServerExchangeHandler, ResourceHolder

直接已知子类:

BasicServerExchangeHandler

public abstract class AbstractServerExchangeHandler<T>
extends Object
implements AsyncServerExchangeHandler

Abstract server side message exchange handler.

从以下版本开始:

5.0

构造器概要

构造器

构造器和说明
AbstractServerExchangeHandler()

方法概要

限定符和类型	方法和说明
int	available() Returns the number of bytes immediately available for output.
void	consume(ByteBuffer src) Triggered to pass incoming data to the data consumer.
void	failed(Exception cause) Triggered to signal a failure in data processing.
protected abstract void	handle(T requestMessage, AsyncServerRequestHandler.ResponseTrigger responseTrigger, HttpContext context) Triggered to handles the request object produced by the AsyncRequestConsumer returned from the supplyConsumer(HttpRequest, EntityDetails, HttpContext) method.
void	handleRequest(HttpRequest request, EntityDetails entityDetails, ResponseChannel responseChannel, HttpContext context) Processes the actual HTTP request.
void	produce(DataStreamChannel channel) Triggered to signal the ability of the underlying data channel to accept more data.
void	releaseResources()
void	streamEnd(List<? extends Header> trailers) Triggered to signal termination of the data stream.
protected abstract AsyncRequestConsumer<T>	supplyConsumer(HttpRequest request, EntityDetails entityDetails, HttpContext context) Triggered to supply a request consumer to process the incoming request.
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

构造器详细资料

AbstractServerExchangeHandler

public AbstractServerExchangeHandler()

方法详细资料

supplyConsumer

protected abstract AsyncRequestConsumer<T> supplyConsumer(HttpRequest request,
                                                          EntityDetails entityDetails,
                                                          HttpContext context)
                                                   throws HttpException

Triggered to supply a request consumer to process the incoming request.

参数:

request - the request message.

entityDetails - the request entity details.

context - the actual execution context.

返回:

the request consumer.

抛出:

HttpException

handle

protected abstract void handle(T requestMessage,
                               AsyncServerRequestHandler.ResponseTrigger responseTrigger,
                               HttpContext context)
                        throws HttpException,
                               IOException

Triggered to handles the request object produced by the AsyncRequestConsumer returned from the supplyConsumer(HttpRequest, EntityDetails, HttpContext) method. The handler can choose to send response messages immediately inside the call or asynchronously at some later point.

参数:

requestMessage - the request message.

responseTrigger - the response trigger.

context - the actual execution context.

抛出:

HttpException

IOException

handleRequest

public final void handleRequest(HttpRequest request,
                                EntityDetails entityDetails,
                                ResponseChannel responseChannel,
                                HttpContext context)
                         throws HttpException,
                                IOException

从接口复制的说明: AsyncServerExchangeHandler

Processes the actual HTTP request. The handler can choose to send response messages immediately inside the call or asynchronously at some later point.

指定者:

handleRequest 在接口中 AsyncServerExchangeHandler

参数:

request - the actual request.

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

responseChannel - the response channel.

context - the actual execution context.

抛出:

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

available

public final int available()

从接口复制的说明: AsyncDataProducer

Returns the number of bytes immediately available for output. This method can be used as a hint to control output events of the underlying I/O session.

指定者:

available 在接口中 AsyncDataProducer

返回:

the number of bytes immediately available for output

produce

public final void produce(DataStreamChannel channel)
                   throws IOException

从接口复制的说明: AsyncDataProducer

Triggered to signal the ability of the underlying data channel to accept more data. The data producer can choose to write data immediately inside the call or asynchronously at some later point.

指定者:

produce 在接口中 AsyncDataProducer

参数:

channel - the data channel capable to accepting more data.

抛出:

IOException

failed

public final void failed(Exception cause)

从接口复制的说明: AsyncDataExchangeHandler

Triggered to signal a failure in data processing.

指定者:

failed 在接口中 AsyncDataExchangeHandler

参数:

cause - the cause of the failure.

releaseResources

public final void releaseResources()

指定者:

releaseResources 在接口中 ResourceHolder