org.eclipse.jetty.io

Class SelectorManager

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.io.SelectorManager

All Implemented Interfaces:

Dumpable, LifeCycle

public abstract class SelectorManager
extends AbstractLifeCycle
implements Dumpable

SelectorManager manages a number of SelectorManager.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 and Description
class	SelectorManager.ManagedSelector SelectorManager.ManagedSelector wraps a Selector simplifying non-blocking operations on channels.
static interface	SelectorManager.SelectableEndPoint A SelectorManager.SelectableEndPoint is an EndPoint that wish to be notified of non-blocking events by the SelectorManager.ManagedSelector.

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

LifeCycle.Listener

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CONNECT_TIMEOUT
protected static Logger	LOG

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

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(SocketChannel channel)
void	accept(SocketChannel channel, Object attachment) Registers a channel to perform non-blocking read/write operations.
protected void	accepted(SocketChannel channel) Callback method when a channel is accepted from the ServerSocketChannel passed to acceptor(ServerSocketChannel).
void	acceptor(ServerSocketChannel server) Registers a server channel for accept operations.
void	connect(SocketChannel channel, Object attachment) Registers a channel to perform a non-blocking connect.
void	connectionClosed(Connection connection) Callback method invoked when a connection is closed.
protected void	connectionFailed(SocketChannel channel, Throwable ex, Object attachment) Callback method invoked when a non-blocking connect cannot be completed.
void	connectionOpened(Connection connection) Callback method invoked when a connection is opened.
protected void	doStart()
protected void	doStop()
String	dump()
void	dump(Appendable out, String indent)
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.
protected boolean	finishConnect(SocketChannel channel)
long	getConnectTimeout() Get the connect timeout
Executor	getExecutor()
Scheduler	getScheduler()
int	getSelectorCount()
int	getSelectorPriorityDelta()
boolean	isSubmitKeyUpdates()
abstract Connection	newConnection(SocketChannel channel, EndPoint endpoint, Object attachment) Factory method to create Connection.
protected abstract EndPoint	newEndPoint(SocketChannel channel, SelectorManager.ManagedSelector selector, SelectionKey selectionKey) Factory method to create EndPoint.
protected SelectorManager.ManagedSelector	newSelector(int id) Factory method for SelectorManager.ManagedSelector.
void	setConnectTimeout(long milliseconds) Set the connect timeout (in milliseconds)
void	setSelectorPriorityDelta(int selectorPriorityDelta) Sets the selector thread priority delta to the given amount.
void	setSubmitKeyUpdates(boolean submitKeyUpdates) Controls whether SelectionKey updates should be submitted for execution in the selector thread, or directly executed by the updating thread.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONNECT_TIMEOUT

public static final int DEFAULT_CONNECT_TIMEOUT

See Also:

Constant Field Values

LOG

protected static final Logger LOG

Constructor Detail

SelectorManager

protected SelectorManager(Executor executor,
               Scheduler scheduler)

SelectorManager

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

Method Detail

getExecutor

public Executor getExecutor()

getScheduler

public Scheduler getScheduler()

getConnectTimeout

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

getSelectorPriorityDelta

@ManagedAttribute(value="The priority delta to apply to selector threads")
public int getSelectorPriorityDelta()

setSelectorPriorityDelta

public void setSelectorPriorityDelta(int selectorPriorityDelta)

Sets the selector thread priority delta to the given amount.

This allows the selector threads to run at a different priority. Typically this would be used to lower the priority to give preference to handling previously accepted connections rather than accepting new connections.

Parameters:

selectorPriorityDelta - the amount to change the thread priority delta to (may be negative)

See Also:

Thread.getPriority()

isSubmitKeyUpdates

public boolean isSubmitKeyUpdates()

Returns:

whether updates to SelectionKeys are submitted to the selector thread or executed by the updater.

See Also:

setSubmitKeyUpdates(boolean)

setSubmitKeyUpdates

public void setSubmitKeyUpdates(boolean submitKeyUpdates)

Controls whether SelectionKey updates should be submitted for execution in the selector thread, or directly executed by the updating thread. Submission incur is possible queueing and wakeup of the selector, while direct execution incurs in lock contention in JDK classes.

Parameters:

submitKeyUpdates - whether updates to SelectionKeys are submitted to the selector thread or executed by the updater.

See Also:

SelectorManager.ManagedSelector.updateKey(Runnable)

execute

protected void execute(Runnable task)

Executes the given task in a different thread.

Parameters:

task - the task to execute

getSelectorCount

public int getSelectorCount()

Returns:

the number of selectors in use

connect

public void connect(SocketChannel 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(SocketChannel, Object)

accept

public void accept(SocketChannel channel)

See Also:

accept(SocketChannel, Object)

accept

public void accept(SocketChannel 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 void acceptor(ServerSocketChannel server)

Registers a server channel for accept operations. When a SocketChannel is accepted from the given ServerSocketChannel then the accepted(SocketChannel) 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

accepted

protected void accepted(SocketChannel channel)
                 throws IOException

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

Parameters:

channel - the

Throws:

IOException

doStart

protected void doStart()
                throws Exception

Overrides:

doStart in class AbstractLifeCycle

Throws:

Exception

newSelector

protected SelectorManager.ManagedSelector newSelector(int id)

Factory method for SelectorManager.ManagedSelector.

Parameters:

id - an identifier for the to create

Returns:

a new SelectorManager.ManagedSelector

doStop

protected void doStop()
               throws Exception

Overrides:

doStop in class AbstractLifeCycle

Throws:

Exception

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)

Callback method invoked when a connection is opened.

Parameters:

connection - the connection just opened

connectionClosed

public void connectionClosed(Connection connection)

Callback method invoked when a connection is closed.

Parameters:

connection - the connection just closed

finishConnect

protected boolean finishConnect(SocketChannel channel)
                         throws IOException

Throws:

IOException

connectionFailed

protected void connectionFailed(SocketChannel 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(SocketChannel channel,
                   SelectorManager.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(SocketChannel, Object) or accept(SocketChannel).

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(SocketChannel, EndPoint, Object)

newConnection

public abstract Connection newConnection(SocketChannel 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

See Also:

newEndPoint(SocketChannel, ManagedSelector, SelectionKey)

dump

public String dump()

Specified by:

dump in interface Dumpable

dump

public void dump(Appendable out,
        String indent)
          throws IOException

Specified by:

dump in interface Dumpable

Throws:

IOException