org.eclipse.jetty.io

Class AbstractEndPoint

java.lang.Object

org.eclipse.jetty.io.IdleTimeout

org.eclipse.jetty.io.AbstractEndPoint

All Implemented Interfaces:

Closeable, AutoCloseable, EndPoint

Direct Known Subclasses:

ByteArrayEndPoint, ChannelEndPoint, SslConnection.DecryptedEndPoint

public abstract class AbstractEndPoint
extends IdleTimeout
implements EndPoint

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	close() Close any backing stream associated with the endpoint
void	fillInterested(Callback callback) Requests callback methods to be invoked when a call to EndPoint.fill(ByteBuffer) would return data or EOF.
Connection	getConnection()
long	getCreatedTimeStamp()
FillInterest	getFillInterest()
InetSocketAddress	getLocalAddress()
InetSocketAddress	getRemoteAddress()
protected WriteFlusher	getWriteFlusher()
boolean	isFillInterested()
boolean	isOptimizedForDirectBuffers() Is the endpoint optimized for DirectBuffer usage
protected abstract void	needsFillInterest()
void	onClose() Callback method invoked when this EndPoint is close.
protected void	onIdleExpired(TimeoutException timeout) This abstract method is called when the idle timeout has expired.
protected abstract void	onIncompleteFlush()
void	onOpen() Callback method invoked when this EndPoint is opened.
void	setConnection(Connection connection)
String	toString()
void	upgrade(Connection newConnection) Upgrade connections.
void	write(Callback 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 org.eclipse.jetty.io.IdleTimeout

checkIdleTimeout, getIdleFor, getIdleTimeout, getIdleTimestamp, getScheduler, isOpen, 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

fill, flush, getIdleTimeout, getTransport, isInputShutdown, isOpen, isOutputShutdown, setIdleTimeout, shutdownOutput

Constructor Detail

AbstractEndPoint

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

Method Detail

getCreatedTimeStamp

public long getCreatedTimeStamp()

Specified by:

getCreatedTimeStamp in interface EndPoint

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.

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(), EndPoint.upgrade(Connection)

isOptimizedForDirectBuffers

public boolean isOptimizedForDirectBuffers()

Description copied from interface: EndPoint

Is the endpoint optimized for DirectBuffer usage

Specified by:

isOptimizedForDirectBuffers in interface EndPoint

Returns:

True if direct buffers can be used optimally.

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 IdleTimeout

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

Overrides:

onClose in class IdleTimeout

See Also:

EndPoint.onOpen()

close

public void close()

Description copied from interface: EndPoint

Close any backing stream associated with the endpoint

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface EndPoint

fillInterested

public void fillInterested(Callback 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:

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

Throws:

ReadPendingException - if another read operation is concurrent.

IllegalStateException

isFillInterested

public boolean isFillInterested()

Specified by:

isFillInterested in interface EndPoint

Returns:

whether EndPoint.fillInterested(Callback) has been called, but EndPoint.fill(ByteBuffer) has not yet been called

write

public void write(Callback 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:

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

needsFillInterest

protected abstract void needsFillInterest()
                                   throws IOException

Throws:

IOException

getFillInterest

public FillInterest getFillInterest()

getWriteFlusher

protected WriteFlusher getWriteFlusher()

onIdleExpired

protected void onIdleExpired(TimeoutException timeout)

Description copied from class: IdleTimeout

This abstract method is called when the idle timeout has expired.

Specified by:

onIdleExpired in class IdleTimeout

Parameters:

timeout - a TimeoutException

upgrade

public void upgrade(Connection newConnection)

Description copied from interface: EndPoint

Upgrade connections. Close the old connection, update the endpoint and open the new connection. If the oldConnection is an instance of Connection.UpgradeFrom then a prefilled buffer is requested and passed to the newConnection if it is an instance of Connection.UpgradeTo

Specified by:

upgrade in interface EndPoint

Parameters:

newConnection - The connection to upgrade to

toString

public String toString()

Overrides:

toString in class Object