Module org.eclipse.jetty.io

Package org.eclipse.jetty.io

Class AbstractConnection

java.lang.Object

org.eclipse.jetty.io.AbstractConnection

All Implemented Interfaces:

Closeable, AutoCloseable, Connection

Direct Known Subclasses:

AbstractConnection.NonBlocking, SslConnection

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

Modifier and Type	Class	Description
static class	AbstractConnection.NonBlocking

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

Connection.Listener, Connection.Tunnel, Connection.UpgradeFrom, Connection.UpgradeTo

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractConnection(EndPoint endPoint, Executor executor)

Method Summary

Modifier and Type	Method	Description
void	addEventListener(EventListener listener)	Adds a listener of connection events.
void	close()	Performs a logical close of this connection.
void	fillInterested()	Registers read interest using the default Callback with Invocable.InvocationType.BLOCKING.
void	fillInterested(org.eclipse.jetty.util.Callback callback)	Registers read interest with the given callback.
long	getBytesIn()
long	getBytesOut()
long	getCreatedTimeStamp()
EndPoint	getEndPoint()
protected Executor	getExecutor()
int	getInputBufferSize()
long	getMessagesIn()
long	getMessagesOut()
boolean	isFillInterested()
void	onClose(Throwable cause)	Callback method invoked when this connection is closed.
abstract void	onFillable()	Callback method invoked when the endpoint is ready to be read.
void	onFillInterestedFailed(Throwable cause)	Callback method invoked when the endpoint failed to be ready to be read.
boolean	onIdleExpired(TimeoutException timeoutException)	Callback method invoked upon an idle timeout event.
void	onOpen()	Callback method invoked when this connection is opened.
protected boolean	onReadTimeout(TimeoutException timeout)	Callback method invoked when the endpoint failed to be ready to be read after a timeout
void	removeEventListener(EventListener eventListener)	Removes a listener of connection events.
void	setInputBufferSize(int inputBufferSize)
String	toConnectionString()
final String	toString()
void	tryFillInterested(org.eclipse.jetty.util.Callback callback)

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractConnection

protected AbstractConnection(EndPoint endPoint,
 Executor executor)

Method Details

addEventListener

public void addEventListener(EventListener listener)

Description copied from interface: Connection

Adds a listener of connection events.

Specified by:

addEventListener in interface Connection

Parameters:

listener - the listener to add

removeEventListener

public void removeEventListener(EventListener eventListener)

Description copied from interface: Connection

Removes a listener of connection events.

Specified by:

removeEventListener in interface Connection

Parameters:

eventListener - the listener to remove

getInputBufferSize

public int getInputBufferSize()

setInputBufferSize

public void setInputBufferSize(int inputBufferSize)

getExecutor

protected Executor getExecutor()

fillInterested

public void fillInterested()

Registers read interest using the default Callback with Invocable.InvocationType.BLOCKING.

When read readiness is signaled, onFillable() or onFillInterestedFailed(Throwable) will be invoked.

This method should be used sparingly, mainly from onOpen(), and fillInterested(Callback) should be preferred instead, passing a Callback that specifies the Invocable.InvocationType for each specific case where read interest needs to be registered.

See Also:

• fillInterested(Callback)
• onFillable()
• onFillInterestedFailed(Throwable)

fillInterested

public void fillInterested(org.eclipse.jetty.util.Callback callback)

Registers read interest with the given callback.

When read readiness is signaled, the callback will be completed.

Parameters:

callback - the callback to complete when read readiness is signaled

tryFillInterested

public void tryFillInterested(org.eclipse.jetty.util.Callback callback)

isFillInterested

public boolean isFillInterested()

onFillable

public abstract void onFillable()

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

See Also:

• fillInterested(Callback)

onFillInterestedFailed

public 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(TimeoutException timeout)

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

Parameters:

timeout - the cause of the read 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(Throwable cause)

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

Parameters:

cause - The cause of the close or null for a normal close

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 Closeable

Specified by:

close in interface Connection

onIdleExpired

public boolean onIdleExpired(TimeoutException timeoutException)

Description copied from interface: Connection

Callback method invoked upon an idle timeout event.

Implementations of this method may return true to indicate that the idle timeout handling should proceed normally, typically failing the EndPoint and causing it to be closed.

When false is returned, the handling of the idle timeout event is halted immediately and the EndPoint left in the state it was before the idle timeout event.

Specified by:

onIdleExpired in interface Connection

Returns:

true to let the EndPoint handle the idle timeout, false to tell the EndPoint to halt the handling of the idle timeout.

getMessagesIn

public long getMessagesIn()

Specified by:

getMessagesIn in interface Connection

getMessagesOut

public long 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 final String toString()

Overrides:

toString in class Object

toConnectionString

public String toConnectionString()