org.eclipse.jetty.io

Class ChannelEndPoint

java.lang.Object

org.eclipse.jetty.io.IdleTimeout

org.eclipse.jetty.io.AbstractEndPoint

org.eclipse.jetty.io.ChannelEndPoint

All Implemented Interfaces:

Closeable, AutoCloseable, EndPoint, ManagedSelector.Selectable

Direct Known Subclasses:

SocketChannelEndPoint

public abstract class ChannelEndPoint
extends AbstractEndPoint
implements ManagedSelector.Selectable

Channel End Point.

Holds the channel and socket for an NIO endpoint.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	_currentInterestOps The current value for SelectionKey.interestOps().
protected int	_desiredInterestOps The desired value for SelectionKey.interestOps().
protected SelectionKey	_key
protected ManagedSelector	_selector

Constructor Summary

Constructors

Constructor and Description
ChannelEndPoint(ByteChannel channel, ManagedSelector selector, SelectionKey key, Scheduler scheduler)

Method Summary

Modifier and Type	Method and Description
void	doClose()
int	fill(ByteBuffer buffer) Fill the passed buffer with data from this endpoint.
boolean	flush(ByteBuffer... buffers) Flush data from the passed header/buffer to this endpoint.
ByteChannel	getChannel()
Object	getTransport()
boolean	isOpen() This abstract method should be called to check if idle timeouts should still be checked.
boolean	isOptimizedForDirectBuffers() Is the endpoint optimized for DirectBuffer usage
protected void	needsFillInterest()
void	onClose() Callback method invoked when this EndPoint is close.
protected void	onIncompleteFlush()
Runnable	onSelected() Callback method invoked when a read or write events has been detected by the ManagedSelector for this endpoint.
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 org.eclipse.jetty.io.AbstractEndPoint

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

Methods inherited from class org.eclipse.jetty.io.IdleTimeout

checkIdleTimeout, getIdleFor, getIdleTimeout, getIdleTimestamp, getScheduler, notIdle, setIdleTimeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jetty.io.EndPoint

getIdleTimeout, getLocalAddress, getRemoteAddress, setIdleTimeout

Field Detail

_selector

protected final ManagedSelector _selector

_key

protected final SelectionKey _key

_currentInterestOps

protected int _currentInterestOps

The current value for SelectionKey.interestOps().

_desiredInterestOps

protected int _desiredInterestOps

The desired value for SelectionKey.interestOps().

Constructor Detail

ChannelEndPoint

public ChannelEndPoint(ByteChannel channel,
                       ManagedSelector selector,
                       SelectionKey key,
                       Scheduler scheduler)

Method Detail

isOptimizedForDirectBuffers

public boolean isOptimizedForDirectBuffers()

Description copied from interface: EndPoint

Is the endpoint optimized for DirectBuffer usage

Specified by:

isOptimizedForDirectBuffers in interface EndPoint

Overrides:

isOptimizedForDirectBuffers in class AbstractEndPoint

Returns:

True if direct buffers can be used optimally.

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()

Description copied from interface: EndPoint

Callback method invoked when this EndPoint is close.

Specified by:

onClose in interface EndPoint

Overrides:

onClose in class AbstractEndPoint

See Also:

EndPoint.onOpen()

fill

public int fill(ByteBuffer buffer)
         throws IOException

Description copied from interface: EndPoint

Fill the passed buffer with data from this endpoint. The bytes are appended to any data already in the buffer by writing from the buffers limit up to it's capacity. The limit is updated to include the filled bytes.

Specified by:

fill in interface EndPoint

Parameters:

buffer - The buffer to fill. The position and limit are modified during the fill. After the operation, the position is unchanged and the limit is increased to reflect the new data filled.

Returns:

an int value indicating the number of bytes filled or -1 if EOF is read or the input is shutdown.

Throws:

IOException - if the endpoint is closed.

flush

public boolean flush(ByteBuffer... buffers)
              throws IOException

Description copied from interface: EndPoint

Flush data from the passed header/buffer to this endpoint. As many bytes as can be consumed are taken from the header/buffer position up until the buffer limit. The header/buffers position is updated to indicate how many bytes have been consumed.

Specified by:

flush in interface EndPoint

Parameters:

buffers - the buffers to flush

Returns:

True IFF all the buffers have been consumed and the endpoint has flushed the data to its destination (ie is not buffering any data).

Throws:

IOException - If the endpoint is closed or output is shutdown.

getChannel

public ByteChannel getChannel()

getTransport

public Object getTransport()

Specified by:

getTransport in interface EndPoint

Returns:

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

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

toEndPointString

public String toEndPointString()

Overrides:

toEndPointString in class AbstractEndPoint