public interface

NHttpServiceHandler

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

Class Overview

Abstract server-side HTTP protocol handler.

Summary

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

Public Methods

public abstract void closed (NHttpServerConnection conn)

Triggered when the connection is closed.

Parameters
conn closed HTTP connection.

public abstract void connected (NHttpServerConnection conn)

Triggered when a new incoming connection is created.

Parameters
conn new incoming connection HTTP connection.

public abstract void exception (NHttpServerConnection conn, HttpException ex)

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

Parameters
conn HTTP connection that caused an HTTP protocol violation
ex HTTP protocol violation exception

public abstract void exception (NHttpServerConnection 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 (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.

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 request content.
decoder The content decoder to use to read content.

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

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 response content.
encoder The content encoder to use to write content.

public abstract void requestReceived (NHttpServerConnection conn)

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 inputReady(NHttpServerConnection, ContentDecoder) calls to transfer the request content.

Parameters
conn HTTP connection that contains a new HTTP request

public abstract void responseReady (NHttpServerConnection conn)

Triggered when the connection is ready to accept a new HTTP response. The protocol handler does not have to submit a response if it is not ready.

Parameters
conn HTTP connection that contains an HTTP response

public abstract void timeout (NHttpServerConnection conn)

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

Parameters
conn HTTP connection that caused timeout condition.