Class SocketChannelEndPoint

java.lang.Object

org.eclipse.jetty.io.IdleTimeout

org.eclipse.jetty.io.AbstractEndPoint

org.eclipse.jetty.io.SelectableChannelEndPoint

org.eclipse.jetty.io.SocketChannelEndPoint

All Implemented Interfaces:

Closeable, AutoCloseable, EndPoint, ManagedSelector.Selectable

Direct Known Subclasses:

NetworkTrafficSocketChannelEndPoint

public class SocketChannelEndPoint
extends SelectableChannelEndPoint

An EndPoint implementation based on SocketChannel.

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
SocketChannelEndPoint(SocketChannel channel, ManagedSelector selector, SelectionKey key, Scheduler scheduler)

Method Summary

Modifier and Type	Method	Description
protected void	doShutdownOutput()
int	fill(ByteBuffer buffer)	Fills the passed buffer with data from this endpoint.
boolean	flush(ByteBuffer... buffers)	Flushes data from the passed header/buffer to this endpoint.
SocketChannel	getChannel()
SocketAddress	getRemoteSocketAddress()

Methods inherited from class SelectableChannelEndPoint

doClose, getLocalSocketAddress, getTransport, isOpen, needsFillInterest, onClose, onIncompleteFlush, onSelected, replaceKey, toEndPointString, updateKey

Methods inherited from class AbstractEndPoint

close, close, doShutdownInput, fillInterested, getConnection, getCreatedTimeStamp, getFillInterest, getLocalAddress, getRemoteAddress, 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

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

Constructor Details

SocketChannelEndPoint

public SocketChannelEndPoint(SocketChannel channel,
 ManagedSelector selector,
 SelectionKey key,
 Scheduler scheduler)

Method Details

getChannel

public SocketChannel getChannel()

Overrides:

getChannel in class SelectableChannelEndPoint

getRemoteSocketAddress

public SocketAddress getRemoteSocketAddress()

Specified by:

getRemoteSocketAddress in interface EndPoint

Specified by:

getRemoteSocketAddress in class AbstractEndPoint

Returns:

The remote SocketAddress to which this EndPoint is connected, or null if this EndPoint is not connected to a Socket address.

doShutdownOutput

protected void doShutdownOutput()

Overrides:

doShutdownOutput in class AbstractEndPoint

fill

public int fill(ByteBuffer buffer)
         throws IOException

Description copied from interface: EndPoint

Fills 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 its capacity. The limit is updated to include the filled bytes.

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

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

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.