org.eclipse.jetty.io

Class AbstractConnection

java.lang.Object

org.eclipse.jetty.io.AbstractConnection

All Implemented Interfaces:

AutoCloseable, Connection

Direct Known Subclasses:

AbstractWebSocketConnection, HttpConnection, HttpConnection, ProxyConnection, SslConnection, UpgradeConnection

public abstract class AbstractConnection
extends Object
implements Connection

A convenience base implementation of Connection.

This class uses the capabilities of the EndPoint API to provide a more traditional style of async reading. A call to fillInterested() will schedule a callback to onFillable() or onFillInterestedFailed(Throwable) as appropriate.

Nested Class Summary

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

Connection.Listener

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	EXECUTE_ONFILLABLE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractConnection(EndPoint endp, Executor executor)
protected	AbstractConnection(EndPoint endp, Executor executor, boolean executeOnfillable)

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(Connection.Listener listener)
protected void	block(BlockingCallback callback)
void	close() Performs a logical close of this connection.
void	fillInterested() Utility method to be called to register read interest.
long	getBytesIn()
long	getBytesOut()
long	getCreatedTimeStamp()
EndPoint	getEndPoint()
protected Executor	getExecutor()
int	getInputBufferSize()
int	getMessagesIn()
int	getMessagesOut()
void	onClose() Callback method invoked when this Connection is closed.
abstract void	onFillable() Callback method invoked when the endpoint is ready to be read.
protected void	onFillInterestedFailed(Throwable cause) Callback method invoked when the endpoint failed to be ready to be read.
void	onOpen() Callback method invoked when this Connection is opened.
protected boolean	onReadTimeout() Callback method invoked when the endpoint failed to be ready to be read after a timeout
void	setInputBufferSize(int inputBufferSize)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EXECUTE_ONFILLABLE

public static final boolean EXECUTE_ONFILLABLE

See Also:

Constant Field Values

Constructor Detail

AbstractConnection

protected AbstractConnection(EndPoint endp,
                  Executor executor)

AbstractConnection

protected AbstractConnection(EndPoint endp,
                  Executor executor,
                  boolean executeOnfillable)

Method Detail

addListener

public void addListener(Connection.Listener listener)

Specified by:

addListener in interface Connection

getInputBufferSize

public int getInputBufferSize()

setInputBufferSize

public void setInputBufferSize(int inputBufferSize)

getExecutor

protected Executor getExecutor()

fillInterested

public void fillInterested()

Utility method to be called to register read interest.

After a call to this method, onFillable() or onFillInterestedFailed(Throwable) will be called back as appropriate.

See Also:

onFillable()

block

protected void block(BlockingCallback callback)

onFillable

public abstract void onFillable()

Callback method invoked when the endpoint is ready to be read.

See Also:

fillInterested()

onFillInterestedFailed

protected void onFillInterestedFailed(Throwable cause)

Callback method invoked when the endpoint failed to be ready to be read.

Parameters:

cause - the exception that caused the failure

onReadTimeout

protected boolean onReadTimeout()

Callback method invoked when the endpoint failed to be ready to be read after a timeout

Returns:

true to signal that the endpoint must be closed, false to keep the endpoint open

onOpen

public void onOpen()

Description copied from interface: Connection

Callback method invoked when this Connection is opened.

Creators of the connection implementation are responsible for calling this method.

Specified by:

onOpen in interface Connection

onClose

public void onClose()

Description copied from interface: Connection

Callback method invoked when this Connection is closed.

Creators of the connection implementation are responsible for calling this method.

Specified by:

onClose in interface Connection

getEndPoint

public EndPoint getEndPoint()

Specified by:

getEndPoint in interface Connection

Returns:

the EndPoint associated with this Connection

close

public void close()

Description copied from interface: Connection

Performs a logical close of this connection.

For simple connections, this may just mean to delegate the close to the associated EndPoint but, for example, SSL connections should write the SSL close message before closing the associated EndPoint.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Connection

getMessagesIn

public int getMessagesIn()

Specified by:

getMessagesIn in interface Connection

getMessagesOut

public int getMessagesOut()

Specified by:

getMessagesOut in interface Connection

getBytesIn

public long getBytesIn()

Specified by:

getBytesIn in interface Connection

getBytesOut

public long getBytesOut()

Specified by:

getBytesOut in interface Connection

getCreatedTimeStamp

public long getCreatedTimeStamp()

Specified by:

getCreatedTimeStamp in interface Connection

toString

public String toString()

Overrides:

toString in class Object