Package org.eclipse.jetty.unixsocket

Class UnixSocketConnector

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.server.AbstractConnector

org.eclipse.jetty.unixsocket.UnixSocketConnector

All Implemented Interfaces:

Connector, Container, Destroyable, Dumpable, Graceful, LifeCycle

@ManagedObject("HTTP connector using NIO ByteChannels and Selectors")
public class UnixSocketConnector
extends 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

AbstractLifeCycle.AbstractLifeCycleListener

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

Container.InheritedListener, Container.Listener

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

LifeCycle.Listener

Field Summary

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

FAILED, RUNNING, STARTED, STARTING, STOP_ON_FAILURE, STOPPED, STOPPING

Constructor Summary

Constructors

Constructor	Description
UnixSocketConnector(Server server)	HTTP Server Connection.
UnixSocketConnector(Server server, int selectors)	HTTP Server Connection.
UnixSocketConnector(Server server, int selectors, ConnectionFactory... factories)	HTTP Server Connection.
UnixSocketConnector(Server server, int selectors, SslContextFactory sslContextFactory)	HTTP Server Connection.
UnixSocketConnector(Server server, java.util.concurrent.Executor executor, Scheduler scheduler, ByteBufferPool bufferPool, int selectors, ConnectionFactory... factories)	Generic Server Connection.
UnixSocketConnector(Server server, ConnectionFactory... factories)	Generic Server Connection with default configuration.
UnixSocketConnector(Server server, SslContextFactory sslContextFactory)	HTTP Server Connection.
UnixSocketConnector(Server server, SslContextFactory sslContextFactory, ConnectionFactory... factories)	Generic SSL Server Connection.

Method Summary

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()
SelectorManager	getSelectorManager()
java.lang.Object	getTransport()
java.lang.String	getUnixSocket()
boolean	isOpen()
protected UnixSocketEndPoint	newEndPoint(java.nio.channels.SelectableChannel channel, ManagedSelector selector, java.nio.channels.SelectionKey key)
protected SelectorManager	newSelectorManager(java.util.concurrent.Executor executor, 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, join, join, onEndPointClosed, onEndPointOpened, removeConnectionFactory, setAccepting, setAcceptorPriorityDelta, setConnectionFactories, setDefaultProtocol, setIdleTimeout, setName

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 interface org.eclipse.jetty.util.component.Container

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

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

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

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

dump, dump

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

UnixSocketConnector

public UnixSocketConnector(@Name("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")
                           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")
                           Server server,
                           @Name("selectors")
                           int selectors,
                           @Name("factories")
                           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")
                           Server server,
                           @Name("factories")
                           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")
                           Server server,
                           @Name("sslContextFactory")
                           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")
                           Server server,
                           @Name("selectors")
                           int selectors,
                           @Name("sslContextFactory")
                           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")
                           Server server,
                           @Name("sslContextFactory")
                           SslContextFactory sslContextFactory,
                           @Name("factories")
                           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")
                           Server server,
                           @Name("executor")
                           java.util.concurrent.Executor executor,
                           @Name("scheduler")
                           Scheduler scheduler,
                           @Name("bufferPool")
                           ByteBufferPool bufferPool,
                           @Name("selectors")
                           int selectors,
                           @Name("factories")
                           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 SelectorManager newSelectorManager(java.util.concurrent.Executor executor,
                                             Scheduler scheduler,
                                             int selectors)

doStart

protected void doStart()
                throws java.lang.Exception

Overrides:

doStart in class AbstractConnector

Throws:

java.lang.Exception

doStop

protected void doStop()
               throws java.lang.Exception

Overrides:

doStop in class 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 Graceful

Overrides:

shutdown in class AbstractConnector

close

public void close()

accept

public void accept(int acceptorID)
            throws java.io.IOException

Specified by:

accept in class AbstractConnector

Throws:

java.io.IOException

accepted

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

Throws:

java.io.IOException

getSelectorManager

public SelectorManager getSelectorManager()

getTransport

public java.lang.Object getTransport()

newEndPoint

protected UnixSocketEndPoint newEndPoint(java.nio.channels.SelectableChannel channel,
                                         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 AbstractConnector