Package org.eclipse.jetty.unixsocket

Class UnixSocketConnector

  • All Implemented Interfaces:
    org.eclipse.jetty.server.Connector, org.eclipse.jetty.util.component.Container, org.eclipse.jetty.util.component.Destroyable, org.eclipse.jetty.util.component.Dumpable, org.eclipse.jetty.util.component.Graceful, org.eclipse.jetty.util.component.LifeCycle
    @ManagedObject("Connector using UNIX Socket")
public class UnixSocketConnector
extends org.eclipse.jetty.server.AbstractConnector

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      protected class  UnixSocketConnector.UnixSocketConnectorManager  

      • Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

        org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener

      • Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container

        org.eclipse.jetty.util.component.Container.InheritedListener, org.eclipse.jetty.util.component.Container.Listener

      • Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Graceful

        org.eclipse.jetty.util.component.Graceful.Shutdown

      • Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

        org.eclipse.jetty.util.component.LifeCycle.Listener

    • Field Summary

      • Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

        FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

      • Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

        KEY

    • Constructor Summary

      Constructors 
      Constructor Description
      UnixSocketConnector​(org.eclipse.jetty.server.Server server)
      HTTP Server Connection.
      UnixSocketConnector​(org.eclipse.jetty.server.Server server, int selectors)
      HTTP Server Connection.
      UnixSocketConnector​(org.eclipse.jetty.server.Server server, int selectors, org.eclipse.jetty.server.ConnectionFactory... factories)
      HTTP Server Connection.
      UnixSocketConnector​(org.eclipse.jetty.server.Server server, int selectors, org.eclipse.jetty.util.ssl.SslContextFactory sslContextFactory)
      HTTP Server Connection.
      UnixSocketConnector​(org.eclipse.jetty.server.Server server, java.util.concurrent.Executor executor, org.eclipse.jetty.util.thread.Scheduler scheduler, org.eclipse.jetty.io.ByteBufferPool bufferPool, int selectors, org.eclipse.jetty.server.ConnectionFactory... factories)
      Generic Server Connection.
      UnixSocketConnector​(org.eclipse.jetty.server.Server server, org.eclipse.jetty.server.ConnectionFactory... factories)
      Generic Server Connection with default configuration.
      UnixSocketConnector​(org.eclipse.jetty.server.Server server, org.eclipse.jetty.util.ssl.SslContextFactory sslContextFactory)
      HTTP Server Connection.
      UnixSocketConnector​(org.eclipse.jetty.server.Server server, org.eclipse.jetty.util.ssl.SslContextFactory sslContextFactory, org.eclipse.jetty.server.ConnectionFactory... factories)
      Generic SSL Server Connection.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void accept​(int acceptorID)  
      protected void accepted​(jnr.unixsocket.UnixSocketChannel channel)  
      void close()  
      protected void doStart()  
      protected void doStop()  
      int getAcceptQueueSize()  
      boolean getReuseAddress()  
      org.eclipse.jetty.io.SelectorManager getSelectorManager()  
      java.lang.Object getTransport()  
      java.lang.String getUnixSocket()  
      boolean isOpen()  
      protected UnixSocketEndPoint newEndPoint​(java.nio.channels.SelectableChannel channel, org.eclipse.jetty.io.ManagedSelector selector, java.nio.channels.SelectionKey key)  
      protected org.eclipse.jetty.io.SelectorManager newSelectorManager​(java.util.concurrent.Executor executor, org.eclipse.jetty.util.thread.Scheduler scheduler, int selectors)  
      void open()  
      void setAcceptQueueSize​(int acceptQueueSize)  
      void setReuseAddress​(boolean reuseAddress)  
      void setUnixSocket​(java.lang.String filename)  
      java.util.concurrent.Future<java.lang.Void> shutdown()  
      java.lang.String toString()  

      • Methods inherited from class org.eclipse.jetty.server.AbstractConnector

        addConnectionFactory, addFirstConnectionFactory, addIfAbsentConnectionFactory, clearConnectionFactories, getAcceptorPriorityDelta, getAcceptors, getByteBufferPool, getConnectedEndPoints, getConnectionFactories, getConnectionFactory, getConnectionFactory, getDefaultConnectionFactory, getDefaultProtocol, getExecutor, getIdleTimeout, getName, getProtocols, getScheduler, getServer, handleAcceptFailure, interruptAcceptors, isAccepting, isShutdown, join, join, onEndPointClosed, onEndPointOpened, removeConnectionFactory, setAccepting, setAcceptorPriorityDelta, setConnectionFactories, setDefaultProtocol, setIdleTimeout, setName

      • Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle

        addBean, addBean, addBean, addEventListener, addManaged, contains, destroy, dump, dump, dump, dump, dump, dumpBeans, dumpObject, dumpObjects, dumpStdErr, dumpThis, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, updateBean, updateBean, updateBeans

      • Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

        addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface org.eclipse.jetty.util.component.Container

        addBean, addBean, addEventListener, getBean, getBeans, getBeans, getContainedBeans, isManaged, manage, removeBean, removeEventListener, unmanage

      • Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

        dump, dump, dumpSelf

      • Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle

        addLifeCycleListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop

    • Constructor Detail

      • UnixSocketConnector

        public UnixSocketConnector​(@Name("server")
                           org.eclipse.jetty.server.Server server)
        HTTP Server Connection.

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

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

      • UnixSocketConnector

        public UnixSocketConnector​(@Name("server")
                           org.eclipse.jetty.server.Server server,
                           @Name("selectors")
                           int selectors)
        HTTP Server Connection.

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

        Parameters:
        server - The Server this connector will accept connection for.
        selectors - the number of selector threads, or <=0 for a default value. Selectors notice and schedule established connection that can make IO progress.

      • UnixSocketConnector

        public UnixSocketConnector​(@Name("server")
                           org.eclipse.jetty.server.Server server,
                           @Name("selectors")
                           int selectors,
                           @Name("factories")
                           org.eclipse.jetty.server.ConnectionFactory... factories)
        HTTP Server Connection.

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

        Parameters:
        server - The Server this connector will accept connection for.
        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.

      • UnixSocketConnector

        public UnixSocketConnector​(@Name("server")
                           org.eclipse.jetty.server.Server server,
                           @Name("factories")
                           org.eclipse.jetty.server.ConnectionFactory... factories)
        Generic Server Connection with default configuration.

        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.

      • UnixSocketConnector

        public UnixSocketConnector​(@Name("server")
                           org.eclipse.jetty.server.Server server,
                           @Name("sslContextFactory")
                           org.eclipse.jetty.util.ssl.SslContextFactory sslContextFactory)
        HTTP Server Connection.

        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.

      • UnixSocketConnector

        public UnixSocketConnector​(@Name("server")
                           org.eclipse.jetty.server.Server server,
                           @Name("selectors")
                           int selectors,
                           @Name("sslContextFactory")
                           org.eclipse.jetty.util.ssl.SslContextFactory sslContextFactory)
        HTTP Server Connection.

        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.
        selectors - the number of selector threads, or <=0 for a default value. Selectors notice and schedule established connection that can make IO progress.

      • UnixSocketConnector

        public UnixSocketConnector​(@Name("server")
                           org.eclipse.jetty.server.Server server,
                           @Name("sslContextFactory")
                           org.eclipse.jetty.util.ssl.SslContextFactory sslContextFactory,
                           @Name("factories")
                           org.eclipse.jetty.server.ConnectionFactory... factories)
        Generic SSL Server Connection.
        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.

      • UnixSocketConnector

        public UnixSocketConnector​(@Name("server")
                           org.eclipse.jetty.server.Server server,
                           @Name("executor")
                           java.util.concurrent.Executor executor,
                           @Name("scheduler")
                           org.eclipse.jetty.util.thread.Scheduler scheduler,
                           @Name("bufferPool")
                           org.eclipse.jetty.io.ByteBufferPool bufferPool,
                           @Name("selectors")
                           int selectors,
                           @Name("factories")
                           org.eclipse.jetty.server.ConnectionFactory... factories)
        Generic Server Connection.
        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.
        selectors - the number of selector threads, or <=0 for a default value(1). Selectors notice and schedule established connection that can make IO progress.
        factories - Zero or more ConnectionFactory instances used to create and configure connections.

    • Method Detail

      • getUnixSocket

        @ManagedAttribute
public java.lang.String getUnixSocket()

      • setUnixSocket

        public void setUnixSocket​(java.lang.String filename)

      • newSelectorManager

        protected org.eclipse.jetty.io.SelectorManager newSelectorManager​(java.util.concurrent.Executor executor,
                                                                  org.eclipse.jetty.util.thread.Scheduler scheduler,
                                                                  int selectors)

      • doStart

        protected void doStart()
                throws java.lang.Exception
        Overrides:
        doStart in class org.eclipse.jetty.server.AbstractConnector
        Throws:
        java.lang.Exception

      • doStop

        protected void doStop()
               throws java.lang.Exception
        Overrides:
        doStop in class org.eclipse.jetty.server.AbstractConnector
        Throws:
        java.lang.Exception

      • isOpen

        public boolean isOpen()

      • open

        public void open()
          throws java.io.IOException
        Throws:
        java.io.IOException

      • shutdown

        public java.util.concurrent.Future<java.lang.Void> shutdown()
        Specified by:
        shutdown in interface org.eclipse.jetty.util.component.Graceful
        Overrides:
        shutdown in class org.eclipse.jetty.server.AbstractConnector

      • close

        public void close()

      • accept

        public void accept​(int acceptorID)
            throws java.io.IOException
        Specified by:
        accept in class org.eclipse.jetty.server.AbstractConnector
        Throws:
        java.io.IOException

      • accepted

        protected void accepted​(jnr.unixsocket.UnixSocketChannel channel)
                 throws java.io.IOException
        Throws:
        java.io.IOException

      • getSelectorManager

        public org.eclipse.jetty.io.SelectorManager getSelectorManager()

      • getTransport

        public java.lang.Object getTransport()

      • newEndPoint

        protected UnixSocketEndPoint newEndPoint​(java.nio.channels.SelectableChannel channel,
                                         org.eclipse.jetty.io.ManagedSelector selector,
                                         java.nio.channels.SelectionKey key)
                                  throws java.io.IOException
        Throws:
        java.io.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

        public boolean getReuseAddress()
        Returns:
        whether the server socket reuses addresses
        See Also:
        ServerSocket.getReuseAddress()

      • setReuseAddress

        public void setReuseAddress​(boolean reuseAddress)
        Parameters:
        reuseAddress - whether the server socket reuses addresses
        See Also:
        ServerSocket.setReuseAddress(boolean)

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class org.eclipse.jetty.server.AbstractConnector