io.servicetalk.transport.api

Class DelegatingConnectionContext

java.lang.Object

io.servicetalk.transport.api.DelegatingConnectionContext

All Implemented Interfaces:

AsyncCloseable, ListenableAsyncCloseable, ConnectionContext

Direct Known Subclasses:

DelegatingHttpConnectionContext

public class DelegatingConnectionContext
extends java.lang.Object
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.ConnectionContext

ConnectionContext.Protocol

Constructor Summary

Constructors

Constructor and Description
DelegatingConnectionContext(ConnectionContext delegate) New instance.

Method Summary

Modifier and Type	Method and Description
Completable	closeAsync() Used to close/shutdown a resource.
Completable	closeAsyncGracefully() Used to close/shutdown a resource, similar to AsyncCloseable.closeAsync(), but attempts to cleanup state before abruptly closing.
protected ConnectionContext	delegate() Get the ConnectionContext that this class delegates to.
ExecutionContext	executionContext() Get the ExecutionContext for this ConnectionContext.
java.net.SocketAddress	localAddress() The SocketAddress to which the associated connection is bound.
Completable	onClose() Returns a Completable that is notified once the ListenableAsyncCloseable was closed.
ConnectionContext.Protocol	protocol() Get the ConnectionContext.Protocol for this ConnectionContext.
java.net.SocketAddress	remoteAddress() The SocketAddress to which the associated connection is connected.
<T> T	socketOption(java.net.SocketOption<T> option) Get the SocketOption value of type T for this ConnectionContext.
javax.net.ssl.SSLSession	sslSession() Get the SSLSession for this connection.

Methods inherited from class java.lang.Object

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

Constructor Detail

DelegatingConnectionContext

public DelegatingConnectionContext(ConnectionContext delegate)

New instance.

Parameters:

delegate - ConnectionContext to delegate all calls.

Method Detail

delegate

protected ConnectionContext delegate()

Get the ConnectionContext that this class delegates to.

Returns:

the ConnectionContext that this class delegates to.

localAddress

public java.net.SocketAddress localAddress()

Description copied from interface: ConnectionContext

The SocketAddress to which the associated connection is bound.

Specified by:

localAddress in interface ConnectionContext

Returns:

The SocketAddress to which the associated connection is bound.

remoteAddress

public java.net.SocketAddress remoteAddress()

Description copied from interface: ConnectionContext

The SocketAddress to which the associated connection is connected.

Specified by:

remoteAddress in interface ConnectionContext

Returns:

The SocketAddress to which the associated connection is connected.

sslSession

@Nullable
public javax.net.ssl.SSLSession sslSession()

Description copied from interface: ConnectionContext

Get the SSLSession for this connection.

Specified by:

sslSession in interface ConnectionContext

Returns:

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

executionContext

public ExecutionContext executionContext()

Description copied from interface: ConnectionContext

Get the ExecutionContext for this ConnectionContext.

The ExecutionContext.ioExecutor() will represent the thread responsible for IO for this ConnectionContext. 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 ConnectionContext

Returns:

the ExecutionContext for this ConnectionContext.

socketOption

public <T> T socketOption(java.net.SocketOption<T> option)

Description copied from interface: ConnectionContext

Get the SocketOption value of type T for this ConnectionContext.

Specified by:

socketOption in interface ConnectionContext

Type Parameters:

T - the type of the SocketOption value.

Parameters:

option - SocketOption to get.

Returns:

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

See Also:

StandardSocketOptions, ServiceTalkSocketOptions

protocol

public ConnectionContext.Protocol protocol()

Description copied from interface: ConnectionContext

Get the ConnectionContext.Protocol for this ConnectionContext.

Specified by:

protocol in interface ConnectionContext

Returns:

the ConnectionContext.Protocol for this ConnectionContext.

onClose

public Completable onClose()

Description copied from interface: ListenableAsyncCloseable

Returns a Completable that is notified once the ListenableAsyncCloseable was closed.

Specified by:

onClose in interface ListenableAsyncCloseable

Returns:

the Completable that is notified on close.

closeAsync

public Completable closeAsync()

Description copied from interface: AsyncCloseable

Used to close/shutdown a resource.

Specified by:

closeAsync in interface AsyncCloseable

Returns:

A CompletableSource that is notified once the close is complete.

closeAsyncGracefully

public Completable closeAsyncGracefully()

Description copied from interface: AsyncCloseable

Used to close/shutdown a resource, similar to AsyncCloseable.closeAsync(), but attempts to cleanup state before abruptly closing. This provides a hint that implementations can use to stop accepting new work and finish in flight work. This method is implemented on a "best effort" basis and may be equivalent to AsyncCloseable.closeAsync().

Note: Implementations may or may not apply a timeout for this operation to complete, if a caller does not want to wait indefinitely, and are unsure if the implementation applies a timeout, it is advisable to apply a timeout and force a call to AsyncCloseable.closeAsync().

Specified by:

closeAsyncGracefully in interface AsyncCloseable

Returns:

A Completable that is notified once the close is complete.