Package org.eclipse.jetty.io

Class SelectorManager

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.io.SelectorManager

All Implemented Interfaces:

Container, Destroyable, Dumpable, Dumpable.DumpableContainer, LifeCycle

Direct Known Subclasses:

ClientConnector.ClientSelectorManager, ConnectHandler.ConnectManager, ServerConnector.ServerConnectorManager, UnixDomainServerConnector.UnixDomainSelectorManager

@ManagedObject("Manager of the NIO Selectors")
public abstract class SelectorManager
extends ContainerLifeCycle
implements Dumpable

SelectorManager manages a number of ManagedSelectors that simplify the non-blocking primitives provided by the JVM via the java.nio package.

SelectorManager subclasses implement methods to return protocol-specific EndPoints and Connections.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SelectorManager.AcceptListener	A listener for accept events.
static interface	SelectorManager.SelectorManagerListener

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

AbstractLifeCycle.AbstractLifeCycleListener, AbstractLifeCycle.StopException

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.Dumpable

Dumpable.DumpableContainer

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

LifeCycle.Listener

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_CONNECT_TIMEOUT

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

FAILED, STARTED, STARTING, STOPPED, STOPPING

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

KEY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SelectorManager(Executor executor, Scheduler scheduler)
protected	SelectorManager(Executor executor, Scheduler scheduler, int selectors)

Method Summary

Modifier and Type	Method	Description
void	accept(SelectableChannel channel)
void	accept(SelectableChannel channel, Object attachment)	Registers a channel to perform non-blocking read/write operations.
protected void	accepted(SelectableChannel channel)	Callback method when a channel is accepted from the ServerSocketChannel passed to acceptor(SelectableChannel).
Closeable	acceptor(SelectableChannel server)	Registers a server channel for accept operations.
boolean	addEventListener(EventListener listener)	Add an event listener.
protected ManagedSelector	chooseSelector()
void	connect(SelectableChannel channel, Object attachment)	Registers a channel to perform a non-blocking connect.
void	connectionClosed(Connection connection, Throwable cause)	Callback method invoked when a connection is closed.
protected void	connectionFailed(SelectableChannel channel, Throwable ex, Object attachment)	Callback method invoked when a non-blocking connect cannot be completed.
void	connectionOpened(Connection connection, Object context)	Callback method invoked when a connection is opened.
protected SelectableChannel	doAccept(SelectableChannel server)
protected boolean	doFinishConnect(SelectableChannel channel)
protected void	doStart()	Starts the managed lifecycle beans in the order they were added.
protected void	doStop()	Stops the managed lifecycle beans in the reverse order they were added.
protected void	endPointClosed(EndPoint endpoint)	Callback method invoked when an endpoint is closed.
protected void	endPointOpened(EndPoint endpoint)	Callback method invoked when an endpoint is opened.
protected void	execute(Runnable task)	Executes the given task in a different thread.
long	getConnectTimeout()	Get the connect timeout
Executor	getExecutor()
Scheduler	getScheduler()
int	getSelectorCount()
int	getTotalKeys()	Get total number of keys from each selector.
protected boolean	isConnectionPending(SelectableChannel channel)
abstract Connection	newConnection(SelectableChannel channel, EndPoint endpoint, Object attachment)	Factory method to create Connection.
protected abstract EndPoint	newEndPoint(SelectableChannel channel, ManagedSelector selector, SelectionKey selectionKey)	Factory method to create EndPoint.
protected Selector	newSelector()
protected ManagedSelector	newSelector(int id)	Factory method for ManagedSelector.
protected void	onAccepted(SelectableChannel channel)
protected void	onAcceptFailed(SelectableChannel channel, Throwable cause)
protected void	onAccepting(SelectableChannel channel)
boolean	removeEventListener(EventListener listener)	Remove an event listener.
void	setConnectTimeout(long milliseconds)	Set the connect timeout (in milliseconds)
String	toString()

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

addBean, addBean, addManaged, contains, destroy, dump, dump, dump, dumpObjects, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, installBean, installBean, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, setBeans, start, stop, unmanage, updateBean, updateBean, updateBeans, updateBeans

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

getEventListeners, getState, getState, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, setEventListeners, 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

getCachedBeans, getEventListeners

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

dump, dump, dumpSelf

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

isDumpable

Field Details

DEFAULT_CONNECT_TIMEOUT

public static final int DEFAULT_CONNECT_TIMEOUT

See Also:

• Constant Field Values

Constructor Details

SelectorManager

protected SelectorManager(Executor executor,
 Scheduler scheduler)

SelectorManager

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

Parameters:

executor - The executor to use for handling selected EndPoints

scheduler - The scheduler to use for timing events

selectors - The number of selectors to use, or -1 for a default derived from a heuristic over available CPUs and thread pool size.

Method Details

getExecutor

@ManagedAttribute("The Executor")
public Executor getExecutor()

getScheduler

@ManagedAttribute("The Scheduler")
public Scheduler getScheduler()

getConnectTimeout

@ManagedAttribute("The Connection timeout (ms)")
public long getConnectTimeout()

Get the connect timeout

Returns:

the connect timeout (in milliseconds)

setConnectTimeout

public void setConnectTimeout(long milliseconds)

Set the connect timeout (in milliseconds)

Parameters:

milliseconds - the number of milliseconds for the timeout

execute

protected void execute(Runnable task)

Executes the given task in a different thread.

Parameters:

task - the task to execute

getTotalKeys

@ManagedAttribute(value="Total number of keys in all selectors",
                  readonly=true)
public int getTotalKeys()

Get total number of keys from each selector.

Returns:

total number of selector keys

getSelectorCount

@ManagedAttribute("The number of NIO Selectors")
public int getSelectorCount()

Returns:

the number of selectors in use

chooseSelector

protected ManagedSelector chooseSelector()

connect

public void connect(SelectableChannel channel,
 Object attachment)

Registers a channel to perform a non-blocking connect.

The channel must be set in non-blocking mode, SocketChannel.connect(SocketAddress) must be called prior to calling this method, and the connect operation must not be completed (the return value of SocketChannel.connect(SocketAddress) must be false).

Parameters:

channel - the channel to register

attachment - the attachment object

See Also:

• accept(SelectableChannel, Object)

accept

public void accept(SelectableChannel channel)

Parameters:

channel - the channel to accept

See Also:

• accept(SelectableChannel, Object)

accept

public void accept(SelectableChannel channel,
 Object attachment)

Registers a channel to perform non-blocking read/write operations.

This method is called just after a channel has been accepted by ServerSocketChannel.accept(), or just after having performed a blocking connect via Socket.connect(SocketAddress, int), or just after a non-blocking connect via SocketChannel.connect(SocketAddress) that completed successfully.

Parameters:

channel - the channel to register

attachment - the attachment object

acceptor

public Closeable acceptor(SelectableChannel server)

Registers a server channel for accept operations. When a SocketChannel is accepted from the given ServerSocketChannel then the accepted(SelectableChannel) method is called, which must be overridden by a derivation of this class to handle the accepted channel

Parameters:

server - the server channel to register

Returns:

A Closable that allows the acceptor to be cancelled

accepted

protected void accepted(SelectableChannel channel)
                 throws IOException

Callback method when a channel is accepted from the ServerSocketChannel passed to acceptor(SelectableChannel). The default impl throws an UnsupportedOperationException, so it must be overridden by subclasses if a server channel is provided.

Parameters:

channel - the

Throws:

IOException - if unable to accept channel

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 ContainerLifeCycle

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

newSelector

protected ManagedSelector newSelector(int id)

Factory method for ManagedSelector.

Parameters:

id - an identifier for the to create

Returns:

a new ManagedSelector

newSelector

protected Selector newSelector()
                        throws IOException

Throws:

IOException

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 ContainerLifeCycle

Throws:

Exception - If there was a problem stopping. Will cause a transition to FAILED state

endPointOpened

protected void endPointOpened(EndPoint endpoint)

Callback method invoked when an endpoint is opened.

Parameters:

endpoint - the endpoint being opened

endPointClosed

protected void endPointClosed(EndPoint endpoint)

Callback method invoked when an endpoint is closed.

Parameters:

endpoint - the endpoint being closed

connectionOpened

public void connectionOpened(Connection connection,
 Object context)

Callback method invoked when a connection is opened.

Parameters:

connection - the connection just opened

context - the attachment associated with the creation of the connection

See Also:

• newConnection(SelectableChannel, EndPoint, Object)

connectionClosed

public void connectionClosed(Connection connection,
 Throwable cause)

Callback method invoked when a connection is closed.

Parameters:

connection - the connection just closed

cause - the cause of the close or null for normal close

doFinishConnect

protected boolean doFinishConnect(SelectableChannel channel)
                           throws IOException

Throws:

IOException

isConnectionPending

protected boolean isConnectionPending(SelectableChannel channel)

doAccept

protected SelectableChannel doAccept(SelectableChannel server)
                              throws IOException

Throws:

IOException

connectionFailed

protected void connectionFailed(SelectableChannel channel,
 Throwable ex,
 Object attachment)

Callback method invoked when a non-blocking connect cannot be completed.

By default it just logs with level warning.

Parameters:

channel - the channel that attempted the connect

ex - the exception that caused the connect to fail

attachment - the attachment object associated at registration

newEndPoint

protected abstract EndPoint newEndPoint(SelectableChannel channel,
 ManagedSelector selector,
 SelectionKey selectionKey)
                                 throws IOException

Factory method to create EndPoint.

This method is invoked as a result of the registration of a channel via connect(SelectableChannel, Object) or accept(SelectableChannel).

Parameters:

channel - the channel associated to the endpoint

selector - the selector the channel is registered to

selectionKey - the selection key

Returns:

a new endpoint

Throws:

IOException - if the endPoint cannot be created

See Also:

• newConnection(SelectableChannel, EndPoint, Object)

newConnection

public abstract Connection newConnection(SelectableChannel channel,
 EndPoint endpoint,
 Object attachment)
                                  throws IOException

Factory method to create Connection.

Parameters:

channel - the channel associated to the connection

endpoint - the endpoint

attachment - the attachment

Returns:

a new connection

Throws:

IOException - if unable to create new connection

addEventListener

public boolean addEventListener(EventListener listener)

Description copied from interface: Container

Add an event listener. EventListeners added by this method are also added as beans.

Specified by:

addEventListener in interface Container

Specified by:

addEventListener in interface LifeCycle

Overrides:

addEventListener in class ContainerLifeCycle

Parameters:

listener - An EventListener

Returns:

true if the listener was added

See Also:

• SelectorManager.AcceptListener
• Container.addEventListener(EventListener)

removeEventListener

public boolean removeEventListener(EventListener listener)

Description copied from interface: Container

Remove an event listener.

Specified by:

removeEventListener in interface Container

Specified by:

removeEventListener in interface LifeCycle

Overrides:

removeEventListener in class ContainerLifeCycle

Parameters:

listener - the listener to remove

Returns:

true if the listener was removed

See Also:

• Container.removeBean(Object)

onAccepting

protected void onAccepting(SelectableChannel channel)

onAcceptFailed

protected void onAcceptFailed(SelectableChannel channel,
 Throwable cause)

onAccepted

protected void onAccepted(SelectableChannel channel)

toString

public String toString()

Overrides:

toString in class AbstractLifeCycle