org.apache.http.nio.protocol
Class ThrottlingHttpClientHandler

java.lang.Object
  extended by org.apache.http.nio.protocol.NHttpHandlerBase
      extended by org.apache.http.nio.protocol.NHttpClientHandlerBase
          extended by org.apache.http.nio.protocol.ThrottlingHttpClientHandler
All Implemented Interfaces:
NHttpClientHandler

public class ThrottlingHttpClientHandler
extends NHttpClientHandlerBase

HTTP client 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 client handler will delegate the tasks of sending entity enclosing HTTP requests and processing of HTTP responses 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.NHttpClientHandlerBase
execHandler
 
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)
           
ThrottlingHttpClientHandler(HttpProcessor httpProcessor, HttpRequestExecutionHandler execHandler, ConnectionReuseStrategy connStrategy, Executor executor, HttpParams params)
           
 
Method Summary
 void closed(NHttpClientConnection conn)
          Triggered when the connection is closed.
 void connected(NHttpClientConnection conn, java.lang.Object attachment)
          Triggered when a new outgoing connection is created.
 void inputReady(NHttpClientConnection conn, ContentDecoder decoder)
          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)
          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)
          Triggered when the connection is ready to send an HTTP request.
 void responseReceived(NHttpClientConnection conn)
          Triggered when an HTTP response is received.
protected  void shutdownConnection(NHttpConnection conn, java.lang.Throwable cause)
           
 void timeout(NHttpClientConnection conn)
          Triggered when no input is detected on this connection over the maximum period of inactivity.
 
Methods inherited from class org.apache.http.nio.protocol.NHttpClientHandlerBase
exception, exception
 
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

ThrottlingHttpClientHandler

public ThrottlingHttpClientHandler(HttpProcessor httpProcessor,
                                   HttpRequestExecutionHandler execHandler,
                                   ConnectionReuseStrategy connStrategy,
                                   ByteBufferAllocator allocator,
                                   Executor executor,
                                   HttpParams params)

ThrottlingHttpClientHandler

public ThrottlingHttpClientHandler(HttpProcessor httpProcessor,
                                   HttpRequestExecutionHandler execHandler,
                                   ConnectionReuseStrategy connStrategy,
                                   Executor executor,
                                   HttpParams params)
Method Detail

connected

public void connected(NHttpClientConnection conn,
                      java.lang.Object attachment)
Description copied from interface: NHttpClientHandler
Triggered when a new outgoing connection is created.

Parameters:
conn - closed HTTP connection.
attachment - an arbitrary object that was attached to the session request

closed

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

Specified by:
closed in interface NHttpClientHandler
Overrides:
closed in class NHttpClientHandlerBase
Parameters:
conn - closed HTTP connection.

requestReady

public void requestReady(NHttpClientConnection conn)
Description copied from interface: NHttpClientHandler
Triggered when the connection is ready to send an HTTP request.

Parameters:
conn - HTTP connection that is ready to send an HTTP request
See Also:
NHttpClientConnection

outputReady

public void outputReady(NHttpClientConnection conn,
                        ContentEncoder encoder)
Description copied from interface: NHttpClientHandler
Triggered when the underlying channel is ready for writing a next portion of the request 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 request content.
encoder - The content encoder to use to write content.
See Also:
NHttpConnection, ContentEncoder

responseReceived

public void responseReceived(NHttpClientConnection conn)
Description copied from interface: NHttpClientHandler
Triggered when an HTTP response is received. The connection passed as a parameter to this method is guaranteed to return a valid HTTP response object.

If the response received encloses a response entity this method will be followed a series of NHttpClientHandler.inputReady(NHttpClientConnection, ContentDecoder) calls to transfer the response content.

Parameters:
conn - HTTP connection that contains an HTTP response
See Also:
NHttpClientConnection

inputReady

public void inputReady(NHttpClientConnection conn,
                       ContentDecoder decoder)
Description copied from interface: NHttpClientHandler
Triggered when the underlying channel is ready for reading a new portion of the response 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 response content.
decoder - The content decoder to use to read content.
See Also:
NHttpConnection, ContentDecoder

timeout

public void timeout(NHttpClientConnection conn)
Description copied from interface: NHttpClientHandler
Triggered when no input is detected on this connection over the maximum period of inactivity.

Parameters:
conn - HTTP connection that caused timeout condition.

shutdownConnection

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


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