Interface Connector

All Superinterfaces:
Container, Graceful, LifeCycle
All Known Subinterfaces:
NetworkConnector
All Known Implementing Classes:
AbstractConnector, AbstractNetworkConnector, HTTP3ServerConnector, LocalConnector, MemoryConnector, NetworkTrafficServerConnector, QuicServerConnector, ServerConnector, UnixDomainServerConnector
@ManagedObject("Connector Interface") public interface Connector extends LifeCycle, Container, Graceful

A Connector accept connections and data from remote peers, and allows applications to send data to remote peers, by setting up the machinery needed to handle such tasks.

  • Method Details

    • getServer

      Server getServer()
      Get the Server instance associated with this Connector.
      Returns:
      the Server instance associated with this Connector

    • getExecutor

      Executor getExecutor()
      Get the Executor used to submit tasks.
      Returns:
      the Executor used to submit tasks

    • getScheduler

      Scheduler getScheduler()
      Get the Scheduler used to schedule tasks.
      Returns:
      the Scheduler used to schedule tasks

    • getByteBufferPool

      ByteBufferPool getByteBufferPool()
      Get the ByteBufferPool to acquire buffers from and release buffers to.
      Returns:
      the ByteBufferPool to acquire buffers from and release buffers to

    • getConnectionFactory

      ConnectionFactory getConnectionFactory(String nextProtocol)
      Parameters:
      nextProtocol - the next protocol
      Returns:
      the ConnectionFactory associated with the protocol name

    • getConnectionFactory

      <T> T getConnectionFactory(Class<T> factoryType)

    • getDefaultConnectionFactory

      ConnectionFactory getDefaultConnectionFactory()
      Get the default ConnectionFactory associated with the default protocol name.
      Returns:
      the default ConnectionFactory associated with the default protocol name

    • getConnectionFactories

      Collection<ConnectionFactory> getConnectionFactories()

    • getProtocols

      List<String> getProtocols()

    • getIdleTimeout

      @ManagedAttribute("maximum time a connection can be idle before being closed (in ms)") long getIdleTimeout()
      Returns:
      the max idle timeout for connections in milliseconds

    • getTransport

      Object getTransport()
      Get the underlying socket, channel, buffer etc. for the connector..
      Returns:
      the underlying socket, channel, buffer etc. for the connector.

    • getConnectedEndPoints

      Collection<EndPoint> getConnectedEndPoints()
      Returns:
      immutable collection of connected endpoints

    • getName

      String getName()
      Get the connector name if set.

      A ContextHandler may be configured with virtual hosts in the form "@connectorName" and will only serve requests from the named connector.

      Returns:
      The connector name or null.