HttpAsyncRequestExecutor and HttpAsyncRequester@Deprecated @Contract(threading=IMMUTABLE_CONDITIONAL) public class AsyncNHttpClientHandler extends NHttpHandlerBase implements NHttpClientHandler
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,
NHttpRequestExecutionHandler.handleResponse(HttpResponse, HttpContext)
method is called to process the response.
The following parameters can be used to customize the behavior of this class:
| Modifier and Type | Class and Description |
|---|---|
protected static class |
AsyncNHttpClientHandler.ClientConnState
Deprecated.
|
| Modifier and Type | Field and Description |
|---|---|
protected NHttpRequestExecutionHandler |
execHandler
Deprecated.
|
allocator, CONN_STATE, connStrategy, eventListener, httpProcessor, params| Constructor and Description |
|---|
AsyncNHttpClientHandler(HttpProcessor httpProcessor,
NHttpRequestExecutionHandler execHandler,
ConnectionReuseStrategy connStrategy,
ByteBufferAllocator allocator,
HttpParams params)
Deprecated.
|
AsyncNHttpClientHandler(HttpProcessor httpProcessor,
NHttpRequestExecutionHandler execHandler,
ConnectionReuseStrategy connStrategy,
HttpParams params)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
void |
closed(NHttpClientConnection conn)
Deprecated.
Triggered when the connection is closed.
|
void |
connected(NHttpClientConnection conn,
Object attachment)
Deprecated.
Triggered when a new outgoing connection is created.
|
void |
exception(NHttpClientConnection conn,
HttpException ex)
Deprecated.
Triggered when an HTTP protocol violation occurs while receiving
an HTTP response.
|
void |
exception(NHttpClientConnection conn,
IOException ex)
Deprecated.
Triggered when an I/O error occurs while reading from or writing
to the underlying channel.
|
void |
inputReady(NHttpClientConnection conn,
ContentDecoder decoder)
Deprecated.
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)
Deprecated.
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)
Deprecated.
Triggered when the connection is ready to accept a new HTTP request.
|
void |
responseReceived(NHttpClientConnection conn)
Deprecated.
Triggered when an HTTP response is received.
|
void |
timeout(NHttpClientConnection conn)
Deprecated.
Triggered when no input is detected on this connection over the
maximum period of inactivity.
|
canResponseHaveBody, closeConnection, getParams, handleTimeout, setEventListener, shutdownConnectionprotected NHttpRequestExecutionHandler execHandler
public AsyncNHttpClientHandler(HttpProcessor httpProcessor, NHttpRequestExecutionHandler execHandler, ConnectionReuseStrategy connStrategy, ByteBufferAllocator allocator, HttpParams params)
public AsyncNHttpClientHandler(HttpProcessor httpProcessor, NHttpRequestExecutionHandler execHandler, ConnectionReuseStrategy connStrategy, HttpParams params)
public void connected(NHttpClientConnection conn, Object attachment)
NHttpClientHandlerconnected in interface NHttpClientHandlerconn - new outgoing HTTP connection.attachment - an object that was attached to the session requestpublic void closed(NHttpClientConnection conn)
NHttpClientHandlerclosed in interface NHttpClientHandlerconn - closed HTTP connection.public void exception(NHttpClientConnection conn, HttpException ex)
NHttpClientHandlerexception in interface NHttpClientHandlerconn - HTTP connection that caused an HTTP protocol violationex - HTTP protocol violation exceptionpublic void exception(NHttpClientConnection conn, IOException ex)
NHttpClientHandlerexception in interface NHttpClientHandlerconn - HTTP connection that caused an I/O errorex - I/O exceptionpublic void requestReady(NHttpClientConnection conn)
NHttpClientHandlerrequestReady in interface NHttpClientHandlerconn - HTTP connection that is ready to accept a new HTTP request.NHttpClientConnectionpublic void inputReady(NHttpClientConnection conn, ContentDecoder decoder)
NHttpClientHandler
If the content consumer is unable to process the incoming content,
input event notifications can be temporarily suspended using
IOControl interface.
inputReady in interface NHttpClientHandlerconn - HTTP connection that can produce a new portion of the
incoming response content.decoder - The content decoder to use to read content.NHttpClientConnection,
ContentDecoder,
IOControlpublic void outputReady(NHttpClientConnection conn, ContentEncoder encoder)
NHttpClientHandler
If the content producer is unable to generate the outgoing content,
output event notifications can be temporarily suspended using
IOControl interface.
outputReady in interface NHttpClientHandlerconn - HTTP connection that can accommodate a new portion
of the outgoing request content.encoder - The content encoder to use to write content.NHttpClientConnection,
ContentEncoder,
IOControlpublic void responseReceived(NHttpClientConnection conn)
NHttpClientHandler
If the response received encloses a response entity this method will
be followed by a series of
NHttpClientHandler.inputReady(NHttpClientConnection, ContentDecoder) calls
to transfer the response content.
responseReceived in interface NHttpClientHandlerconn - HTTP connection that contains an HTTP responseNHttpClientConnectionpublic void timeout(NHttpClientConnection conn)
NHttpClientHandlertimeout in interface NHttpClientHandlerconn - HTTP connection that caused timeout condition.Copyright © 2005–2022 The Apache Software Foundation. All rights reserved.