public class

AsyncNHttpClientHandler

extends NHttpHandlerBase
implements NHttpClientHandler
java.lang.Object
   ↳ org.apache.http.nio.protocol.NHttpHandlerBase
     ↳ org.apache.http.nio.protocol.AsyncNHttpClientHandler

Class Overview

Fully asynchronous HTTP client side protocol handler that implements the essential requirements of the HTTP protocol for the server side message processing as described by RFC 2616. It is capable of executing HTTP requests with nearly constant memory footprint. Only HTTP message heads are stored in memory, while content of message bodies is streamed directly from the entity to the underlying channel (and vice versa) using ConsumingNHttpEntity and ProducingNHttpEntity interfaces. When using this implementation, it is important to ensure that entities supplied for writing implement ProducingNHttpEntity. Doing so will allow the entity to be written out asynchronously. If entities supplied for writing do not implement the ProducingNHttpEntity interface, a delegate is added that buffers the entire contents in memory. Additionally, the buffering might take place in the I/O dispatch thread, which could cause I/O to block temporarily. For best results, one must ensure that all entities set on HttpRequests from NHttpRequestExecutionHandler implement ProducingNHttpEntity. If incoming responses enclose a content entity, NHttpRequestExecutionHandler are expected to return a ConsumingNHttpEntity for reading the content. After the entity is finished reading the data, handleResponse(HttpResponse, HttpContext) method is called to process the response.

The following parameters can be used to customize the behavior of this class:

See Also

Summary

Nested Classes
class AsyncNHttpClientHandler.ClientConnState  
[Expand]
Inherited Constants
From class org.apache.http.nio.protocol.NHttpHandlerBase
Fields
protected NHttpRequestExecutionHandler execHandler
[Expand]
Inherited Fields
From class org.apache.http.nio.protocol.NHttpHandlerBase
Public Constructors
AsyncNHttpClientHandler(HttpProcessor httpProcessor, NHttpRequestExecutionHandler execHandler, ConnectionReuseStrategy connStrategy, ByteBufferAllocator allocator, HttpParams params)
AsyncNHttpClientHandler(HttpProcessor httpProcessor, NHttpRequestExecutionHandler execHandler, ConnectionReuseStrategy connStrategy, HttpParams params)
Public Methods
void closed(NHttpClientConnection conn)
Triggered when the connection is closed.
void connected(NHttpClientConnection conn, Object attachment)
Triggered when a new outgoing connection is created.
void exception(NHttpClientConnection conn, HttpException ex)
Triggered when an HTTP protocol violation occurs while receiving an HTTP response.
void exception(NHttpClientConnection conn, IOException ex)
Triggered when an I/O error occurs while reading from or writing to the underlying channel.
void inputReady(NHttpClientConnection conn, ContentDecoder decoder)
Triggered when the underlying channel is ready for reading a new portion of the response entity through the corresponding content decoder.
void outputReady(NHttpClientConnection conn, ContentEncoder encoder)
Triggered when the underlying channel is ready for writing a next portion of the request entity through the corresponding content encoder.
void requestReady(NHttpClientConnection conn)
Triggered when the connection is ready to accept a new HTTP request.
void responseReceived(NHttpClientConnection conn)
Triggered when an HTTP response is received.
void timeout(NHttpClientConnection conn)
Triggered when no input is detected on this connection over the maximum period of inactivity.
[Expand]
Inherited Methods
From class org.apache.http.nio.protocol.NHttpHandlerBase
From class java.lang.Object
From interface org.apache.http.nio.NHttpClientHandler

Fields

protected NHttpRequestExecutionHandler execHandler

Public Constructors

public AsyncNHttpClientHandler (HttpProcessor httpProcessor, NHttpRequestExecutionHandler execHandler, ConnectionReuseStrategy connStrategy, ByteBufferAllocator allocator, HttpParams params)

public AsyncNHttpClientHandler (HttpProcessor httpProcessor, NHttpRequestExecutionHandler execHandler, ConnectionReuseStrategy connStrategy, HttpParams params)

Public Methods

public void closed (NHttpClientConnection conn)

Triggered when the connection is closed.

Parameters
conn closed HTTP connection.

public void connected (NHttpClientConnection conn, Object attachment)

Triggered when a new outgoing connection is created.

Parameters
conn new outgoing HTTP connection.
attachment an object that was attached to the session request

public void exception (NHttpClientConnection conn, HttpException ex)

Triggered when an HTTP protocol violation occurs while receiving an HTTP response.

Parameters
conn HTTP connection that caused an HTTP protocol violation
ex HTTP protocol violation exception

public void exception (NHttpClientConnection conn, IOException ex)

Triggered when an I/O error occurs while reading from or writing to the underlying channel.

Parameters
conn HTTP connection that caused an I/O error
ex I/O exception

public void inputReady (NHttpClientConnection conn, ContentDecoder decoder)

Triggered when the underlying channel is ready for reading a new portion of the response entity through the corresponding content decoder.

If the content consumer is unable to process the incoming content, input event notifications can be temporarily suspended using IOControl interface.

Parameters
conn HTTP connection that can produce a new portion of the incoming response content.
decoder The content decoder to use to read content.

public void outputReady (NHttpClientConnection conn, ContentEncoder encoder)

Triggered when the underlying channel is ready for writing a next portion of the request entity through the corresponding content encoder.

If the content producer is unable to generate the outgoing content, output event notifications can be temporarily suspended using IOControl interface.

Parameters
conn HTTP connection that can accommodate a new portion of the outgoing request content.
encoder The content encoder to use to write content.

public void requestReady (NHttpClientConnection conn)

Triggered when the connection is ready to accept a new HTTP request. The protocol handler does not have to submit a request if it is not ready.

Parameters
conn HTTP connection that is ready to accept a new HTTP request.

public void responseReceived (NHttpClientConnection conn)

Triggered when an HTTP response is received. The connection passed as a parameter to this method is guaranteed to return a valid HTTP response object.

If the response received encloses a response entity this method will be followed by a series of inputReady(NHttpClientConnection, ContentDecoder) calls to transfer the response content.

Parameters
conn HTTP connection that contains an HTTP response

public void timeout (NHttpClientConnection conn)

Triggered when no input is detected on this connection over the maximum period of inactivity.

Parameters
conn HTTP connection that caused timeout condition.