org.eclipse.jetty.io

Class AbstractEndPoint

java.lang.Object

org.eclipse.jetty.io.AbstractEndPoint

All Implemented Interfaces:

Closeable, AutoCloseable, EndPoint

Direct Known Subclasses:

ByteArrayEndPoint, ChannelEndPoint, FilterConnection.FilteredEndPoint, SslConnection.DecryptedEndPoint

public abstract class AbstractEndPoint
extends Object
implements EndPoint

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractEndPoint(Scheduler scheduler, InetSocketAddress local, InetSocketAddress remote)

Method Summary

Methods

Modifier and Type	Method and Description
protected long	checkIdleTimeout()
<C> void	fillInterested(C context, Callback<C> callback) Requests callback methods to be invoked when a call to EndPoint.fill(ByteBuffer) would return data or EOF.
Connection	getConnection()
long	getCreatedTimeStamp()
protected FillInterest	getFillInterest()
long	getIdleTimeout() Get the max idle time in ms.
long	getIdleTimestamp()
InetSocketAddress	getLocalAddress()
InetSocketAddress	getRemoteAddress()
protected WriteFlusher	getWriteFlusher()
protected abstract boolean	needsFill()
protected void	notIdle()
void	onClose() Callback method invoked when this EndPoint is close.
protected abstract void	onIncompleteFlush()
void	onOpen() Callback method invoked when this EndPoint is opened.
protected void	scheduleIdleTimeout(long delay)
void	setConnection(Connection connection)
void	setIdleTimeout(long idleTimeout) Set the idle timeout.
String	toString()
<C> void	write(C context, Callback<C> callback, ByteBuffer... buffers) Writes the given buffers via EndPoint.flush(ByteBuffer...) and invokes callback methods when either all the data has been flushed or an error occurs.

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

close, fill, flush, getTransport, isInputShutdown, isOpen, isOutputShutdown, shutdownOutput

Constructor Detail

AbstractEndPoint

protected AbstractEndPoint(Scheduler scheduler,
                InetSocketAddress local,
                InetSocketAddress remote)

Method Detail

getCreatedTimeStamp

public long getCreatedTimeStamp()

Specified by:

getCreatedTimeStamp in interface EndPoint

getIdleTimeout

public long getIdleTimeout()

Description copied from interface: EndPoint

Get the max idle time in ms.

The max idle time is the time the endpoint can be idle before extraordinary handling takes place.

Specified by:

getIdleTimeout in interface EndPoint

Returns:

the max idle time in ms or if ms <= 0 implies an infinite timeout

setIdleTimeout

public void setIdleTimeout(long idleTimeout)

Description copied from interface: EndPoint

Set the idle timeout.

Specified by:

setIdleTimeout in interface EndPoint

Parameters:

idleTimeout - the idle timeout in MS. Timeout <= 0 implies an infinite timeout

getLocalAddress

public InetSocketAddress getLocalAddress()

Specified by:

getLocalAddress in interface EndPoint

Returns:

The local Inet address to which this EndPoint is bound, or null if this EndPoint does not represent a network connection.

getRemoteAddress

public InetSocketAddress getRemoteAddress()

Specified by:

getRemoteAddress in interface EndPoint

Returns:

The remote Inet address to which this EndPoint is bound, or null if this EndPoint does not represent a network connection.

getIdleTimestamp

public long getIdleTimestamp()

notIdle

protected void notIdle()

getConnection

public Connection getConnection()

Specified by:

getConnection in interface EndPoint

Returns:

the Connection associated with this EndPoint

See Also:

EndPoint.setConnection(Connection)

setConnection

public void setConnection(Connection connection)

Specified by:

setConnection in interface EndPoint

Parameters:

connection - the Connection associated with this EndPoint

See Also:

EndPoint.getConnection()

onOpen

public void onOpen()

Description copied from interface: EndPoint

Callback method invoked when this EndPoint is opened.

Specified by:

onOpen in interface EndPoint

See Also:

EndPoint.onClose()

onClose

public void onClose()

Description copied from interface: EndPoint

Callback method invoked when this EndPoint is close.

Specified by:

onClose in interface EndPoint

See Also:

EndPoint.onOpen()

fillInterested

public <C> void fillInterested(C context,
                      Callback<C> callback)
                    throws IllegalStateException

Description copied from interface: EndPoint

Requests callback methods to be invoked when a call to EndPoint.fill(ByteBuffer) would return data or EOF.

Specified by:

fillInterested in interface EndPoint

Parameters:

context - the context to return via the callback

callback - the callback to call when an error occurs or we are readable.

Throws:

ReadPendingException - if another read operation is concurrent.

IllegalStateException

write

public <C> void write(C context,
             Callback<C> callback,
             ByteBuffer... buffers)
           throws IllegalStateException

Description copied from interface: EndPoint

Writes the given buffers via EndPoint.flush(ByteBuffer...) and invokes callback methods when either all the data has been flushed or an error occurs.

Specified by:

write in interface EndPoint

Parameters:

context - the context to return via the callback

callback - the callback to call when an error occurs or the write completed.

buffers - one or more ByteBuffers that will be flushed.

Throws:

WritePendingException - if another write operation is concurrent.

IllegalStateException

onIncompleteFlush

protected abstract void onIncompleteFlush()

needsFill

protected abstract boolean needsFill()
                              throws IOException

Throws:

IOException

getFillInterest

protected FillInterest getFillInterest()

getWriteFlusher

protected WriteFlusher getWriteFlusher()

scheduleIdleTimeout

protected void scheduleIdleTimeout(long delay)

checkIdleTimeout

protected long checkIdleTimeout()

toString

public String toString()

Overrides:

toString in class Object