Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.http.nio
Interface NHttpServerEventHandler

All Known Implementing Classes:
  HttpAsyncService

    public interface NHttpServerEventHandler

Abstract server-side HTTP event handler.

Since:
  4.2

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` | `endOfInput(NHttpServerConnection conn)` Triggered when the connection is closed by the opposite end point (half-closed).
`void` | `exception(NHttpServerConnection conn, Exception ex)` Triggered if an error occurs during the HTTP exchange.
`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 accept a new HTTP response.
`void` | `timeout(NHttpServerConnection conn)` Triggered when no input is detected on this connection over the maximum period of inactivity.

Method Detail

### connected

    void connected(NHttpServerConnection conn)
                   throws IOException,
                          HttpException

  Triggered when a new incoming connection is created.

  Parameters:
    `conn` - new incoming connection HTTP connection.
  Throws:
    `IOException`
    `HttpException`

### requestReceived

    void requestReceived(NHttpServerConnection conn)
                         throws IOException,
                                HttpException

  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
  Throws:
    `IOException`
    `HttpException`
  See Also:
    `NHttpServerConnection`

### inputReady

    void inputReady(NHttpServerConnection conn,
                    ContentDecoder decoder)
                    throws IOException,
                           HttpException

  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 incoming content, input event notifications can be temporarily suspended using `IOControl` interface (super interface of `NHttpServerConnection`).

  Please note that the `NHttpServerConnection` and `ContentDecoder` objects are not thread-safe and should only be used within the context of this method call. The `IOControl` object can be shared and used on other thread to resume input event notifications when the handler is capable of processing more content.

  Parameters:
    `conn` - HTTP connection that can produce a new portion of the incoming request content.
    `decoder` - The content decoder to use to read content.
  Throws:
    `IOException`
    `HttpException`
  See Also:
    `NHttpServerConnection`, `ContentDecoder`, `IOControl`

### responseReady

    void responseReady(NHttpServerConnection conn)
                       throws IOException,
                              HttpException

  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
  Throws:
    `IOException`
    `HttpException`
  See Also:
    `NHttpServerConnection`

### outputReady

    void outputReady(NHttpServerConnection conn,
                     ContentEncoder encoder)
                     throws IOException,
                            HttpException

  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 outgoing content, output event notifications can be temporarily suspended using `IOControl` interface (super interface of `NHttpServerConnection`).

  Please note that the `NHttpServerConnection` and `ContentEncoder` objects are not thread-safe and should only be used within the context of this method call. The `IOControl` object can be shared and used on other thread to resume output event notifications when more content is made available.

  Parameters:
    `conn` - HTTP connection that can accommodate a new portion of the outgoing response content.
    `encoder` - The content encoder to use to write content.
  Throws:
    `IOException`
    `HttpException`
  See Also:
    `NHttpServerConnection`, `ContentEncoder`, `IOControl`

### endOfInput

    void endOfInput(NHttpServerConnection conn)
                    throws IOException

  Triggered when the connection is closed by the opposite end point (half-closed).

  Parameters:
    `conn` - half-closed HTTP connection.
  Throws:
    `IOException`

### timeout

    void timeout(NHttpServerConnection conn)
                 throws IOException

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

  Parameters:
    `conn` - HTTP connection that caused timeout condition.
  Throws:
    `IOException`

### closed

    void closed(NHttpServerConnection conn)

  Triggered when the connection is closed.

  Parameters:
    `conn` - closed HTTP connection.

### exception

    void exception(NHttpServerConnection conn,
                   Exception ex)

  Triggered if an error occurs during the HTTP exchange.

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

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2005–2021 The Apache Software Foundation. All rights reserved.