Package io.servicetalk.transport.netty.internal

Class DefaultNettyConnection<Read,Write>

java.lang.Object

io.servicetalk.transport.netty.internal.NettyChannelListenableAsyncCloseable

io.servicetalk.transport.netty.internal.DefaultNettyConnection<Read,Write>

Type Parameters:

Read - Type of objects read from this connection.

Write - Type of objects written to this connection.

All Implemented Interfaces:

AsyncCloseable, ListenableAsyncCloseable, ConnectionContext, ConnectionInfo, NettyConnection<Read,Write>, NettyConnectionContext

public final class DefaultNettyConnection<Read,Write>
extends NettyChannelListenableAsyncCloseable
implements NettyConnection<Read,Write>

Implementation of NettyConnection backed by a netty Channel.

Nested Class Summary

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

ConnectionInfo.Protocol

Nested classes/interfaces inherited from interface io.servicetalk.transport.netty.internal.NettyConnectionContext

NettyConnectionContext.FlushStrategyProvider

Method Summary

Modifier and Type	Method	Description
FlushStrategy	defaultFlushStrategy()	Returns the FlushStrategy used by default for this NettyConnectionContext.
protected void	doCloseAsyncGracefully()	Initiate graceful closure.
ExecutionContext	executionContext()	Get the ExecutionContext for this ConnectionInfo.
static <Read,Write> Single<DefaultNettyConnection<Read,Write>>	initChannel(io.netty.channel.Channel channel, BufferAllocator allocator, Executor executor, java.util.function.Predicate<Read> terminalPredicate, CloseHandler closeHandler, FlushStrategy flushStrategy, java.lang.Long idleTimeoutMs, ChannelInitializer initializer, ExecutionStrategy executionStrategy, ConnectionInfo.Protocol protocol, ConnectionObserver observer, boolean isClient)	Given a Channel this will initialize the ChannelPipeline and create a DefaultNettyConnection.
static <Read,Write> DefaultNettyConnection<Read,Write>	initChildChannel(io.netty.channel.Channel channel, BufferAllocator allocator, Executor executor, java.util.function.Predicate<Read> terminalPredicate, CloseHandler closeHandler, FlushStrategy flushStrategy, java.lang.Long idleTimeoutMs, ExecutionStrategy executionStrategy, ConnectionInfo.Protocol protocol, javax.net.ssl.SSLSession sslSession, io.netty.channel.ChannelConfig parentChannelConfig, ConnectionObserver.StreamObserver streamObserver, boolean isClient, java.util.function.UnaryOperator<java.lang.Throwable> enrichProtocolError)	Given a Channel this will initialize the ChannelPipeline just to create a DefaultNettyConnection.
java.net.SocketAddress	localAddress()	The SocketAddress to which the associated connection is bound.
io.netty.channel.Channel	nettyChannel()	Return the Netty Channel backing this connection.
Completable	onClosing()	Returns a Completable that notifies when the connection has begun its closing sequence.
ConnectionInfo.Protocol	protocol()	Get the ConnectionInfo.Protocol for this ConnectionInfo.
Publisher<Read>	read()	Returns Publisher that emits all items as read from this connection.
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 ConnectionInfo.
javax.net.ssl.SSLSession	sslSession()	Get the SSLSession for this connection.
java.lang.String	toString()
Single<java.lang.Throwable>	transportError()	Returns a Single<Throwable> that may terminate with an error, if an error is observed at the transport.
Cancellable	updateFlushStrategy(NettyConnectionContext.FlushStrategyProvider strategyProvider)	Updates FlushStrategy associated with this connection.
Completable	write(Publisher<Write> write)	Writes all elements emitted by the passed Publisher on this connection.
Completable	write(Publisher<Write> write, java.util.function.Supplier<FlushStrategy> flushStrategySupplier, java.util.function.Supplier<WriteDemandEstimator> demandEstimatorSupplier)	Writes all elements emitted by the passed Publisher on this connection.

Methods inherited from class io.servicetalk.transport.netty.internal.NettyChannelListenableAsyncCloseable

channel, closeAsync, closeAsyncGracefully, onClose

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

Method Detail

initChildChannel

public static <Read,Write> DefaultNettyConnection<Read,Write> initChildChannel(io.netty.channel.Channel channel,
                                                                                           BufferAllocator allocator,
                                                                                           Executor executor,
                                                                                           java.util.function.Predicate<Read> terminalPredicate,
                                                                                           CloseHandler closeHandler,
                                                                                           FlushStrategy flushStrategy,
                                                                                           @Nullable
                                                                                           java.lang.Long idleTimeoutMs,
                                                                                           ExecutionStrategy executionStrategy,
                                                                                           ConnectionInfo.Protocol protocol,
                                                                                           @Nullable
                                                                                           javax.net.ssl.SSLSession sslSession,
                                                                                           @Nullable
                                                                                           io.netty.channel.ChannelConfig parentChannelConfig,
                                                                                           ConnectionObserver.StreamObserver streamObserver,
                                                                                           boolean isClient,
                                                                                           java.util.function.UnaryOperator<java.lang.Throwable> enrichProtocolError)

Given a Channel this will initialize the ChannelPipeline just to create a DefaultNettyConnection. It is assumed this is a child channel and all TLS handshaking is completed.

Type Parameters:

Read - Type of objects read from the NettyConnection.

Write - Type of objects written to the NettyConnection.

Parameters:

channel - A newly created Channel.

allocator - The BufferAllocator to use for the DefaultNettyConnection.

executor - The Executor to use for the DefaultNettyConnection.

terminalPredicate - Used to determine which inbound signal on the read() stream terminates the current message framing and will allow a resubscribe to consume the next framing.

closeHandler - Manages the half closure of the DefaultNettyConnection.

flushStrategy - Manages flushing of data for the DefaultNettyConnection.

idleTimeoutMs - Value for IDLE_TIMEOUT socket option.

executionStrategy - Used to derive the executionContext().

protocol - ConnectionInfo.Protocol for the returned DefaultNettyConnection.

sslSession - Provides access to the SSLSession associated with this connection.

parentChannelConfig - ChannelConfig of the parent Channel to query SocketOptions.

streamObserver - ConnectionObserver.StreamObserver to report internal events.

isClient - tells if this Channel is for the client.

enrichProtocolError - enriches protocol-specific Throwables.

Returns:

A Single that completes with a DefaultNettyConnection after the channel is activated and ready to use.

initChannel

public static <Read,Write> Single<DefaultNettyConnection<Read,Write>> initChannel(io.netty.channel.Channel channel,
                                                                                              BufferAllocator allocator,
                                                                                              Executor executor,
                                                                                              java.util.function.Predicate<Read> terminalPredicate,
                                                                                              CloseHandler closeHandler,
                                                                                              FlushStrategy flushStrategy,
                                                                                              @Nullable
                                                                                              java.lang.Long idleTimeoutMs,
                                                                                              ChannelInitializer initializer,
                                                                                              ExecutionStrategy executionStrategy,
                                                                                              ConnectionInfo.Protocol protocol,
                                                                                              ConnectionObserver observer,
                                                                                              boolean isClient)

Given a Channel this will initialize the ChannelPipeline and create a DefaultNettyConnection. The resulting single will complete after the TLS handshake has completed (if applicable) or otherwise after the channel is active and ready to use.

Type Parameters:

Read - Type of objects read from the NettyConnection.

Write - Type of objects written to the NettyConnection.

Parameters:

channel - A newly created Channel.

allocator - The BufferAllocator to use for the DefaultNettyConnection.

executor - The Executor to use for the DefaultNettyConnection.

terminalPredicate - Used to determine which inbound signal on the read() stream terminates the current message framing and will allow a resubscribe to consume the next framing.

closeHandler - Manages the half closure of the DefaultNettyConnection.

flushStrategy - Manages flushing of data for the DefaultNettyConnection.

idleTimeoutMs - Value for IDLE_TIMEOUT socket option.

initializer - Synchronously initializes the pipeline upon subscribe.

executionStrategy - ExecutionStrategy to use for this connection.

protocol - ConnectionInfo.Protocol for the returned DefaultNettyConnection.

observer - ConnectionObserver to report network events.

isClient - tells if this Channel is for the client.

Returns:

A Single that completes with a DefaultNettyConnection after the channel is activated and ready to use.

read

public Publisher<Read> read()

Description copied from interface: NettyConnection

Returns Publisher that emits all items as read from this connection.

Specified by:

read in interface NettyConnection<Read,Write>

Returns:

Publisher that emits all items as read from this connection. Concurrent subscribes when a PublisherSource.Subscriber is already active) are disallowed but sequential subscribes when a previous PublisherSource.Subscriber has terminated) are allowed.

write

public Completable write(Publisher<Write> write)

Description copied from interface: NettyConnection

Writes all elements emitted by the passed Publisher on this connection.

Specified by:

write in interface NettyConnection<Read,Write>

Parameters:

write - Publisher, all objects emitted from which are written on this connection.

Returns:

Completable that terminates as follows:

• With an error, if any item emitted can not be written successfully on the connection.
• With an error, if Publisher emits an error.
• With an error, if there is a already an active write on this connection.
• Successfully when Publisher completes and all items emitted are written successfully.

write

public Completable write(Publisher<Write> write,
                         java.util.function.Supplier<FlushStrategy> flushStrategySupplier,
                         java.util.function.Supplier<WriteDemandEstimator> demandEstimatorSupplier)

Description copied from interface: NettyConnection

Writes all elements emitted by the passed Publisher on this connection.

Specified by:

write in interface NettyConnection<Read,Write>

Parameters:

write - Publisher, all objects emitted from which are written on this connection.

flushStrategySupplier - Supplier of FlushStrategy which controls the flush operations for this write.

demandEstimatorSupplier - A Supplier of WriteDemandEstimator for this write.

Returns:

Completable that terminates as follows:

• With an error, if any item emitted can not be written successfully on the connection.
• With an error, if Publisher emits an error.
• With an error, if there is a already an active write on this connection.
• Successfully when Publisher completes and all items emitted are written successfully.

doCloseAsyncGracefully

protected void doCloseAsyncGracefully()

Description copied from class: NettyChannelListenableAsyncCloseable

Initiate graceful closure.

Overrides:

doCloseAsyncGracefully in class NettyChannelListenableAsyncCloseable

localAddress

public java.net.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 java.net.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.

sslSession

public javax.net.ssl.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

@Nullable
public <T> T socketOption(java.net.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.

onClosing

public Completable onClosing()

Description copied from interface: NettyConnectionContext

Returns a Completable that notifies when the connection has begun its closing sequence.

Specified by:

onClosing in interface NettyConnectionContext

Returns:

a Completable that notifies when the connection has begun its closing sequence. A configured CloseHandler will determine whether more reads or writes will be allowed on this NettyConnectionContext.

nettyChannel

public io.netty.channel.Channel nettyChannel()

Description copied from interface: NettyConnectionContext

Return the Netty Channel backing this connection.

Specified by:

nettyChannel in interface NettyConnectionContext

Returns:

the Netty Channel backing this connection.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

updateFlushStrategy

public Cancellable updateFlushStrategy(NettyConnectionContext.FlushStrategyProvider strategyProvider)

Description copied from interface: NettyConnectionContext

Updates FlushStrategy associated with this connection. Updated FlushStrategy will be used in any subsequent writes on this connection.

Specified by:

updateFlushStrategy in interface NettyConnectionContext

Parameters:

strategyProvider - NettyConnectionContext.FlushStrategyProvider to provide a new FlushStrategy. NettyConnectionContext.FlushStrategyProvider.computeFlushStrategy(FlushStrategy, boolean) MAY be invoked multiple times for a single call to this method and is expected to be idempotent.

Returns:

A Cancellable that will cancel this update.

defaultFlushStrategy

public FlushStrategy defaultFlushStrategy()

Description copied from interface: NettyConnectionContext

Returns the FlushStrategy used by default for this NettyConnectionContext.

Specified by:

defaultFlushStrategy in interface NettyConnectionContext

Returns:

The FlushStrategy used by default for this NettyConnectionContext.

transportError

public Single<java.lang.Throwable> transportError()

Description copied from interface: NettyConnectionContext

Returns a Single<Throwable> that may terminate with an error, if an error is observed at the transport.

Specified by:

transportError in interface NettyConnectionContext

Returns:

a Single<Throwable> that may terminate with an error, if an error is observed at the transport.