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

Modifier and Type	Field and Description
private final List<SelectorManager.AcceptListener>	_acceptListeners
private long	_connectTimeout
private ThreadPoolBudget.Lease	_lease
private final AtomicInteger	_selectorIndex
private final IntUnaryOperator	_selectorIndexUpdate
private final ManagedSelector[]	_selectors
public static final int	DEFAULT_CONNECT_TIMEOUT
private final Executor	executor
protected static final Logger	LOG Hides org.eclipse.jetty.util.component.ContainerLifeCycle.LOG.
private final Scheduler	scheduler

Access	Constructor and Description
protected	SelectorManager(Executor executor, Scheduler scheduler)
protected	SelectorManager(Executor The executor to use for handling selected `EndPoint`s executor, Scheduler The scheduler to use for timing events scheduler, int The number of selectors to use, or -1 for a default derived from a heuristic over available CPUs and thread pool size. selectors)

Method Summary

Modifier and Type	Method and Description
public void	accept(SelectableChannel the channel to accept channel)
public void	accept(SelectableChannel the channel to register channel, Object the attachment object attachment) Registers a channel to perform non-blocking read/write operations.
protected void	accepted(SelectableChannel the channel) Callback method when a channel is accepted from the `ServerSocketChannel` passed to `acceptor(SelectableChannel)`.
public Closeable	Returns: A Closable that allows the acceptor to be cancelled acceptor(SelectableChannel the server channel to register server) Registers a server channel for accept operations.
public boolean	addEventListener(EventListener An EventListener listener) Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.addEventListener. Implements org.eclipse.jetty.util.component.Container.addEventListener, org.eclipse.jetty.util.component.LifeCycle.addEventListener. Add an event listener.
protected ManagedSelector	chooseSelector()
public void	connect(SelectableChannel the channel to register channel, Object the attachment object attachment) Registers a channel to perform a non-blocking connect.
public void	connectionClosed(Connection the connection just closed connection, Throwable the cause of the close or null for normal close cause) Callback method invoked when a connection is closed.
protected void	connectionFailed(SelectableChannel the channel that attempted the connect channel, Throwable the exception that caused the connect to fail ex, Object the attachment object associated at registration attachment) Callback method invoked when a non-blocking connect cannot be completed.
public void	connectionOpened(Connection the connection just opened connection, Object the attachment associated with the creation of the connection context) Callback method invoked when a connection is opened.
private static int	defaultSelectors(Executor executor)
protected SelectableChannel	doAccept(SelectableChannel server)
protected boolean	doFinishConnect(SelectableChannel channel)
protected void	doStart() Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.doStart. Starts the managed lifecycle beans in the order they were added.
protected void	doStop() Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.doStop. Stops the managed lifecycle beans in the reverse order they were added.
protected void	endPointClosed(EndPoint the endpoint being closed endpoint) Callback method invoked when an endpoint is closed.
protected void	endPointOpened(EndPoint the endpoint being opened endpoint) Callback method invoked when an endpoint is opened.
protected void	execute(Runnable the task to execute task) Executes the given task in a different thread.
public long	Returns: the connect timeout (in milliseconds) getConnectTimeout() Get the connect timeout
public Executor	getExecutor()
public Scheduler	getScheduler()
public int	Returns: the number of selectors in use getSelectorCount()
public int	Returns: total number of selector keys getTotalKeys() Get total number of keys from each selector.
protected boolean	isConnectionPending(SelectableChannel channel)
public abstract Connection	Returns: a new connection newConnection(SelectableChannel the channel associated to the connection channel, EndPoint the endpoint endpoint, Object the attachment attachment) Factory method to create `Connection`.
protected abstract EndPoint	Returns: a new endpoint newEndPoint(SelectableChannel the channel associated to the endpoint channel, ManagedSelector the selector the channel is registered to selector, SelectionKey the selection key selectionKey) Factory method to create `EndPoint`.
protected ManagedSelector	Returns: a new `ManagedSelector` newSelector(int an identifier for the `to create` id) Factory method for `ManagedSelector`.
protected Selector	newSelector()
protected void	onAccepted(SelectableChannel channel)
protected void	onAcceptFailed(SelectableChannel channel, Throwable cause)
protected void	onAccepting(SelectableChannel channel)
public boolean	removeEventListener(EventListener the listener to remove listener) Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.removeEventListener. Implements org.eclipse.jetty.util.component.Container.removeEventListener, org.eclipse.jetty.util.component.LifeCycle.removeEventListener. Remove an event listener.
public void	setConnectTimeout(long the number of milliseconds for the timeout milliseconds) Set the connect timeout (in milliseconds)
public String	toString() Overrides org.eclipse.jetty.util.component.AbstractLifeCycle.toString. Returns a string representation of the object.

Field Detail

_acceptListeners	back to summary
private final List<SelectorManager.AcceptListener> _acceptListeners

_connectTimeout	back to summary
private long _connectTimeout

_lease	back to summary
private ThreadPoolBudget.Lease _lease

_selectorIndex	back to summary
private final AtomicInteger _selectorIndex

_selectorIndexUpdate	back to summary
private final IntUnaryOperator _selectorIndexUpdate

_selectors	back to summary
private final ManagedSelector[] _selectors

DEFAULT_CONNECT_TIMEOUT	back to summary
public static final int DEFAULT_CONNECT_TIMEOUT

executor	back to summary
private final Executor executor

LOG	back to summary
protected static final Logger LOG Hides org.eclipse.jetty.util.component.ContainerLifeCycle.LOG.

scheduler	back to summary
private final Scheduler scheduler

Constructor Detail

SelectorManager	back to summary
protected SelectorManager(Executor executor, Scheduler scheduler)

SelectorManager	back to summary
protected SelectorManager(Executor executor, Scheduler scheduler, int selectors) Parameters executor:Executor The executor to use for handling selected `EndPoint`s scheduler:Scheduler The scheduler to use for timing events selectors:int The number of selectors to use, or -1 for a default derived from a heuristic over available CPUs and thread pool size.

Method Detail

accept	back to summary
public void accept(SelectableChannel channel) Parameters channel:SelectableChannel the channel to accept See Also `accept(SelectableChannel, Object)`

accept back to summary

accept	back to summary
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:SelectableChannel the channel to register attachment:Object the attachment object

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:SelectableChannel: the channel to register
attachment:Object: the attachment object

accepted back to summary

accepted	back to summary
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:SelectableChannel the Exceptions IOException: if unable to accept channel

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:SelectableChannel: the

Exceptions

IOException:: if unable to accept channel

acceptor back to summary

acceptor	back to summary
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:SelectableChannel the server channel to register Returns:Closeable A Closable that allows the acceptor to be cancelled

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:SelectableChannel: the server channel to register

Returns:Closeable

A Closable that allows the acceptor to be cancelled

addEventListener back to summary

addEventListener	back to summary
public boolean addEventListener(EventListener listener) Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.addEventListener. Implements org.eclipse.jetty.util.component.Container.addEventListener, org.eclipse.jetty.util.component.LifeCycle.addEventListener. Doc from org.eclipse.jetty.util.component.Container.addEventListener. Add an event listener. EventListeners added by this method are also added as beans. Parameters listener:EventListener An EventListener Returns:boolean true if the listener was added Annotations @Override See Also `AcceptListener`, `Container#addEventListener(EventListener)`

public boolean addEventListener(EventListener listener)

Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.addEventListener.

Implements org.eclipse.jetty.util.component.Container.addEventListener, org.eclipse.jetty.util.component.LifeCycle.addEventListener.

Doc from org.eclipse.jetty.util.component.Container.addEventListener.

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

Parameters

listener:EventListener: An EventListener

Returns:boolean

true if the listener was added

Annotations

@Override

chooseSelector	back to summary
protected ManagedSelector chooseSelector()

connect back to summary

connect	back to summary
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:SelectableChannel the channel to register attachment:Object the attachment object See Also `accept(SelectableChannel, Object)`

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:SelectableChannel: the channel to register
attachment:Object: the attachment object

See Also

accept(SelectableChannel, Object)

connectionClosed	back to summary
public void connectionClosed(Connection connection, Throwable cause) Callback method invoked when a connection is closed. Parameters connection:Connection the connection just closed cause:Throwable the cause of the close or null for normal close

connectionClosed

back to summary

public void connectionClosed(Connection connection, Throwable cause)

Callback method invoked when a connection is closed.

Parameters

connection:Connection: the connection just closed
cause:Throwable: the cause of the close or null for normal close

connectionFailed	back to summary
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:SelectableChannel the channel that attempted the connect ex:Throwable the exception that caused the connect to fail attachment:Object the attachment object associated at registration

connectionFailed

back to summary

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:SelectableChannel: the channel that attempted the connect
ex:Throwable: the exception that caused the connect to fail
attachment:Object: the attachment object associated at registration

connectionOpened back to summary

connectionOpened	back to summary
public void connectionOpened(Connection connection, Object context) Callback method invoked when a connection is opened. Parameters connection:Connection the connection just opened context:Object the attachment associated with the creation of the connection See Also `newConnection(SelectableChannel, EndPoint, Object)`

public void connectionOpened(Connection connection, Object context)

Callback method invoked when a connection is opened.

Parameters

connection:Connection: the connection just opened
context:Object: the attachment associated with the creation of the connection

defaultSelectors	back to summary
private static int defaultSelectors(Executor executor)

doAccept	back to summary
protected SelectableChannel doAccept(SelectableChannel server) throws IOException

doFinishConnect	back to summary
protected boolean doFinishConnect(SelectableChannel channel) throws IOException

doStart	back to summary
protected void doStart() throws Exception Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.doStart. Doc from org.eclipse.jetty.util.component.ContainerLifeCycle.doStart. Starts the managed lifecycle beans in the order they were added. Annotations @Override Exceptions Exception: Doc from org.eclipse.jetty.util.component.AbstractLifeCycle.doStart. If there was a problem starting. Will cause a transition to FAILED state

doStart

back to summary

protected void doStart() throws Exception

Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.doStart.

Doc from org.eclipse.jetty.util.component.ContainerLifeCycle.doStart.

Starts the managed lifecycle beans in the order they were added.

Annotations

@Override

Exceptions

Exception:

Doc from org.eclipse.jetty.util.component.AbstractLifeCycle.doStart.

If there was a problem starting. Will cause a transition to FAILED state

doStop	back to summary
protected void doStop() throws Exception Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.doStop. Doc from org.eclipse.jetty.util.component.ContainerLifeCycle.doStop. Stops the managed lifecycle beans in the reverse order they were added. Annotations @Override Exceptions Exception: Doc from org.eclipse.jetty.util.component.AbstractLifeCycle.doStop. If there was a problem stopping. Will cause a transition to FAILED state

doStop

back to summary

protected void doStop() throws Exception

Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.doStop.

Doc from org.eclipse.jetty.util.component.ContainerLifeCycle.doStop.

Stops the managed lifecycle beans in the reverse order they were added.

Annotations

@Override

Exceptions

Exception:

Doc from org.eclipse.jetty.util.component.AbstractLifeCycle.doStop.

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

endPointClosed	back to summary
protected void endPointClosed(EndPoint endpoint) Callback method invoked when an endpoint is closed. Parameters endpoint:EndPoint the endpoint being closed

endPointClosed

back to summary

protected void endPointClosed(EndPoint endpoint)

Callback method invoked when an endpoint is closed.

Parameters

endpoint:EndPoint: the endpoint being closed

endPointOpened	back to summary
protected void endPointOpened(EndPoint endpoint) Callback method invoked when an endpoint is opened. Parameters endpoint:EndPoint the endpoint being opened

endPointOpened

back to summary

protected void endPointOpened(EndPoint endpoint)

Callback method invoked when an endpoint is opened.

Parameters

endpoint:EndPoint: the endpoint being opened

execute	back to summary
protected void execute(Runnable task) Executes the given task in a different thread. Parameters task:Runnable the task to execute

execute

back to summary

protected void execute(Runnable task)

Executes the given task in a different thread.

Parameters

task:Runnable: the task to execute

getConnectTimeout	back to summary
public long getConnectTimeout() Get the connect timeout Returns:long the connect timeout (in milliseconds) Annotations @ManagedAttribute:The Connection timeout (ms)

getConnectTimeout

back to summary

public long getConnectTimeout()

Get the connect timeout

Returns:long

the connect timeout (in milliseconds)

Annotations

@ManagedAttribute:The Connection timeout (ms)

getExecutor	back to summary
public Executor getExecutor() Annotations @ManagedAttribute:The Executor

getScheduler	back to summary
public Scheduler getScheduler() Annotations @ManagedAttribute:The Scheduler

getSelectorCount	back to summary
public int getSelectorCount() Returns:int the number of selectors in use Annotations @ManagedAttribute:The number of NIO Selectors

getTotalKeys	back to summary
public int getTotalKeys() Get total number of keys from each selector. Returns:int total number of selector keys Annotations @ManagedAttribute:Total number of keys in all selectors readonly:true

getTotalKeys

back to summary

public int getTotalKeys()

Get total number of keys from each selector.

Returns:int

total number of selector keys

Annotations

@ManagedAttribute:Total number of keys in all selectors
readonly:true

isConnectionPending	back to summary
protected boolean isConnectionPending(SelectableChannel channel)

newConnection back to summary

newConnection	back to summary
public abstract Connection newConnection(SelectableChannel channel, EndPoint endpoint, Object attachment) throws IOException Factory method to create `Connection`. Parameters channel:SelectableChannel the channel associated to the connection endpoint:EndPoint the endpoint attachment:Object the attachment Returns:Connection a new connection Exceptions IOException: if unable to create new connection

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

Factory method to create Connection.

Parameters

channel:SelectableChannel: the channel associated to the connection
endpoint:EndPoint: the endpoint
attachment:Object: the attachment

Returns:Connection

a new connection

Exceptions

IOException:: if unable to create new connection

newEndPoint back to summary

newEndPoint	back to summary
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:SelectableChannel the channel associated to the endpoint selector:ManagedSelector the selector the channel is registered to selectionKey:SelectionKey the selection key Returns:EndPoint a new endpoint Exceptions IOException: if the endPoint cannot be created See Also `newConnection(SelectableChannel, EndPoint, Object)`

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:SelectableChannel: the channel associated to the endpoint
selector:ManagedSelector: the selector the channel is registered to
selectionKey:SelectionKey: the selection key

Returns:EndPoint

a new endpoint

Exceptions

IOException:: if the endPoint cannot be created

newSelector back to summary

newSelector	back to summary
protected ManagedSelector newSelector(int id) Factory method for `ManagedSelector`. Parameters id:int an identifier for the `to create` Returns:ManagedSelector a new `ManagedSelector`

protected ManagedSelector newSelector(int id)

Factory method for ManagedSelector.

Parameters

id:int: an identifier for the to create

Returns:ManagedSelector

a new ManagedSelector

newSelector	back to summary
protected Selector newSelector() throws IOException

onAccepted	back to summary
protected void onAccepted(SelectableChannel channel)

onAcceptFailed	back to summary
protected void onAcceptFailed(SelectableChannel channel, Throwable cause)

onAccepting	back to summary
protected void onAccepting(SelectableChannel channel)

removeEventListener	back to summary
public boolean removeEventListener(EventListener listener) Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.removeEventListener. Implements org.eclipse.jetty.util.component.Container.removeEventListener, org.eclipse.jetty.util.component.LifeCycle.removeEventListener. Doc from org.eclipse.jetty.util.component.Container.removeEventListener. Remove an event listener. Parameters listener:EventListener the listener to remove Returns:boolean true if the listener was removed Annotations @Override

removeEventListener

back to summary

public boolean removeEventListener(EventListener listener)

Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.removeEventListener.

Implements org.eclipse.jetty.util.component.Container.removeEventListener, org.eclipse.jetty.util.component.LifeCycle.removeEventListener.

Doc from org.eclipse.jetty.util.component.Container.removeEventListener.

Remove an event listener.

Parameters

listener:EventListener: the listener to remove

Returns:boolean

true if the listener was removed

Annotations

@Override

setConnectTimeout	back to summary
public void setConnectTimeout(long milliseconds) Set the connect timeout (in milliseconds) Parameters milliseconds:long the number of milliseconds for the timeout

setConnectTimeout

back to summary

public void setConnectTimeout(long milliseconds)

Set the connect timeout (in milliseconds)

Parameters

milliseconds:long: the number of milliseconds for the timeout

toString	back to summary
public String toString() Overrides org.eclipse.jetty.util.component.AbstractLifeCycle.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides org.eclipse.jetty.util.component.AbstractLifeCycle.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

org.eclipse.jetty.io back to summary

public Interface SelectorManager.AcceptListener

extends SelectorManagerListener

A listener for accept events.

This listener is called from either the selector or acceptor thread and implementations must be non blocking and fast.

Method Summary

Modifier and Type	Method and Description
public default void	onAccepted(SelectableChannel the accepted channel channel) Called after the accepted channel has been allocated an `EndPoint` and associated `Connection`, and after the onOpen notifications have been called on both endPoint and connection.
public default void	onAcceptFailed(SelectableChannel the accepted channel channel, Throwable the cause of the failure cause) Called if the processing of the accepted channel fails prior to calling `onAccepted(SelectableChannel)`.
public default void	onAccepting(SelectableChannel the accepted channel channel) Called immediately after a new SelectableChannel is accepted, but before it has been submitted to the `SelectorManager`.

Method Detail

onAccepted back to summary

public default void onAccepted(SelectableChannel channel)

Called after the accepted channel has been allocated an EndPoint and associated Connection, and after the onOpen notifications have been called on both endPoint and connection.

Parameters

channel:SelectableChannel: the accepted channel

onAcceptFailed back to summary

public default void onAcceptFailed(SelectableChannel channel, Throwable cause)

Called if the processing of the accepted channel fails prior to calling onAccepted(SelectableChannel).

Parameters

channel:SelectableChannel: the accepted channel
cause:Throwable: the cause of the failure

onAccepting back to summary

public default void onAccepting(SelectableChannel channel)

Called immediately after a new SelectableChannel is accepted, but before it has been submitted to the SelectorManager.

Parameters

channel:SelectableChannel: the accepted channel

public abstract Class SelectorManager

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface SelectorManager.AcceptListener

Method Summary

Method Detail

public Interface SelectorManager.SelectorManagerListener