Package io.servicetalk.transport.api

Class DelegatingConnectionContext

java.lang.Object

io.servicetalk.concurrent.api.DelegatingAsyncCloseable<T>

io.servicetalk.concurrent.api.DelegatingListenableAsyncCloseable<ConnectionContext>

io.servicetalk.transport.api.DelegatingConnectionContext

All Implemented Interfaces:

AsyncCloseable, ListenableAsyncCloseable, ConnectionContext, ConnectionInfo

Direct Known Subclasses:

DelegatingHttpConnectionContext

public class DelegatingConnectionContext
extends DelegatingListenableAsyncCloseable<ConnectionContext>
implements ConnectionContext

A ConnectionContext implementation that delegates all calls to a provided ConnectionContext. Any of the methods can be overridden by implementations to change the behavior.

Nested Class Summary

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

ConnectionInfo.Protocol

Constructor Summary

Constructors

Constructor	Description
DelegatingConnectionContext(ConnectionContext delegate)	New instance.

Method Summary

Modifier and Type	Method	Description
String	connectionId()	String representation of an identifier for this connection (can be globally non-unique).
protected ConnectionContext	delegate()	Get the ConnectionContext that this class delegates to.
ExecutionContext<?>	executionContext()	Get the ExecutionContext for this ConnectionInfo.
SocketAddress	localAddress()	The SocketAddress to which the associated connection is bound.
ConnectionContext	parent()	Returns a reference to a parent ConnectionContext if any.
ConnectionInfo.Protocol	protocol()	Get the ConnectionInfo.Protocol for this ConnectionInfo.
SocketAddress	remoteAddress()	The SocketAddress to which the associated connection is connected.
<T> T	socketOption(SocketOption<T> option)	Get the SocketOption value of type T for this ConnectionInfo.
SslConfig	sslConfig()	Get the SslConfig for this connection.
SSLSession	sslSession()	Get the SSLSession for this connection.
String	toString()	String representation of the current connection information.

Methods inherited from class io.servicetalk.concurrent.api.DelegatingListenableAsyncCloseable

onClose, onClosing

Methods inherited from class io.servicetalk.concurrent.api.DelegatingAsyncCloseable

closeAsync, closeAsyncGracefully

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.servicetalk.concurrent.api.AsyncCloseable

closeAsync, closeAsyncGracefully

Methods inherited from interface io.servicetalk.concurrent.api.ListenableAsyncCloseable

onClose, onClosing

Constructor Details

DelegatingConnectionContext

public DelegatingConnectionContext(ConnectionContext delegate)

New instance.

Parameters:

delegate - ConnectionContext to delegate all calls.

Method Details

delegate

protected ConnectionContext delegate()

Get the ConnectionContext that this class delegates to.

Overrides:

delegate in class DelegatingListenableAsyncCloseable<ConnectionContext>

Returns:

the ConnectionContext that this class delegates to.

connectionId

public String connectionId()

Description copied from interface: ConnectionInfo

String representation of an identifier for this connection (can be globally non-unique).

Note: this identifier is a string representation of an ID assigned by underlying implementation of the connection. Whether it's globally unique or not depends on that implementation. It's not recommended to use this identifier as a map key for storing connection related data. It can be used for logging purposes to correlate events happening on this connection with other logs or events related to the same instance. If necessary, uniqueness can be ensured by using a combination of the current identifier with ConnectionInfo.localAddress() and ConnectionInfo.remoteAddress().

Specified by:

connectionId in interface ConnectionInfo

Returns:

String representation of an identifier for this connection (can be globally non-unique).

localAddress

public SocketAddress localAddress()

Description copied from interface: ConnectionInfo

The SocketAddress to which the associated connection is bound.

Specified by:

localAddress in interface ConnectionInfo

Returns:

The SocketAddress to which the associated connection is bound.

remoteAddress

public SocketAddress remoteAddress()

Description copied from interface: ConnectionInfo

The SocketAddress to which the associated connection is connected.

Specified by:

remoteAddress in interface ConnectionInfo

Returns:

The SocketAddress to which the associated connection is connected.

sslConfig

@Nullable
public SslConfig sslConfig()

Description copied from interface: ConnectionInfo

Get the SslConfig for this connection.

Specified by:

sslConfig in interface ConnectionInfo

Returns:

The SslConfig if SSL/TLS is configured, or null otherwise.

sslSession

@Nullable
public SSLSession sslSession()

Description copied from interface: ConnectionInfo

Get the SSLSession for this connection.

Specified by:

sslSession in interface ConnectionInfo

Returns:

The SSLSession if SSL/TLS is enabled, or null otherwise.

executionContext

public ExecutionContext<?> executionContext()

Description copied from interface: ConnectionInfo

Get the ExecutionContext for this ConnectionInfo.

The ExecutionContext.ioExecutor() will represent the thread responsible for IO for this ConnectionInfo. Note that this maybe different that what was used to create this object because at this time a specific IoExecutor has been selected.

Specified by:

executionContext in interface ConnectionInfo

Returns:

the ExecutionContext for this ConnectionInfo.

socketOption

public <T> T socketOption(SocketOption<T> option)

Description copied from interface: ConnectionInfo

Get the SocketOption value of type T for this ConnectionInfo.

Specified by:

socketOption in interface ConnectionInfo

Type Parameters:

T - the type of the SocketOption value.

Parameters:

option - SocketOption to get.

Returns:

the SocketOption value of type T for this ConnectionInfo or null if this SocketOption is not supported by this ConnectionInfo.

See Also:

• StandardSocketOptions
• ServiceTalkSocketOptions

protocol

public ConnectionInfo.Protocol protocol()

Description copied from interface: ConnectionInfo

Get the ConnectionInfo.Protocol for this ConnectionInfo.

Specified by:

protocol in interface ConnectionInfo

Returns:

the ConnectionInfo.Protocol for this ConnectionInfo.

parent

@Nullable
public ConnectionContext parent()

Description copied from interface: ConnectionContext

Returns a reference to a parent ConnectionContext if any.

This method is useful when multiple virtual streams are multiplexed over a single connection to get access to the actual ConnectionContext that represents network.

Specified by:

parent in interface ConnectionContext

Returns:

a reference to a parent ConnectionContext if any. Otherwise, returns null.

toString

public String toString()

Description copied from interface: ConnectionInfo

String representation of the current connection information.

Specified by:

toString in interface ConnectionInfo

Overrides:

toString in class DelegatingAsyncCloseable<ConnectionContext>

Returns:

String representation of the current connection information.