org.apache.http.nio.protocol
Class ThrottlingHttpServiceHandler

java.lang.Object
  extended by org.apache.http.nio.protocol.NHttpHandlerBase
      extended by org.apache.http.nio.protocol.NHttpServiceHandlerBase
          extended by org.apache.http.nio.protocol.ThrottlingHttpServiceHandler
All Implemented Interfaces:
NHttpServiceHandler

public class ThrottlingHttpServiceHandler
extends NHttpServiceHandlerBase

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

Field Summary
protected  Executor executor
           
 
Fields inherited from class org.apache.http.nio.protocol.NHttpServiceHandlerBase
expectationVerifier, handlerResolver, responseFactory
 
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)
           
ThrottlingHttpServiceHandler(HttpProcessor httpProcessor, HttpResponseFactory responseFactory, ConnectionReuseStrategy connStrategy, Executor executor, 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, HttpException httpex)
          Triggered when an HTTP protocol violation occurs while receiving an HTTP request.
 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.
protected  void shutdownConnection(NHttpConnection conn, java.lang.Throwable cause)
           
 
Methods inherited from class org.apache.http.nio.protocol.NHttpServiceHandlerBase
exception, setExpectationVerifier, setHandlerResolver, timeout
 
Methods inherited from class org.apache.http.nio.protocol.NHttpHandlerBase
canResponseHaveBody, closeConnection, getParams, setEventListener, shutdownConnection
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

executor

protected final Executor executor
Constructor Detail

ThrottlingHttpServiceHandler

public ThrottlingHttpServiceHandler(HttpProcessor httpProcessor,
                                    HttpResponseFactory responseFactory,
                                    ConnectionReuseStrategy connStrategy,
                                    ByteBufferAllocator allocator,
                                    Executor executor,
                                    HttpParams params)

ThrottlingHttpServiceHandler

public ThrottlingHttpServiceHandler(HttpProcessor httpProcessor,
                                    HttpResponseFactory responseFactory,
                                    ConnectionReuseStrategy connStrategy,
                                    Executor executor,
                                    HttpParams params)
Method Detail

connected

public void connected(NHttpServerConnection conn)
Description copied from interface: NHttpServiceHandler
Triggered when a new incoming connection is created.

Parameters:
conn - closed HTTP connection.

closed

public void closed(NHttpServerConnection conn)
Description copied from interface: NHttpServiceHandler
Triggered when the connection is closed.

Parameters:
conn - closed HTTP connection.

exception

public void exception(NHttpServerConnection conn,
                      HttpException httpex)
Description copied from interface: NHttpServiceHandler
Triggered when an HTTP protocol violation occurs while receiving an HTTP request.

Parameters:
conn - HTTP connection that caused an HTTP protocol violation
httpex - HTTP protocol violation exception

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.

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().

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.

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().

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

shutdownConnection

protected void shutdownConnection(NHttpConnection conn,
                                  java.lang.Throwable cause)


Copyright © 2005-2009 Apache Software Foundation. All Rights Reserved.