Package io.servicetalk.transport.netty.internal

Class NoopTransportObserver.NoopConnectionObserver

java.lang.Object

io.servicetalk.transport.netty.internal.NoopTransportObserver.NoopConnectionObserver

All Implemented Interfaces:

ConnectionObserver

Enclosing class:

NoopTransportObserver

public static final class NoopTransportObserver.NoopConnectionObserver
extends Object
implements ConnectionObserver

Noop version of ConnectionObserver.

Nested Class Summary

Nested classes/interfaces inherited from interface io.servicetalk.transport.api.ConnectionObserver

ConnectionObserver.DataObserver, ConnectionObserver.MultiplexedObserver, ConnectionObserver.ProxyConnectObserver, ConnectionObserver.ReadObserver, ConnectionObserver.SecurityHandshakeObserver, ConnectionObserver.StreamObserver, ConnectionObserver.WriteObserver

Field Summary

Fields

Modifier and Type	Field	Description
static final ConnectionObserver	INSTANCE

Method Summary

Modifier and Type	Method	Description
void	connectionClosed()	Callback when the connection is closed.
void	connectionClosed(Throwable error)	Callback when the connection is closed due to an error.
ConnectionObserver.DataObserver	connectionEstablished(ConnectionInfo info)	Callback when a non-multiplexed connection is established and ready.
void	connectionWritabilityChanged(boolean isWritable)	Callback when a writable state of the connection changes.
ConnectionObserver.MultiplexedObserver	multiplexedConnectionEstablished(ConnectionInfo info)	Callback when a multiplexed connection is established and ready.
void	onDataRead(int size)	Callback when size bytes are read from the connection.
void	onDataWrite(int size)	Callback when size bytes are written to the connection.
void	onFlush()	Callback when previously written data is flushed to the connection.
ConnectionObserver.ProxyConnectObserver	onProxyConnect(Object connectMsg)	Callback when a proxy connect is initiated.
ConnectionObserver.SecurityHandshakeObserver	onSecurityHandshake()	Callback when a security handshake is initiated.
ConnectionObserver.SecurityHandshakeObserver	onSecurityHandshake(SslConfig sslConfig)	Callback when a security handshake is initiated.
void	onTransportHandshakeComplete()	Callback when a transport handshake completes.
void	onTransportHandshakeComplete(ConnectionInfo info)	Callback when a transport handshake completes.

Methods inherited from class java.lang.Object

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

Field Details

INSTANCE

public static final ConnectionObserver INSTANCE

Method Details

onDataRead

public void onDataRead(int size)

Description copied from interface: ConnectionObserver

Callback when size bytes are read from the connection.

Specified by:

onDataRead in interface ConnectionObserver

Parameters:

size - size of the data chunk read

onDataWrite

public void onDataWrite(int size)

Description copied from interface: ConnectionObserver

Callback when size bytes are written to the connection.

Specified by:

onDataWrite in interface ConnectionObserver

Parameters:

size - size of the data chunk written

onFlush

public void onFlush()

Description copied from interface: ConnectionObserver

Callback when previously written data is flushed to the connection.

Specified by:

onFlush in interface ConnectionObserver

onTransportHandshakeComplete

public void onTransportHandshakeComplete()

Description copied from interface: ConnectionObserver

Callback when a transport handshake completes.

Transport protocols that require a handshake in order to connect. Example: TCP "three-way handshake".

Specified by:

onTransportHandshakeComplete in interface ConnectionObserver

onTransportHandshakeComplete

public void onTransportHandshakeComplete(ConnectionInfo info)

Description copied from interface: ConnectionObserver

Callback when a transport handshake completes.

Transport protocols that require a handshake in order to connect. Example: TCP "three-way handshake".

Specified by:

onTransportHandshakeComplete in interface ConnectionObserver

Parameters:

info - ConnectionInfo for the connection after transport handshake completes. Note that the ConnectionInfo.sslSession() will always return null since it is called before the ConnectionObserver.onSecurityHandshake(SslConfig) security handshake} is performed (and as a result no SSL session has been established). Also, ConnectionInfo.protocol() will return L4 (transport) protocol. Finalized ConnectionInfo will be available via ConnectionObserver.connectionEstablished(ConnectionInfo) or ConnectionObserver.multiplexedConnectionEstablished(ConnectionInfo) callbacks.

onProxyConnect

public ConnectionObserver.ProxyConnectObserver onProxyConnect(Object connectMsg)

Description copied from interface: ConnectionObserver

Callback when a proxy connect is initiated.

For a typical connection, this callback is invoked after ConnectionObserver.onTransportHandshakeComplete(ConnectionInfo).

Specified by:

onProxyConnect in interface ConnectionObserver

Parameters:

connectMsg - a message sent to a proxy in request to establish a connection to the target server

Returns:

a new ConnectionObserver.ProxyConnectObserver that provides visibility into proxy connect events.

onSecurityHandshake

public ConnectionObserver.SecurityHandshakeObserver onSecurityHandshake()

Description copied from interface: ConnectionObserver

Callback when a security handshake is initiated.

For a typical connection, this callback is invoked after ConnectionObserver.onTransportHandshakeComplete(ConnectionInfo). There are exceptions:

1. For a TCP connection, when ServiceTalkSocketOptions.TCP_FASTOPEN_CONNECT option is configured and the Fast Open feature is supported by the OS, this callback may be invoked earlier. Note, even if the Fast Open is available and configured, it may not actually happen if the Fast Open Cookie is null or rejected by the server.
2. For a proxy connections, the handshake may happen after an observer returned by ConnectionObserver.onProxyConnect(Object) completes successfully.

Specified by:

onSecurityHandshake in interface ConnectionObserver

Returns:

a new ConnectionObserver.SecurityHandshakeObserver that provides visibility into security handshake events

See Also:

• RFC7413: TCP Fast Open

onSecurityHandshake

public ConnectionObserver.SecurityHandshakeObserver onSecurityHandshake(SslConfig sslConfig)

Description copied from interface: ConnectionObserver

Callback when a security handshake is initiated.

For a typical connection, this callback is invoked after ConnectionObserver.onTransportHandshakeComplete(ConnectionInfo). There are exceptions:

1. For a TCP connection, when ServiceTalkSocketOptions.TCP_FASTOPEN_CONNECT option is configured and the Fast Open feature is supported by the OS, this callback may be invoked earlier. Note, even if the Fast Open is available and configured, it may not actually happen if the Fast Open Cookie is null or rejected by the server.
2. For a proxy connections, the handshake may happen after an observer returned by ConnectionObserver.onProxyConnect(Object) completes successfully.

Specified by:

onSecurityHandshake in interface ConnectionObserver

Parameters:

sslConfig - the SslConfig used when performing the security handshake.

Returns:

a new ConnectionObserver.SecurityHandshakeObserver that provides visibility into security handshake events

See Also:

• RFC7413: TCP Fast Open

connectionEstablished

public ConnectionObserver.DataObserver connectionEstablished(ConnectionInfo info)

Description copied from interface: ConnectionObserver

Callback when a non-multiplexed connection is established and ready.

Specified by:

connectionEstablished in interface ConnectionObserver

Parameters:

info - ConnectionInfo for the established connection

Returns:

a new ConnectionObserver.DataObserver that provides visibility into read and write events

multiplexedConnectionEstablished

public ConnectionObserver.MultiplexedObserver multiplexedConnectionEstablished(ConnectionInfo info)

Description copied from interface: ConnectionObserver

Callback when a multiplexed connection is established and ready.

Specified by:

multiplexedConnectionEstablished in interface ConnectionObserver

Parameters:

info - ConnectionInfo for the established connection

Returns:

a new ConnectionObserver.MultiplexedObserver that provides visibility into new streams

connectionWritabilityChanged

public void connectionWritabilityChanged(boolean isWritable)

Description copied from interface: ConnectionObserver

Callback when a writable state of the connection changes.

Specified by:

connectionWritabilityChanged in interface ConnectionObserver

Parameters:

isWritable - describes the current state of the connection: true when the I/O thread will perform the requested write operation immediately. If false, write requests will be queued until the I/O thread is ready to process the queued items and the transport will start applying backpressure.

connectionClosed

public void connectionClosed(Throwable error)

Description copied from interface: ConnectionObserver

Callback when the connection is closed due to an error.

Specified by:

connectionClosed in interface ConnectionObserver

Parameters:

error - an occurred error

connectionClosed

public void connectionClosed()

Description copied from interface: ConnectionObserver

Callback when the connection is closed.

Specified by:

connectionClosed in interface ConnectionObserver