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

@ManagedObject(value="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 and Description
static interface	SelectorManager.AcceptListener A listener for accept events.

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

Modifier and Type	Field and Description
static int	DEFAULT_CONNECT_TIMEOUT

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

Method Summary

Modifier and Type	Method and Description
void	accept(SelectableChannel channel)
void	accept(SelectableChannel channel, Object attachment) Registers a channel to perform non-blocking read/write operations.
Closeable	acceptor(SelectableChannel server) Registers a server channel for accept operations.
void	addAcceptListener(SelectorManager.AcceptListener listener)
void	addEventListener(EventListener listener)
void	connect(SelectableChannel channel, Object attachment) Registers a channel to perform a non-blocking connect.
void	connectionClosed(Connection connection) Callback method invoked when a connection is closed.
void	connectionOpened(Connection connection) Callback method invoked when a connection is opened.
long	getConnectTimeout() Get the connect timeout
Executor	getExecutor()
int	getReservedThreads() Deprecated.
Scheduler	getScheduler()
int	getSelectorCount()
abstract Connection	newConnection(SelectableChannel channel, EndPoint endpoint, Object attachment) Factory method to create Connection.
void	removeAcceptListener(SelectorManager.AcceptListener listener)
void	removeEventListener(EventListener listener)
void	setConnectTimeout(long milliseconds) Set the connect timeout (in milliseconds)
void	setReservedThreads(int threads) Deprecated.

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

addBean, addBean, addEventListener, addManaged, contains, destroy, dump, dump, dump, dump, dump, dumpObject, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, 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, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

dump, dump, dump, dumpContainer, dumpIterable, dumpMapEntries, dumpObject, dumpObjects, dumpSelf, named

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

start, stop

Field Detail

DEFAULT_CONNECT_TIMEOUT

public static final int DEFAULT_CONNECT_TIMEOUT

See Also:

Constant Field Values

Method Detail

getExecutor

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

getScheduler

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

getConnectTimeout

@ManagedAttribute(value="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

getReservedThreads

@Deprecated
public int getReservedThreads()

Deprecated.

Returns:

-1

setReservedThreads

@Deprecated
public void setReservedThreads(int threads)

Deprecated.

Parameters:

threads - ignored

getSelectorCount

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

Returns:

the number of selectors in use

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

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

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 void addEventListener(EventListener listener)

removeEventListener

public void removeEventListener(EventListener listener)

addAcceptListener

public void addAcceptListener(SelectorManager.AcceptListener listener)

removeAcceptListener

public void removeAcceptListener(SelectorManager.AcceptListener listener)