org.apache.http.nio.protocol
Class ThrottlingHttpServiceHandler

java.lang.Object
  org.apache.http.nio.protocol.ThrottlingHttpServiceHandler

All Implemented Interfaces:

NHttpServiceHandler

public class ThrottlingHttpServiceHandler

extends java.lang.Object

implements NHttpServiceHandler

HTTP service handler implementation that allocates content buffers of limited size upon initialization and is capable of controlling the frequency of I/O events in order to guarantee those content buffers do not ever get overflown. This helps ensure near constant memory footprint of HTTP connections and to avoid the 'out of memory' condition while streaming out response content.

The service handler will 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.

Author:

Oleg Kalnichevski

See Also:

HttpNIOParams.CONTENT_BUFFER_SIZE

Constructor Summary

ThrottlingHttpServiceHandler(org.apache.http.protocol.HttpProcessor httpProcessor, org.apache.http.HttpResponseFactory responseFactory, org.apache.http.ConnectionReuseStrategy connStrategy, org.apache.http.util.concurrent.Executor executor, org.apache.http.params.HttpParams params)

Method Summary

void	closed(NHttpServerConnection conn) Triggered when the connection is closed.
void	connected(NHttpServerConnection conn) Triggered when a new incoming connection is created.
void	exception(NHttpServerConnection conn, org.apache.http.HttpException httpex) Triggered when an HTTP protocol violation occurs while receiving an HTTP request.
void	exception(NHttpServerConnection conn, java.io.IOException ex) Triggered when an I/O error occurrs while reading from or writing to the underlying channel.
org.apache.http.params.HttpParams	getParams()
void	inputReady(NHttpServerConnection conn, ContentDecoder decoder) 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) 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) Triggered when a new HTTP request is received.
void	responseReady(NHttpServerConnection conn) Triggered when the connection is ready to send an HTTP response.
void	setEventListener(EventListener eventListener)
void	setExpectationVerifier(org.apache.http.protocol.HttpExpectationVerifier expectationVerifier)
void	setHandlerResolver(org.apache.http.protocol.HttpRequestHandlerResolver handlerResolver)
void	timeout(NHttpServerConnection conn) Triggered when no input is detected on this connection over the maximum period of inactivity.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ThrottlingHttpServiceHandler

public ThrottlingHttpServiceHandler(org.apache.http.protocol.HttpProcessor httpProcessor,
                                    org.apache.http.HttpResponseFactory responseFactory,
                                    org.apache.http.ConnectionReuseStrategy connStrategy,
                                    org.apache.http.util.concurrent.Executor executor,
                                    org.apache.http.params.HttpParams params)

Method Detail

setEventListener

public void setEventListener(EventListener eventListener)

setHandlerResolver

public void setHandlerResolver(org.apache.http.protocol.HttpRequestHandlerResolver handlerResolver)

setExpectationVerifier

public void setExpectationVerifier(org.apache.http.protocol.HttpExpectationVerifier expectationVerifier)

getParams

public org.apache.http.params.HttpParams getParams()

connected

public void connected(NHttpServerConnection conn)

Description copied from interface: NHttpServiceHandler

Triggered when a new incoming connection is created.

Specified by:

connected in interface NHttpServiceHandler

Parameters:

conn - closed HTTP connection.

closed

public void closed(NHttpServerConnection conn)

Description copied from interface: NHttpServiceHandler

Triggered when the connection is closed.

Specified by:

closed in interface NHttpServiceHandler

Parameters:

conn - closed HTTP connection.

exception

public void exception(NHttpServerConnection conn,
                      org.apache.http.HttpException httpex)

Description copied from interface: NHttpServiceHandler

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

Specified by:

exception in interface NHttpServiceHandler

Parameters:

conn - HTTP connection that caused an HTTP protocol violation

httpex - HTTP protocol violation exception

exception

public void exception(NHttpServerConnection conn,
                      java.io.IOException ex)

Description copied from interface: NHttpServiceHandler

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

Specified by:

exception in interface NHttpServiceHandler

Parameters:

conn - HTTP connection that caused an I/O error

ex - I/O exception

timeout

public void timeout(NHttpServerConnection conn)

Description copied from interface: NHttpServiceHandler

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

Specified by:

timeout in interface NHttpServiceHandler

Parameters:

conn - HTTP connection that caused timeout condition.

requestReceived

public void requestReceived(NHttpServerConnection conn)

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 interface NHttpServiceHandler

Parameters:

conn - HTTP connection that contains a new HTTP request

See Also:

NHttpServerConnection

inputReady

public void inputReady(NHttpServerConnection conn,
                       ContentDecoder decoder)

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 temorarily suspended using IOControl.suspendInput().

Specified by:

inputReady in interface NHttpServiceHandler

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:

NHttpConnection, ContentDecoder

responseReady

public void responseReady(NHttpServerConnection conn)

Description copied from interface: NHttpServiceHandler

Triggered when the connection is ready to send an HTTP response.

Specified by:

responseReady in interface NHttpServiceHandler

Parameters:

conn - HTTP connection that contains an HTTP response

See Also:

NHttpServerConnection

outputReady

public void outputReady(NHttpServerConnection conn,
                        ContentEncoder encoder)

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 temorarily suspended using IOControl.suspendOutput().

Specified by:

outputReady in interface NHttpServiceHandler

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:

NHttpConnection, ContentEncoder