org.apache.http.nio.protocol
Class HttpAsyncClientProtocolHandler

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

@Immutable
public class HttpAsyncClientProtocolHandler
extends Object
implements NHttpClientHandler

Since:
4.2

Field Summary
static String HTTP_HANDLER
           
 
Constructor Summary
HttpAsyncClientProtocolHandler()
           
 
Method Summary
 void closed(NHttpClientConnection conn)
          Triggered when the connection is closed.
 void connected(NHttpClientConnection conn, Object attachment)
          Triggered when a new outgoing connection is created.
 void exception(NHttpClientConnection conn, HttpException ex)
          Triggered when an HTTP protocol violation occurs while receiving an HTTP response.
 void exception(NHttpClientConnection conn, IOException ex)
          Triggered when an I/O error occurs while reading from or writing to the underlying channel.
 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.
protected  void onException(Exception ex)
           
 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 accept a new HTTP request.
 void responseReceived(NHttpClientConnection conn)
          Triggered when an HTTP response is received.
 void timeout(NHttpClientConnection 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
 

Field Detail

HTTP_HANDLER

public static final String HTTP_HANDLER
See Also:
Constant Field Values
Constructor Detail

HttpAsyncClientProtocolHandler

public HttpAsyncClientProtocolHandler()
Method Detail

connected

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

Specified by:
connected in interface NHttpClientHandler
Parameters:
conn - new outgoing HTTP connection.
attachment - an 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
Parameters:
conn - closed HTTP connection.

exception

public void exception(NHttpClientConnection conn,
                      HttpException ex)
Description copied from interface: NHttpClientHandler
Triggered when an HTTP protocol violation occurs while receiving an HTTP response.

Specified by:
exception in interface NHttpClientHandler
Parameters:
conn - HTTP connection that caused an HTTP protocol violation
ex - HTTP protocol violation exception

exception

public void exception(NHttpClientConnection conn,
                      IOException ex)
Description copied from interface: NHttpClientHandler
Triggered when an I/O error occurs while reading from or writing to the underlying channel.

Specified by:
exception in interface NHttpClientHandler
Parameters:
conn - HTTP connection that caused an I/O error
ex - I/O exception

requestReady

public void requestReady(NHttpClientConnection conn)
Description copied from interface: NHttpClientHandler
Triggered when the connection is ready to accept a new HTTP request. The protocol handler does not have to submit a request if it is not ready.

Specified by:
requestReady in interface NHttpClientHandler
Parameters:
conn - HTTP connection that is ready to accept a new 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 temporarily suspended using IOControl interface.

Specified by:
outputReady in interface NHttpClientHandler
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:
NHttpClientConnection, ContentEncoder, IOControl

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 by a series of NHttpClientHandler.inputReady(NHttpClientConnection, ContentDecoder) calls to transfer the response content.

Specified by:
responseReceived in interface NHttpClientHandler
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 temporarily suspended using IOControl interface.

Specified by:
inputReady in interface NHttpClientHandler
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:
NHttpClientConnection, ContentDecoder, IOControl

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.

Specified by:
timeout in interface NHttpClientHandler
Parameters:
conn - HTTP connection that caused timeout condition.

onException

protected void onException(Exception ex)


Copyright © 2005-2011 The Apache Software Foundation. All Rights Reserved.