depends.org.apache.http.nio.protocol

类 BasicAsyncClientExchangeHandler<T>

java.lang.Object

depends.org.apache.http.nio.protocol.BasicAsyncClientExchangeHandler<T>

类型参数:

T - the result category of request execution.

所有已实现的接口:

Cancellable, HttpAsyncClientExchangeHandler, java.io.Closeable, java.lang.AutoCloseable

public class BasicAsyncClientExchangeHandler<T>
extends java.lang.Object
implements HttpAsyncClientExchangeHandler

Basic implementation of HttpAsyncClientExchangeHandler that executes a single HTTP request / response exchange.

从以下版本开始:

4.3

构造器概要

构造器

构造器和说明
BasicAsyncClientExchangeHandler(HttpAsyncRequestProducer requestProducer, HttpAsyncResponseConsumer<T> responseConsumer, FutureCallback<T> callback, HttpContext localContext, NHttpClientConnection conn, HttpProcessor httppocessor, ConnectionReuseStrategy connReuseStrategy) Creates new instance of BasicAsyncRequestExecutionHandler.
BasicAsyncClientExchangeHandler(HttpAsyncRequestProducer requestProducer, HttpAsyncResponseConsumer<T> responseConsumer, HttpContext localContext, NHttpClientConnection conn, HttpProcessor httppocessor) Creates new instance of BasicAsyncRequestExecutionHandler.

方法概要

方法

限定符和类型	方法和说明
boolean	cancel()
void	close()
void	consumeContent(ContentDecoder decoder, IOControl ioctrl) Invoked to process a chunk of content from the ContentDecoder.
void	failed(java.lang.Exception ex) Invoked to signal that the response processing terminated abnormally.
HttpRequest	generateRequest() Invoked to generate a HTTP request message head.
java.util.concurrent.Future<T>	getFuture()
void	inputTerminated() Invoked to signal that the connection has been terminated prematurely by the opposite end.
boolean	isDone() Determines whether or not the response processing completed.
void	produceContent(ContentEncoder encoder, IOControl ioctrl) Invoked to write out a chunk of content to the ContentEncoder.
void	requestCompleted() Invoked to signal that the request has been fully written out.
void	responseCompleted() Invoked to signal that the response has been fully processed.
void	responseReceived(HttpResponse response) Invoked when a HTTP response message is received.

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

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

构造器详细资料

BasicAsyncClientExchangeHandler

public BasicAsyncClientExchangeHandler(HttpAsyncRequestProducer requestProducer,
                               HttpAsyncResponseConsumer<T> responseConsumer,
                               FutureCallback<T> callback,
                               HttpContext localContext,
                               NHttpClientConnection conn,
                               HttpProcessor httppocessor,
                               ConnectionReuseStrategy connReuseStrategy)

Creates new instance of BasicAsyncRequestExecutionHandler.

参数:

requestProducer - the request producer.

responseConsumer - the response consumer.

callback - the future callback invoked when the operation is completed.

localContext - the local execution context.

conn - the actual connection.

httppocessor - the HTTP protocol processor.

connReuseStrategy - the connection re-use strategy.

BasicAsyncClientExchangeHandler

public BasicAsyncClientExchangeHandler(HttpAsyncRequestProducer requestProducer,
                               HttpAsyncResponseConsumer<T> responseConsumer,
                               HttpContext localContext,
                               NHttpClientConnection conn,
                               HttpProcessor httppocessor)

Creates new instance of BasicAsyncRequestExecutionHandler.

参数:

requestProducer - the request producer.

responseConsumer - the response consumer.

localContext - the local execution context.

conn - the actual connection.

httppocessor - the HTTP protocol processor.

方法详细资料

getFuture

public java.util.concurrent.Future<T> getFuture()

close

public void close()
           throws java.io.IOException

指定者:

close 在接口中 java.io.Closeable

指定者:

close 在接口中 java.lang.AutoCloseable

抛出:

java.io.IOException

generateRequest

public HttpRequest generateRequest()
                            throws java.io.IOException,
                                   HttpException

从接口复制的说明: HttpAsyncClientExchangeHandler

Invoked to generate a HTTP request message head. The message is expected to implement the HttpEntityEnclosingRequest interface if it is to enclose a content entity. The HttpAsyncClientExchangeHandler.produceContent(ContentEncoder, IOControl) method will not be invoked if HttpEntityEnclosingRequest.getEntity() returns null.

指定者:

generateRequest 在接口中 HttpAsyncClientExchangeHandler

返回:

HTTP request message.

抛出:

java.io.IOException - in case of an I/O error

HttpException - in case of HTTP protocol violation

produceContent

public void produceContent(ContentEncoder encoder,
                  IOControl ioctrl)
                    throws java.io.IOException

从接口复制的说明: HttpAsyncClientExchangeHandler

Invoked to write out a chunk of content to the ContentEncoder. The IOControl interface can be used to suspend output event notifications if the producer is temporarily unable to produce more content.

When all content is finished, the producer MUST call ContentEncoder.complete(). Failure to do so may cause the entity to be incorrectly delimited.

Please note that the ContentEncoder object is not thread-safe and should only be used within the context of this method call. The IOControl object can be shared and used on extension thread to resume output event notifications when more content is made available.

指定者:

produceContent 在接口中 HttpAsyncClientExchangeHandler

参数:

encoder - content encoder.

ioctrl - I/O control of the underlying connection.

抛出:

java.io.IOException - in case of an I/O error

requestCompleted

public void requestCompleted()

从接口复制的说明: HttpAsyncClientExchangeHandler

Invoked to signal that the request has been fully written out.

指定者:

requestCompleted 在接口中 HttpAsyncClientExchangeHandler

responseReceived

public void responseReceived(HttpResponse response)
                      throws java.io.IOException,
                             HttpException

从接口复制的说明: HttpAsyncClientExchangeHandler

Invoked when a HTTP response message is received. Please note that the HttpAsyncClientExchangeHandler.consumeContent(ContentDecoder, IOControl) method will be invoked only if the response messages has a content entity enclosed.

指定者:

responseReceived 在接口中 HttpAsyncClientExchangeHandler

参数:

response - HTTP response message.

抛出:

java.io.IOException - in case of an I/O error

HttpException - in case of HTTP protocol violation

consumeContent

public void consumeContent(ContentDecoder decoder,
                  IOControl ioctrl)
                    throws java.io.IOException

从接口复制的说明: HttpAsyncClientExchangeHandler

Invoked to process a chunk of content from the ContentDecoder. The IOControl interface can be used to suspend input event notifications if the consumer is temporarily unable to process content.

The consumer can use the ContentDecoder.isCompleted() method to find out whether or not the message content has been fully consumed.

Please note that the ContentDecoder object is not thread-safe and should only be used within the context of this method call. The IOControl object can be shared and used on extension thread to resume input event notifications when the consumer is capable of processing more content.

指定者:

consumeContent 在接口中 HttpAsyncClientExchangeHandler

参数:

decoder - content decoder.

ioctrl - I/O control of the underlying connection.

抛出:

java.io.IOException - in case of an I/O error

responseCompleted

public void responseCompleted()
                       throws java.io.IOException

从接口复制的说明: HttpAsyncClientExchangeHandler

Invoked to signal that the response has been fully processed.

指定者:

responseCompleted 在接口中 HttpAsyncClientExchangeHandler

抛出:

java.io.IOException

inputTerminated

public void inputTerminated()

从接口复制的说明: HttpAsyncClientExchangeHandler

Invoked to signal that the connection has been terminated prematurely by the opposite end.

指定者:

inputTerminated 在接口中 HttpAsyncClientExchangeHandler

failed

public void failed(java.lang.Exception ex)

从接口复制的说明: HttpAsyncClientExchangeHandler

Invoked to signal that the response processing terminated abnormally.

指定者:

failed 在接口中 HttpAsyncClientExchangeHandler

参数:

ex - exception

cancel

public boolean cancel()

指定者:

cancel 在接口中 Cancellable

isDone

public boolean isDone()

从接口复制的说明: HttpAsyncClientExchangeHandler

Determines whether or not the response processing completed.

指定者:

isDone 在接口中 HttpAsyncClientExchangeHandler