|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.http.nio.protocol.NHttpHandlerBase org.apache.http.nio.protocol.ThrottlingHttpServiceHandler
HttpAsyncService
@Deprecated @Contract(threading=SAFE_CONDITIONAL) public class ThrottlingHttpServiceHandler
Service 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 HttpRequestHandler.handle(HttpRequest, 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.
Usually throttling protocol handlers need only a modest number of worker threads, much fewer than the number of concurrent connections. If the length of the message is smaller or about the size of the shared content buffer worker thread will just store content in the buffer and terminate almost immediately without blocking. The I/O dispatch thread in its turn will take care of sending out the buffered content asynchronously. The worker thread will have to block only when processing large messages and the shared buffer fills up. It is generally advisable to allocate shared buffers of a size of an average content body for optimal performance.
The following parameters can be used to customize the behavior of this class:
Field Summary | |
---|---|
protected Executor |
executor
Deprecated. |
protected HttpExpectationVerifier |
expectationVerifier
Deprecated. |
protected HttpRequestHandlerResolver |
handlerResolver
Deprecated. |
protected HttpResponseFactory |
responseFactory
Deprecated. |
Fields inherited from class org.apache.http.nio.protocol.NHttpHandlerBase |
---|
allocator, CONN_STATE, connStrategy, eventListener, httpProcessor, params |
Constructor Summary | |
---|---|
ThrottlingHttpServiceHandler(HttpProcessor httpProcessor,
HttpResponseFactory responseFactory,
ConnectionReuseStrategy connStrategy,
ByteBufferAllocator allocator,
Executor executor,
HttpParams params)
Deprecated. |
|
ThrottlingHttpServiceHandler(HttpProcessor httpProcessor,
HttpResponseFactory responseFactory,
ConnectionReuseStrategy connStrategy,
Executor executor,
HttpParams params)
Deprecated. |
Method Summary | |
---|---|
void |
closed(NHttpServerConnection conn)
Deprecated. Triggered when the connection is closed. |
void |
connected(NHttpServerConnection conn)
Deprecated. Triggered when a new incoming connection is created. |
void |
exception(NHttpServerConnection conn,
HttpException httpex)
Deprecated. Triggered when an HTTP protocol violation occurs while receiving an HTTP request. |
void |
exception(NHttpServerConnection conn,
IOException ex)
Deprecated. Triggered when an I/O error occurs while reading from or writing to the underlying channel. |
void |
inputReady(NHttpServerConnection conn,
ContentDecoder decoder)
Deprecated. Triggered when the underlying channel is ready for reading a new portion of the request entity through the corresponding content decoder. |
void |
outputReady(NHttpServerConnection conn,
ContentEncoder encoder)
Deprecated. Triggered when the underlying channel is ready for writing a next portion of the response entity through the corresponding content encoder. |
void |
requestReceived(NHttpServerConnection conn)
Deprecated. Triggered when a new HTTP request is received. |
void |
responseReady(NHttpServerConnection conn)
Deprecated. Triggered when the connection is ready to accept a new HTTP response. |
void |
setExpectationVerifier(HttpExpectationVerifier expectationVerifier)
Deprecated. |
void |
setHandlerResolver(HttpRequestHandlerResolver handlerResolver)
Deprecated. |
protected void |
shutdownConnection(NHttpConnection conn,
Throwable cause)
Deprecated. |
void |
timeout(NHttpServerConnection 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 |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected final HttpResponseFactory responseFactory
protected final Executor executor
protected HttpRequestHandlerResolver handlerResolver
protected HttpExpectationVerifier expectationVerifier
Constructor Detail |
---|
public ThrottlingHttpServiceHandler(HttpProcessor httpProcessor, HttpResponseFactory responseFactory, ConnectionReuseStrategy connStrategy, ByteBufferAllocator allocator, Executor executor, HttpParams params)
public ThrottlingHttpServiceHandler(HttpProcessor httpProcessor, HttpResponseFactory responseFactory, ConnectionReuseStrategy connStrategy, Executor executor, HttpParams params)
Method Detail |
---|
public void setHandlerResolver(HttpRequestHandlerResolver handlerResolver)
public void setExpectationVerifier(HttpExpectationVerifier expectationVerifier)
public void connected(NHttpServerConnection conn)
NHttpServiceHandler
connected
in interface NHttpServiceHandler
conn
- new incoming connection HTTP connection.public void closed(NHttpServerConnection conn)
NHttpServiceHandler
closed
in interface NHttpServiceHandler
conn
- closed HTTP connection.public void exception(NHttpServerConnection conn, HttpException httpex)
NHttpServiceHandler
exception
in interface NHttpServiceHandler
conn
- HTTP connection that caused an HTTP protocol violationhttpex
- HTTP protocol violation exceptionpublic void exception(NHttpServerConnection conn, IOException ex)
NHttpServiceHandler
exception
in interface NHttpServiceHandler
conn
- HTTP connection that caused an I/O errorex
- I/O exceptionpublic void timeout(NHttpServerConnection conn)
NHttpServiceHandler
timeout
in interface NHttpServiceHandler
conn
- HTTP connection that caused timeout condition.public void requestReceived(NHttpServerConnection conn)
NHttpServiceHandler
If the request received encloses a request entity this method will
be followed a series of
NHttpServiceHandler.inputReady(NHttpServerConnection, ContentDecoder)
calls
to transfer the request content.
requestReceived
in interface NHttpServiceHandler
conn
- HTTP connection that contains a new HTTP requestNHttpServerConnection
public void inputReady(NHttpServerConnection conn, ContentDecoder decoder)
NHttpServiceHandler
If the content consumer is unable to process the incoming content,
input event notifications can be temporarily suspended using
IOControl
interface.
inputReady
in interface NHttpServiceHandler
conn
- HTTP connection that can produce a new portion of the
incoming request content.decoder
- The content decoder to use to read content.NHttpServerConnection
,
ContentDecoder
,
IOControl
public void responseReady(NHttpServerConnection conn)
NHttpServiceHandler
responseReady
in interface NHttpServiceHandler
conn
- HTTP connection that contains an HTTP responseNHttpServerConnection
public void outputReady(NHttpServerConnection conn, ContentEncoder encoder)
NHttpServiceHandler
If the content producer is unable to generate the outgoing content,
output event notifications can be temporarily suspended using
IOControl
interface.
outputReady
in interface NHttpServiceHandler
conn
- HTTP connection that can accommodate a new portion
of the outgoing response content.encoder
- The content encoder to use to write content.NHttpServerConnection
,
ContentEncoder
,
IOControl
protected void shutdownConnection(NHttpConnection conn, Throwable cause)
shutdownConnection
in class NHttpHandlerBase
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |