Class SelectableChannelEndPoint

java.lang.Object

org.eclipse.jetty.io.IdleTimeout

org.eclipse.jetty.io.AbstractEndPoint

org.eclipse.jetty.io.SelectableChannelEndPoint

All Implemented Interfaces:

Closeable, AutoCloseable, EndPoint, ManagedSelector.Selectable

Direct Known Subclasses:

DatagramChannelEndPoint, SocketChannelEndPoint

public abstract class SelectableChannelEndPoint
extends AbstractEndPoint
implements ManagedSelector.Selectable

A partial EndPoint implementation based on SelectableChannel.

Nested Class Summary

Nested classes/interfaces inherited from interface EndPoint

EndPoint.Pipe, EndPoint.SslSessionData, EndPoint.Wrapper

Field Summary

Fields inherited from interface EndPoint

EOF

Constructor Summary

Constructors

Constructor	Description
SelectableChannelEndPoint(Scheduler scheduler, SelectableChannel channel, ManagedSelector selector, SelectionKey selectionKey)

Method Summary

Modifier and Type	Method	Description
void	doClose()
SelectableChannel	getChannel()
SocketAddress	getLocalSocketAddress()
Object	getTransport()
boolean	isOpen()	This abstract method should be called to check if idle timeouts should still be checked.
protected void	needsFillInterest()
void	onClose(Throwable cause)	Callback method invoked when this EndPoint is closed.
protected void	onIncompleteFlush()
Runnable	onSelected()	Callback method invoked when a read or write events has been detected by the ManagedSelector for this endpoint.
void	replaceKey(SelectionKey newKey)	Callback method invoked when the SelectionKey is replaced because the channel has been moved to a new selector.
String	toEndPointString()
void	updateKey()	Callback method invoked when all the keys selected by the ManagedSelector for this endpoint have been processed.

Methods inherited from class AbstractEndPoint

close, close, doShutdownInput, doShutdownOutput, fillInterested, getConnection, getCreatedTimeStamp, getFillInterest, getLocalAddress, getRemoteAddress, getRemoteSocketAddress, getWriteFlusher, isFillInterested, isInputShutdown, isOutputShutdown, onClose, onIdleExpired, onOpen, reset, setConnection, shutdownInput, shutdownOutput, toConnectionString, toString, tryFillInterested, upgrade, write

Methods inherited from class IdleTimeout

checkIdleTimeout, getIdleFor, getIdleTimeout, getScheduler, notIdle, setIdleTimeout

Methods inherited from class Object

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

Methods inherited from interface EndPoint

fill, flush, getIdleTimeout, getSslSessionData, isSecure, receive, send, setIdleTimeout, write

Constructor Details

SelectableChannelEndPoint

public SelectableChannelEndPoint(Scheduler scheduler,
 SelectableChannel channel,
 ManagedSelector selector,
 SelectionKey selectionKey)

Method Details

getChannel

public SelectableChannel getChannel()

getTransport

public Object getTransport()

Specified by:

getTransport in interface EndPoint

Returns:

The underlying transport object (socket, channel, etc.)

getLocalSocketAddress

public SocketAddress getLocalSocketAddress()

Specified by:

getLocalSocketAddress in interface EndPoint

Specified by:

getLocalSocketAddress in class AbstractEndPoint

Returns:

the local SocketAddress to which this EndPoint is bound or null if this EndPoint is not bound to a Socket address.

isOpen

public boolean isOpen()

Description copied from class: IdleTimeout

This abstract method should be called to check if idle timeouts should still be checked.

Specified by:

isOpen in interface EndPoint

Overrides:

isOpen in class AbstractEndPoint

Returns:

True if the entity monitored should still be checked for idle timeouts

doClose

public void doClose()

Overrides:

doClose in class AbstractEndPoint

onClose

public void onClose(Throwable cause)

Description copied from interface: EndPoint

Callback method invoked when this EndPoint is closed.

Specified by:

onClose in interface EndPoint

Overrides:

onClose in class AbstractEndPoint

Parameters:

cause - The reason for the close, or null if a normal close.

See Also:

• EndPoint.onOpen()

needsFillInterest

protected void needsFillInterest()

Specified by:

needsFillInterest in class AbstractEndPoint

onIncompleteFlush

protected void onIncompleteFlush()

Specified by:

onIncompleteFlush in class AbstractEndPoint

onSelected

public Runnable onSelected()

Description copied from interface: ManagedSelector.Selectable

Callback method invoked when a read or write events has been detected by the ManagedSelector for this endpoint.

Specified by:

onSelected in interface ManagedSelector.Selectable

Returns:

a job that may block or null

updateKey

public void updateKey()

Description copied from interface: ManagedSelector.Selectable

Callback method invoked when all the keys selected by the ManagedSelector for this endpoint have been processed.

Specified by:

updateKey in interface ManagedSelector.Selectable

replaceKey

public void replaceKey(SelectionKey newKey)

Description copied from interface: ManagedSelector.Selectable

Callback method invoked when the SelectionKey is replaced because the channel has been moved to a new selector.

Specified by:

replaceKey in interface ManagedSelector.Selectable

Parameters:

newKey - the new SelectionKey

toEndPointString

public String toEndPointString()

Overrides:

toEndPointString in class AbstractEndPoint