Interface Connection

All Superinterfaces:
AutoCloseable, Closeable
All Known Implementing Classes:
AbstractConnection, ALPNClientConnection, ALPNServerConnection, ClientHTTP3StreamConnection, ClientQuicConnection, ConnectHandler.DownstreamConnection, ConnectHandler.UpstreamConnection, ControlStreamConnection, DecoderStreamConnection, EncoderStreamConnection, HTTP2Connection, HTTP2ServerConnection, HTTP3StreamConnection, HttpConnection, HttpConnectionOverFCGI, HttpConnectionOverHTTP, InstructionStreamConnection, NegotiatingClientConnection, NegotiatingServerConnection, ProxyConnection, ProxyProtocolClientConnectionFactory.ProxyProtocolConnection, QuicConnection, ServerFCGIConnection, ServerHTTP3StreamConnection, ServerQuicConnection, SslConnection, UnidirectionalStreamConnection, WebSocketConnection

public interface Connection extends Closeable

A Connection is associated to an EndPoint so that I/O events happening on the EndPoint can be processed by the Connection.

A typical implementation of Connection overrides onOpen() to set read interest on the EndPoint, and when the EndPoint signals read readyness, this Connection can read bytes from the network and interpret them.

  • Method Details

    • addEventListener

      void addEventListener(EventListener listener)

      Adds a listener of connection events.

      listener - the listener to add
    • removeEventListener

      void removeEventListener(EventListener listener)

      Removes a listener of connection events.

      listener - the listener to remove
    • onOpen

      void onOpen()

      Callback method invoked when this connection is opened.

      Creators of the connection implementation are responsible for calling this method.

    • onClose

      void onClose(Throwable cause)

      Callback method invoked when this connection is closed.

      Creators of the connection implementation are responsible for calling this method.

      cause - The cause of the close or null for a normal close
    • getEndPoint

      EndPoint getEndPoint()
      the EndPoint associated with this Connection.
    • close

      void close()

      Performs a logical close of this connection.

      For simple connections, this may just mean to delegate the close to the associated EndPoint but, for example, SSL connections should write the SSL close message before closing the associated EndPoint.

      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
    • onIdleExpired

      boolean onIdleExpired()

      Callback method invoked upon an idle timeout event.

      Implementations of this method may return true to indicate that the idle timeout handling should proceed normally, typically failing the EndPoint and causing it to be closed.

      When false is returned, the handling of the idle timeout event is halted immediately and the EndPoint left in the state it was before the idle timeout event.

      true to let the EndPoint handle the idle timeout, false to tell the EndPoint to halt the handling of the idle timeout.
    • getMessagesIn

      long getMessagesIn()
    • getMessagesOut

      long getMessagesOut()
    • getBytesIn

      long getBytesIn()
    • getBytesOut

      long getBytesOut()
    • getCreatedTimeStamp

      long getCreatedTimeStamp()