Package org.eclipse.jetty.server

Class ServerConnector

java.lang.Object
org.eclipse.jetty.util.component.AbstractLifeCycle
org.eclipse.jetty.util.component.ContainerLifeCycle
org.eclipse.jetty.server.AbstractConnector
org.eclipse.jetty.server.AbstractNetworkConnector
org.eclipse.jetty.server.ServerConnector
All Implemented Interfaces:
Closeable, AutoCloseable, Connector, NetworkConnector, Container, Destroyable, Dumpable, Dumpable.DumpableContainer, Graceful, LifeCycle
Direct Known Subclasses:
NetworkTrafficServerConnector
@ManagedObject("HTTP connector using NIO ByteChannels and Selectors") public class ServerConnector extends AbstractNetworkConnector
This Connector implementation is the primary connector for the Jetty server over TCP/IP. By the use of various ConnectionFactory instances it is able to accept connections for HTTP, HTTP/2 and WebSocket, either directly or over SSL.

The connector is a fully asynchronous NIO based implementation that by default will use all the commons services (eg Executor, Scheduler) of the passed Server instance, but all services may also be constructor injected into the connector so that it may operate with dedicated or otherwise shared services.

Connection Factories

Various convenience constructors are provided to assist with common configurations of ConnectionFactories, whose generic use is described in AbstractConnector. If no connection factories are passed, then the connector will default to use a HttpConnectionFactory. If an non null SslContextFactory instance is passed, then this used to instantiate a SslConnectionFactory which is prepended to the other passed or default factories.

Selectors

The default number of selectors is equal to half of the number of processors available to the JVM, which should allow optimal performance even if all the connections used are performing significant non-blocking work in the callback tasks.

  • Constructor Details

    • ServerConnector

      public ServerConnector(@Name("server") Server server)

      Construct a ServerConnector with a private instance of HttpConnectionFactory as the only factory.

      Parameters:
      server - The Server this connector will accept connection for.

    • ServerConnector

      public ServerConnector(@Name("server") Server server, @Name("acceptors") int acceptors, @Name("selectors") int selectors)

      Construct a ServerConnector with a private instance of HttpConnectionFactory as the only factory.

      Parameters:
      server - The Server this connector will accept connection for.
      acceptors - the number of acceptor threads to use, or -1 for a default value. Acceptors accept new TCP/IP connections. If 0, then the selector threads are used to accept connections.
      selectors - the number of selector threads, or <=0 for a default value. Selectors notice and schedule established connection that can make IO progress.

    • ServerConnector

      public ServerConnector(@Name("server") Server server, @Name("acceptors") int acceptors, @Name("selectors") int selectors, @Name("factories") ConnectionFactory... factories)

      Construct a ServerConnector with a private instance of HttpConnectionFactory as the only factory.

      Parameters:
      server - The Server this connector will accept connection for.
      acceptors - the number of acceptor threads to use, or -1 for a default value. Acceptors accept new TCP/IP connections. If 0, then the selector threads are used to accept connections.
      selectors - the number of selector threads, or <=0 for a default value. Selectors notice and schedule established connection that can make IO progress.
      factories - Zero or more ConnectionFactory instances used to create and configure connections.

    • ServerConnector

      public ServerConnector(@Name("server") Server server, @Name("factories") ConnectionFactory... factories)

      Construct a Server Connector with the passed Connection factories.

      Parameters:
      server - The Server this connector will accept connection for.
      factories - Zero or more ConnectionFactory instances used to create and configure connections.

    • ServerConnector

      public ServerConnector(@Name("server") Server server, @Name("sslContextFactory") SslContextFactory.Server sslContextFactory)

      Construct a ServerConnector with a private instance of HttpConnectionFactory as the primary protocol

      .
      Parameters:
      server - The Server this connector will accept connection for.
      sslContextFactory - If non null, then a SslConnectionFactory is instantiated and prepended to the list of HTTP Connection Factory.

    • ServerConnector

      public ServerConnector(@Name("server") Server server, @Name("acceptors") int acceptors, @Name("selectors") int selectors, @Name("sslContextFactory") SslContextFactory.Server sslContextFactory)

      Construct a ServerConnector with a private instance of HttpConnectionFactory as the primary protocol

      .
      Parameters:
      server - The Server this connector will accept connection for.
      sslContextFactory - If non null, then a SslConnectionFactory is instantiated and prepended to the list of HTTP Connection Factory.
      acceptors - the number of acceptor threads to use, or -1 for a default value. Acceptors accept new TCP/IP connections. If 0, then the selector threads are used to accept connections.
      selectors - the number of selector threads, or <=0 for a default value. Selectors notice and schedule established connection that can make IO progress.

    • ServerConnector

      public ServerConnector(@Name("server") Server server, @Name("sslContextFactory") SslContextFactory.Server sslContextFactory, @Name("factories") ConnectionFactory... factories)
      Parameters:
      server - The Server this connector will accept connection for.
      sslContextFactory - If non null, then a SslConnectionFactory is instantiated and prepended to the list of ConnectionFactories, with the first factory being the default protocol for the SslConnectionFactory.
      factories - Zero or more ConnectionFactory instances used to create and configure connections.

    • ServerConnector

      public ServerConnector(@Name("server") Server server, @Name("executor") Executor executor, @Name("scheduler") Scheduler scheduler, @Name("bufferPool") ByteBufferPool bufferPool, @Name("acceptors") int acceptors, @Name("selectors") int selectors, @Name("factories") ConnectionFactory... factories)
      Parameters:
      server - The server this connector will be accept connection for.
      executor - An executor used to run tasks for handling requests, acceptors and selectors. If null then use the servers executor
      scheduler - A scheduler used to schedule timeouts. If null then use the servers scheduler
      bufferPool - A ByteBuffer pool used to allocate buffers. If null then create a private pool with default configuration.
      acceptors - the number of acceptor threads to use, or -1 for a default value. Acceptors accept new TCP/IP connections. If 0, then the selector threads are used to accept connections.
      selectors - the number of selector threads, or <=0 for a default value. Selectors notice and schedule established connection that can make IO progress.
      factories - Zero or more ConnectionFactory instances used to create and configure connections.

  • Method Details

    • newSelectorManager

      protected SelectorManager newSelectorManager(Executor executor, Scheduler scheduler, int selectors)

    • doStart

      protected void doStart() throws Exception
      Description copied from class: ContainerLifeCycle
      Starts the managed lifecycle beans in the order they were added.
      Overrides:
      doStart in class AbstractNetworkConnector
      Throws:
      AbstractLifeCycle.StopException - If thrown, the lifecycle will immediately be stopped.
      Exception - If there was a problem starting. Will cause a transition to FAILED state

    • doStop

      protected void doStop() throws Exception
      Description copied from class: ContainerLifeCycle
      Stops the managed lifecycle beans in the reverse order they were added.
      Overrides:
      doStop in class AbstractNetworkConnector
      Throws:
      Exception - If there was a problem stopping. Will cause a transition to FAILED state

    • isOpen

      public boolean isOpen()
      Description copied from interface: NetworkConnector
      A Connector may be opened and not started (to reserve a port) or closed and running (to allow graceful shutdown of existing connections)
      Returns:
      True if the connector is Open.

    • isInheritChannel

      public boolean isInheritChannel()
      Returns:
      whether this connector uses a channel inherited from the JVM.
      See Also:

    • setInheritChannel

      public void setInheritChannel(boolean inheritChannel)

      Sets whether this connector uses a channel inherited from the JVM.

      If true, the connector first tries to inherit from a channel provided by the system. If there is no inherited channel available, or if the inherited channel is not usable, then it will fall back using ServerSocketChannel.

      Use it with xinetd/inetd, to launch an instance of Jetty on demand. The port used to access pages on the Jetty instance is the same as the port used to launch Jetty.

      Parameters:
      inheritChannel - whether this connector uses a channel inherited from the JVM.
      See Also:

    • open

      public void open(ServerSocketChannel acceptChannel) throws IOException
      Open the connector using the passed ServerSocketChannel. This open method can be called before starting the connector to pass it a ServerSocketChannel that will be used instead of one returned from openAcceptChannel()
      Parameters:
      acceptChannel - the channel to use
      Throws:
      IOException - if the server channel is not bound

    • open

      public void open() throws IOException
      Description copied from interface: NetworkConnector

      Performs the activities needed to open the network communication (for example, to start accepting incoming network connections).

      Specified by:
      open in interface NetworkConnector
      Overrides:
      open in class AbstractNetworkConnector
      Throws:
      IOException - if this connector cannot be opened
      See Also:

    • openAcceptChannel

      protected ServerSocketChannel openAcceptChannel() throws IOException
      Called by open() to obtain the accepting channel.
      Returns:
      ServerSocketChannel used to accept connections.
      Throws:
      IOException - if unable to obtain or configure the server channel

    • close

      public void close()
      Description copied from interface: NetworkConnector

      Performs the activities needed to close the network communication (for example, to stop accepting network connections).

      Once a connector has been closed, it cannot be opened again without first calling LifeCycle.stop() and it will not be active again until a subsequent call to LifeCycle.start()
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Specified by:
      close in interface NetworkConnector
      Overrides:
      close in class AbstractNetworkConnector

    • accept

      public void accept(int acceptorID) throws IOException
      Specified by:
      accept in class AbstractConnector
      Throws:
      IOException

    • getSelectorManager

      @ManagedAttribute("The Selector Manager") public SelectorManager getSelectorManager()

    • getTransport

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

    • getLocalPort

      @ManagedAttribute("local port") public int getLocalPort()
      Specified by:
      getLocalPort in interface NetworkConnector
      Overrides:
      getLocalPort in class AbstractNetworkConnector
      Returns:
      The actual port the connector is listening on, or -1 if it has not been opened, or -2 if it has been closed.

    • newEndPoint

      protected SocketChannelEndPoint newEndPoint(SocketChannel channel, ManagedSelector selectSet, SelectionKey key) throws IOException
      Throws:
      IOException

    • getAcceptQueueSize

      @ManagedAttribute("Accept Queue size") public int getAcceptQueueSize()
      Returns:
      the accept queue size

    • setAcceptQueueSize

      public void setAcceptQueueSize(int acceptQueueSize)
      Parameters:
      acceptQueueSize - the accept queue size (also known as accept backlog)

    • getReuseAddress

      @ManagedAttribute("Server Socket SO_REUSEADDR") public boolean getReuseAddress()
      Returns:
      whether rebinding the server socket is allowed with sockets in tear-down states
      See Also:

    • setReuseAddress

      public void setReuseAddress(boolean reuseAddress)
      Parameters:
      reuseAddress - whether rebinding the server socket is allowed with sockets in tear-down states
      See Also:

    • isReusePort

      @ManagedAttribute("Server Socket SO_REUSEPORT") public boolean isReusePort()
      Returns:
      whether it is allowed to bind multiple server sockets to the same host and port

    • setReusePort

      public void setReusePort(boolean reusePort)
      Parameters:
      reusePort - whether it is allowed to bind multiple server sockets to the same host and port

    • getAcceptedTcpNoDelay

      @ManagedAttribute("Accepted Socket TCP_NODELAY") public boolean getAcceptedTcpNoDelay()
      Returns:
      whether the accepted socket gets TCP_NODELAY enabled.
      See Also:

    • setAcceptedTcpNoDelay

      public void setAcceptedTcpNoDelay(boolean tcpNoDelay)
      Parameters:
      tcpNoDelay - whether TCP_NODELAY gets enabled on the the accepted socket.
      See Also:

    • getAcceptedReceiveBufferSize

      @ManagedAttribute("Accepted Socket SO_RCVBUF") public int getAcceptedReceiveBufferSize()
      Returns:
      the SO_RCVBUF size to set onto the accepted socket. A value of -1 indicates that it is left to its default value.
      See Also:

    • setAcceptedReceiveBufferSize

      public void setAcceptedReceiveBufferSize(int receiveBufferSize)
      Parameters:
      receiveBufferSize - the SO_RCVBUF size to set onto the accepted socket. A value of -1 indicates that it is left to its default value.
      See Also:

    • getAcceptedSendBufferSize

      @ManagedAttribute("Accepted Socket SO_SNDBUF") public int getAcceptedSendBufferSize()
      Returns:
      the SO_SNDBUF size to set onto the accepted socket. A value of -1 indicates that it is left to its default value.
      See Also:

    • setAcceptedSendBufferSize

      public void setAcceptedSendBufferSize(int sendBufferSize)
      Parameters:
      sendBufferSize - the SO_SNDBUF size to set onto the accepted socket. A value of -1 indicates that it is left to its default value.
      See Also:

    • setAccepting

      public void setAccepting(boolean accepting)
      Overrides:
      setAccepting in class AbstractConnector