Module org.eclipse.jetty.io

Package org.eclipse.jetty.io

Class NetworkTrafficSocketChannelEndPoint

java.lang.Object

org.eclipse.jetty.io.IdleTimeout

org.eclipse.jetty.io.AbstractEndPoint

org.eclipse.jetty.io.SocketChannelEndPoint

org.eclipse.jetty.io.NetworkTrafficSocketChannelEndPoint

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, EndPoint, ManagedSelector.Selectable

public class NetworkTrafficSocketChannelEndPoint
extends SocketChannelEndPoint

A specialized version of SocketChannelEndPoint that supports NetworkTrafficListeners.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.io.EndPoint

EndPoint.Wrapper

Constructor Summary

Constructors

Constructor	Description
NetworkTrafficSocketChannelEndPoint(java.nio.channels.SocketChannel channel, ManagedSelector selectSet, java.nio.channels.SelectionKey key, org.eclipse.jetty.util.thread.Scheduler scheduler, long idleTimeout, NetworkTrafficListener listener)

Method Summary

Modifier and Type	Method	Description
int	fill(java.nio.ByteBuffer buffer)	Fill the passed buffer with data from this endpoint.
boolean	flush(java.nio.ByteBuffer... buffers)	Flush data from the passed header/buffer to this endpoint.
void	notifyIncoming(java.nio.ByteBuffer buffer, int read)
void	notifyOutgoing(java.nio.ByteBuffer view)
void	onClose(java.lang.Throwable failure)	Callback method invoked when this EndPoint is closed.
void	onOpen()	Callback method invoked when this EndPoint is opened.

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

doClose, doShutdownOutput, getChannel, getLocalAddress, getRemoteAddress, getTransport, isOpen, needsFillInterest, onIncompleteFlush, onSelected, replaceKey, toEndPointString, updateKey

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

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

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

checkIdleTimeout, getIdleFor, getIdleTimeout, 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, setIdleTimeout

Constructor Detail

NetworkTrafficSocketChannelEndPoint

public NetworkTrafficSocketChannelEndPoint(java.nio.channels.SocketChannel channel,
                                           ManagedSelector selectSet,
                                           java.nio.channels.SelectionKey key,
                                           org.eclipse.jetty.util.thread.Scheduler scheduler,
                                           long idleTimeout,
                                           NetworkTrafficListener listener)

Method Detail

fill

public int fill(java.nio.ByteBuffer buffer)
         throws java.io.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

Overrides:

fill in class SocketChannelEndPoint

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:

java.io.IOException - if the endpoint is closed.

flush

public boolean flush(java.nio.ByteBuffer... buffers)
              throws java.io.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

Overrides:

flush in class SocketChannelEndPoint

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:

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

onOpen

public void onOpen()

Description copied from interface: EndPoint

Callback method invoked when this EndPoint is opened.

Specified by:

onOpen in interface EndPoint

Overrides:

onOpen in class AbstractEndPoint

See Also:

EndPoint.onClose(Throwable)

onClose

public void onClose(java.lang.Throwable failure)

Description copied from interface: EndPoint

Callback method invoked when this EndPoint is closed.

Specified by:

onClose in interface EndPoint

Overrides:

onClose in class SocketChannelEndPoint

Parameters:

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

See Also:

EndPoint.onOpen()

notifyIncoming

public void notifyIncoming(java.nio.ByteBuffer buffer,
                           int read)

notifyOutgoing

public void notifyOutgoing(java.nio.ByteBuffer view)