|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.http.nio.protocol.NHttpHandlerBase
org.apache.http.nio.protocol.ThrottlingHttpClientHandler
HttpAsyncRequestExecutor and HttpAsyncRequester
@Deprecated @ThreadSafe public class ThrottlingHttpClientHandler
Client protocol handler implementation that provide compatibility with
the blocking I/O by utilizing shared content buffers and a fairly small pool
of worker threads. The throttling protocol handler allocates input / output
buffers of a constant length upon initialization and controls the rate of
I/O events in order to ensure those content buffers do not ever get
overflown. This helps ensure nearly constant memory footprint for HTTP
connections and avoid the out of memory condition while streaming content
in and out. The HttpRequestExecutionHandler.handleResponse(HttpResponse, HttpContext)
method will fire immediately when a message is received. The protocol handler
delegate the task of processing requests and generating response content to
an Executor, which is expected to perform those tasks using
dedicated worker threads in order to avoid blocking the I/O thread.
The following parameters can be used to customize the behavior of this class:
| Field Summary | |
|---|---|
protected HttpRequestExecutionHandler |
execHandler
Deprecated. |
protected Executor |
executor
Deprecated. |
| Fields inherited from class org.apache.http.nio.protocol.NHttpHandlerBase |
|---|
allocator, CONN_STATE, connStrategy, eventListener, httpProcessor, params |
| Constructor Summary | |
|---|---|
ThrottlingHttpClientHandler(HttpProcessor httpProcessor,
HttpRequestExecutionHandler execHandler,
ConnectionReuseStrategy connStrategy,
ByteBufferAllocator allocator,
Executor executor,
HttpParams params)
Deprecated. |
|
ThrottlingHttpClientHandler(HttpProcessor httpProcessor,
HttpRequestExecutionHandler execHandler,
ConnectionReuseStrategy connStrategy,
Executor executor,
HttpParams params)
Deprecated. |
|
| Method Summary | |
|---|---|
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. |
| Methods inherited from class org.apache.http.nio.protocol.NHttpHandlerBase |
|---|
canResponseHaveBody, closeConnection, getParams, handleTimeout, setEventListener, shutdownConnection |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected HttpRequestExecutionHandler execHandler
protected final Executor executor
| Constructor Detail |
|---|
public ThrottlingHttpClientHandler(HttpProcessor httpProcessor,
HttpRequestExecutionHandler execHandler,
ConnectionReuseStrategy connStrategy,
ByteBufferAllocator allocator,
Executor executor,
HttpParams params)
public ThrottlingHttpClientHandler(HttpProcessor httpProcessor,
HttpRequestExecutionHandler execHandler,
ConnectionReuseStrategy connStrategy,
Executor executor,
HttpParams params)
| Method Detail |
|---|
public void connected(NHttpClientConnection conn,
Object attachment)
NHttpClientHandler
connected in interface NHttpClientHandlerconn - new outgoing HTTP connection.attachment - an object that was attached to the session requestpublic void closed(NHttpClientConnection conn)
NHttpClientHandler
closed in interface NHttpClientHandlerconn - closed HTTP connection.
public void exception(NHttpClientConnection conn,
HttpException ex)
NHttpClientHandler
exception in interface NHttpClientHandlerconn - HTTP connection that caused an HTTP protocol violationex - HTTP protocol violation exception
public void exception(NHttpClientConnection conn,
IOException ex)
NHttpClientHandler
exception in interface NHttpClientHandlerconn - HTTP connection that caused an I/O errorex - I/O exceptionpublic void requestReady(NHttpClientConnection conn)
NHttpClientHandler
requestReady in interface NHttpClientHandlerconn - HTTP connection that is ready to accept a new HTTP request.NHttpClientConnection
public 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)
NHttpClientHandlerNHttpClientHandler.inputReady(NHttpClientConnection, ContentDecoder) calls
to transfer the response content.
responseReceived in interface NHttpClientHandlerconn - HTTP connection that contains an HTTP responseNHttpClientConnection
public void inputReady(NHttpClientConnection conn,
ContentDecoder decoder)
NHttpClientHandlerIOControl 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 timeout(NHttpClientConnection conn)
NHttpClientHandler
timeout in interface NHttpClientHandlerconn - HTTP connection that caused timeout condition.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||