Interface NHttpConnection

  • All Superinterfaces:
    java.lang.AutoCloseable, java.io.Closeable, org.apache.http.HttpConnection, IOControl
    All Known Subinterfaces:
    NHttpClientConnection, NHttpClientIOTarget, NHttpServerConnection, NHttpServerIOTarget
    All Known Implementing Classes:
    DefaultNHttpClientConnection, DefaultNHttpServerConnection, NHttpConnectionBase

    public interface NHttpConnection
    extends org.apache.http.HttpConnection, IOControl
    Abstract non-blocking HTTP connection interface. Each connection contains an HTTP execution context, which can be used to maintain a processing state, as well as the actual HttpRequest and HttpResponse that are being transmitted over this connection. Both the request and the response objects can be null if there is no incoming or outgoing message currently being transferred.

    Please note non-blocking HTTP connections are stateful and not thread safe. Input / output operations on non-blocking HTTP connections should be restricted to the dispatch events triggered by the I/O event dispatch thread. However, the IOControl interface is fully threading safe and can be manipulated from any thread.

    Since:
    4.0
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ACTIVE  
      static int CLOSED  
      static int CLOSING  
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      org.apache.http.protocol.HttpContext getContext()
      Returns an HTTP execution context associated with this connection.
      org.apache.http.HttpRequest getHttpRequest()
      Returns the current HTTP request if one is being received / transmitted.
      org.apache.http.HttpResponse getHttpResponse()
      Returns the current HTTP response if one is being received / transmitted.
      int getStatus()
      Returns status of the connection:
      • Methods inherited from interface org.apache.http.HttpConnection

        close, getMetrics, getSocketTimeout, isOpen, isStale, setSocketTimeout, shutdown
    • Method Detail

      • getStatus

        int getStatus()
        Returns status of the connection:

        ACTIVE: connection is active.

        CLOSING: connection is being closed.

        CLOSED: connection has been closed.

        Returns:
        connection status.
      • getHttpRequest

        org.apache.http.HttpRequest getHttpRequest()
        Returns the current HTTP request if one is being received / transmitted. Otherwise returns null.
        Returns:
        HTTP request, if available, null otherwise.
      • getHttpResponse

        org.apache.http.HttpResponse getHttpResponse()
        Returns the current HTTP response if one is being received / transmitted. Otherwise returns null.
        Returns:
        HTTP response, if available, null otherwise.
      • getContext

        org.apache.http.protocol.HttpContext getContext()
        Returns an HTTP execution context associated with this connection.
        Returns:
        HTTP context