Class ThrottlingHttpServiceHandler
- java.lang.Object
-
- org.apache.http.nio.protocol.NHttpHandlerBase
-
- org.apache.http.nio.protocol.ThrottlingHttpServiceHandler
-
- All Implemented Interfaces:
NHttpServiceHandler
@Deprecated @Contract(threading=SAFE_CONDITIONAL) public class ThrottlingHttpServiceHandler extends NHttpHandlerBase implements NHttpServiceHandler
Deprecated.(4.2) useHttpAsyncService
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. TheHttpRequestHandler.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 anExecutor
, 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:
- Since:
- 4.0
-
-
Constructor Summary
Constructors Constructor Description ThrottlingHttpServiceHandler(HttpProcessor httpProcessor, HttpResponseFactory responseFactory, ConnectionReuseStrategy connStrategy, java.util.concurrent.Executor executor, HttpParams params)
Deprecated.ThrottlingHttpServiceHandler(HttpProcessor httpProcessor, HttpResponseFactory responseFactory, ConnectionReuseStrategy connStrategy, ByteBufferAllocator allocator, java.util.concurrent.Executor executor, HttpParams params)
Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description 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, java.io.IOException ex)
Deprecated.Triggered when an I/O error occurs while reading from or writing to the underlying channel.void
exception(NHttpServerConnection conn, HttpException httpex)
Deprecated.Triggered when an HTTP protocol violation occurs while receiving an HTTP request.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.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
getParams, setEventListener
-
-
-
-
Constructor Detail
-
ThrottlingHttpServiceHandler
public ThrottlingHttpServiceHandler(HttpProcessor httpProcessor, HttpResponseFactory responseFactory, ConnectionReuseStrategy connStrategy, ByteBufferAllocator allocator, java.util.concurrent.Executor executor, HttpParams params)
Deprecated.
-
ThrottlingHttpServiceHandler
public ThrottlingHttpServiceHandler(HttpProcessor httpProcessor, HttpResponseFactory responseFactory, ConnectionReuseStrategy connStrategy, java.util.concurrent.Executor executor, HttpParams params)
Deprecated.
-
-
Method Detail
-
setHandlerResolver
public void setHandlerResolver(HttpRequestHandlerResolver handlerResolver)
Deprecated.
-
setExpectationVerifier
public void setExpectationVerifier(HttpExpectationVerifier expectationVerifier)
Deprecated.
-
connected
public void connected(NHttpServerConnection conn)
Deprecated.Description copied from interface:NHttpServiceHandler
Triggered when a new incoming connection is created.- Specified by:
connected
in interfaceNHttpServiceHandler
- Parameters:
conn
- new incoming connection HTTP connection.
-
closed
public void closed(NHttpServerConnection conn)
Deprecated.Description copied from interface:NHttpServiceHandler
Triggered when the connection is closed.- Specified by:
closed
in interfaceNHttpServiceHandler
- Parameters:
conn
- closed HTTP connection.
-
exception
public void exception(NHttpServerConnection conn, HttpException httpex)
Deprecated.Description copied from interface:NHttpServiceHandler
Triggered when an HTTP protocol violation occurs while receiving an HTTP request.- Specified by:
exception
in interfaceNHttpServiceHandler
- Parameters:
conn
- HTTP connection that caused an HTTP protocol violationhttpex
- HTTP protocol violation exception
-
exception
public void exception(NHttpServerConnection conn, java.io.IOException ex)
Deprecated.Description copied from interface:NHttpServiceHandler
Triggered when an I/O error occurs while reading from or writing to the underlying channel.- Specified by:
exception
in interfaceNHttpServiceHandler
- Parameters:
conn
- HTTP connection that caused an I/O errorex
- I/O exception
-
timeout
public void timeout(NHttpServerConnection conn)
Deprecated.Description copied from interface:NHttpServiceHandler
Triggered when no input is detected on this connection over the maximum period of inactivity.- Specified by:
timeout
in interfaceNHttpServiceHandler
- Parameters:
conn
- HTTP connection that caused timeout condition.
-
requestReceived
public void requestReceived(NHttpServerConnection conn)
Deprecated.Description copied from interface:NHttpServiceHandler
Triggered when a new HTTP request is received. The connection passed as a parameter to this method is guaranteed to return a valid HTTP request object.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.- Specified by:
requestReceived
in interfaceNHttpServiceHandler
- Parameters:
conn
- HTTP connection that contains a new HTTP request- See Also:
NHttpServerConnection
-
inputReady
public void inputReady(NHttpServerConnection conn, ContentDecoder decoder)
Deprecated.Description copied from interface:NHttpServiceHandler
Triggered when the underlying channel is ready for reading a new portion of the request 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.- Specified by:
inputReady
in interfaceNHttpServiceHandler
- Parameters:
conn
- HTTP connection that can produce a new portion of the incoming request content.decoder
- The content decoder to use to read content.- See Also:
NHttpServerConnection
,ContentDecoder
,IOControl
-
responseReady
public void responseReady(NHttpServerConnection conn)
Deprecated.Description copied from interface:NHttpServiceHandler
Triggered when the connection is ready to accept a new HTTP response. The protocol handler does not have to submit a response if it is not ready.- Specified by:
responseReady
in interfaceNHttpServiceHandler
- Parameters:
conn
- HTTP connection that contains an HTTP response- See Also:
NHttpServerConnection
-
outputReady
public void outputReady(NHttpServerConnection conn, ContentEncoder encoder)
Deprecated.Description copied from interface:NHttpServiceHandler
Triggered when the underlying channel is ready for writing a next portion of the response 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.- Specified by:
outputReady
in interfaceNHttpServiceHandler
- Parameters:
conn
- HTTP connection that can accommodate a new portion of the outgoing response content.encoder
- The content encoder to use to write content.- See Also:
NHttpServerConnection
,ContentEncoder
,IOControl
-
-