org.apache.http.nio
Interface NHttpServiceHandler

All Known Implementing Classes:

BufferingHttpServiceHandler, ThrottlingHttpServiceHandler

public interface NHttpServiceHandler

Abstract server-side HTTP event handler.

Author:

Oleg Kalnichevski

Method Summary

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

Method Detail

connected

public void connected(NHttpServerConnection conn)

Triggered when a new incoming connection is created.

Parameters:

conn - closed HTTP connection.

requestReceived

public 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

See Also:

NHttpServerConnection

inputReady

public 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 temorarily suspended using IOControl.suspendInput().

Parameters:

conn - HTTP connection that can produce a new portion of the incoming request content.

decoder - The content decoder to use to read content.

See Also:

NHttpConnection, ContentDecoder

responseReady

public void responseReady(NHttpServerConnection conn)

Triggered when the connection is ready to send an HTTP response.

Parameters:

conn - HTTP connection that contains an HTTP response

See Also:

NHttpServerConnection

outputReady

public 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 temorarily suspended using IOControl.suspendOutput().

Parameters:

conn - HTTP connection that can accommodate a new portion of the outgoing response content.

encoder - The content encoder to use to write content.

See Also:

NHttpConnection, ContentEncoder

exception

public void exception(NHttpServerConnection 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(NHttpServerConnection conn,
                      org.apache.http.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

timeout

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

closed

public void closed(NHttpServerConnection conn)

Triggered when the connection is closed.

Parameters:

conn - closed HTTP connection.