org.apache.http.nio
Interface NHttpClientHandler

All Known Implementing Classes:

BufferingHttpClientHandler

public interface NHttpClientHandler

Abstract client-side HTTP event handler.

Author:

Oleg Kalnichevski

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	exception(NHttpClientConnection conn, org.apache.http.HttpException ex) Triggered when an HTTP protocol violation occurs while receiving an HTTP response.
void	exception(NHttpClientConnection conn, java.io.IOException ex) Triggered when an I/O error occurrs 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.
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.
void	timeout(NHttpClientConnection conn) Triggered when no input is detected on this connection over the maximum period of inactivity.

Method Detail

connected

public void connected(NHttpClientConnection conn,
                      java.lang.Object attachment)

Triggered when a new outgoing connection is created.

Parameters:

conn - closed HTTP connection.

attachment - an arbitrary object that was attached to the session request

requestReady

public void requestReady(NHttpClientConnection conn)

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

responseReceived

public void responseReceived(NHttpClientConnection conn)

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

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

outputReady

public 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.

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

exception

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

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

Parameters:

conn - HTTP connection that caused an I/O error

ex - I/O exception

exception

public void exception(NHttpClientConnection conn,
                      org.apache.http.HttpException ex)

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

Parameters:

conn - HTTP connection that caused an HTTP protocol violation

ex - HTTP protocol violation exception

timeout

public void timeout(NHttpClientConnection conn)

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

Parameters:

conn - HTTP connection that caused timeout condition.

closed

public void closed(NHttpClientConnection conn)

Triggered when the connection is closed.

Parameters:

conn - closed HTTP connection.