Interface Connection

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

AbstractConnection, AbstractMetaDataConnection, ALPNClientConnection, ALPNServerConnection, ClientQuicConnection, ConnectHandler.DownstreamConnection, ConnectHandler.UpstreamConnection, DecoderStreamConnection, EncoderStreamConnection, HTTP2Connection, HTTP3StreamConnection, InstructionStreamConnection, NegotiatingClientConnection, NegotiatingServerConnection, ProxyProtocolClientConnectionFactory.ProxyProtocolConnection, QuicConnection, ServerDocs.JSONHTTPConnection, ServerQuicConnection, SslConnection, UnidirectionalStreamConnection, WebSocketConnection

public interface Connection
extends Closeable

A Connection is associated to an EndPoint so that I/O events happening on the EndPoint can be processed by the Connection.

A typical implementation of Connection overrides onOpen() to set read interest on the EndPoint, and when the EndPoint signals read readyness, this Connection can read bytes from the network and interpret them.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Connection.Listener	A Listener for connection events.
static interface	Connection.UpgradeFrom	Connection implementations implement this interface when they can upgrade from the protocol they speak (for example HTTP/1.1) to a different protocol (e.g.
static interface	Connection.UpgradeTo	Connection implementations implement this interface when they can be upgraded to the protocol they speak (e.g.

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.
long	getBytesIn()
long	getBytesOut()
long	getCreatedTimeStamp()
EndPoint	getEndPoint()
long	getMessagesIn()
long	getMessagesOut()
void	onClose(Throwable cause)	Callback method invoked when this connection is closed.
boolean	onIdleExpired(TimeoutException timeoutException)	Callback method invoked upon an idle timeout event.
void	onOpen()	Callback method invoked when this connection is opened.
void	removeEventListener(EventListener listener)	Removes a listener of connection events.

Method Details

addEventListener

void addEventListener(EventListener listener)

Adds a listener of connection events.

Parameters:

listener - the listener to add

removeEventListener

void removeEventListener(EventListener listener)

Removes a listener of connection events.

Parameters:

listener - the listener to remove

onOpen

void onOpen()

Callback method invoked when this connection is opened.

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

onClose

void onClose(Throwable cause)

Callback method invoked when this connection is closed.

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

Parameters:

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

getEndPoint

EndPoint getEndPoint()

Returns:

the EndPoint associated with this Connection.

close

void close()

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

onIdleExpired

boolean onIdleExpired(TimeoutException timeoutException)

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.

Returns:

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

getMessagesIn

long getMessagesIn()

getMessagesOut

long getMessagesOut()

getBytesIn

long getBytesIn()

getBytesOut

long getBytesOut()

getCreatedTimeStamp

long getCreatedTimeStamp()