public interface

NHttpClientHandler

org.apache.http.nio.NHttpClientHandler
Known Indirect Subclasses

Class Overview

Abstract client-side HTTP protocol handler.

Summary

Public Methods
abstract void closed(NHttpClientConnection conn)
Triggered when the connection is closed.
abstract void connected(NHttpClientConnection conn, Object attachment)
Triggered when a new outgoing connection is created.
abstract void exception(NHttpClientConnection conn, HttpException ex)
Triggered when an HTTP protocol violation occurs while receiving an HTTP response.
abstract void exception(NHttpClientConnection conn, IOException ex)
Triggered when an I/O error occurs while reading from or writing to the underlying channel.
abstract 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.
abstract 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.
abstract void requestReady(NHttpClientConnection conn)
Triggered when the connection is ready to accept a new HTTP request.
abstract void responseReceived(NHttpClientConnection conn)
Triggered when an HTTP response is received.
abstract void timeout(NHttpClientConnection conn)
Triggered when no input is detected on this connection over the maximum period of inactivity.

Public Methods

public abstract void closed (NHttpClientConnection conn)

Triggered when the connection is closed.

Parameters
conn closed HTTP connection.

public abstract void connected (NHttpClientConnection conn, Object attachment)

Triggered when a new outgoing connection is created.

Parameters
conn new outgoing HTTP connection.
attachment an object that was attached to the session request

public abstract void exception (NHttpClientConnection conn, 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

public abstract void exception (NHttpClientConnection conn, IOException ex)

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

Parameters
conn HTTP connection that caused an I/O error
ex I/O exception

public abstract 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 temporarily suspended using IOControl interface.

Parameters
conn HTTP connection that can produce a new portion of the incoming response content.
decoder The content decoder to use to read content.

public abstract 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 temporarily suspended using IOControl interface.

Parameters
conn HTTP connection that can accommodate a new portion of the outgoing request content.
encoder The content encoder to use to write content.

public abstract void requestReady (NHttpClientConnection conn)

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.

Parameters
conn HTTP connection that is ready to accept a new HTTP request.

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

Parameters
conn HTTP connection that contains an HTTP response

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