Package io.servicetalk.transport.netty.internal

Class NettyPipelinedConnection<Req,Resp>

java.lang.Object

io.servicetalk.transport.netty.internal.NettyPipelinedConnection<Req,Resp>

Type Parameters:

Req - Type of requests sent on this connection.

Resp - Type of responses read from this connection.

All Implemented Interfaces:

AsyncCloseable, ListenableAsyncCloseable, ConnectionContext, ConnectionInfo, NettyConnectionContext

public final class NettyPipelinedConnection<Req,Resp>
extends Object
implements NettyConnectionContext

Contract for using a NettyConnection to make pipelined requests, typically for a client.

Pipelining allows to have concurrent requests processed on the server but still deliver responses in order. This eliminates the need for request-response correlation, at the cost of head-of-line blocking.

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

Constructor Summary

Constructors

Constructor	Description
NettyPipelinedConnection(NettyConnection<Resp,Req> connection, int maxPipelinedRequests)	New instance.

Method Summary

Modifier and Type	Method	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.
FlushStrategy	defaultFlushStrategy()	Returns the FlushStrategy used by default for this NettyConnectionContext.
ExecutionContext<?>	executionContext()	Get the ExecutionContext for this ConnectionInfo.
SocketAddress	localAddress()	The SocketAddress to which the associated connection is bound.
io.netty.channel.Channel	nettyChannel()	Return the Netty Channel backing this connection.
Completable	onClose()	Returns a Completable that is notified once the ListenableAsyncCloseable was closed.
Completable	onClosing()	Returns a Completable that is notified when closing begins.
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()
Single<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.
Publisher<Resp>	write(Publisher<Req> requestPublisher)	Do a write operation in a pipelined fashion.
Publisher<Resp>	write(Publisher<Req> requestPublisher, Supplier<FlushStrategy> flushStrategySupplier, Supplier<WriteDemandEstimator> writeDemandEstimatorSupplier)	Do a write operation in a pipelined fashion.

Methods inherited from class java.lang.Object

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

Constructor Details

NettyPipelinedConnection

public NettyPipelinedConnection(NettyConnection<Resp,Req> connection,
 int maxPipelinedRequests)

New instance.

Parameters:

connection - NettyConnection requests to which are to be pipelined.

maxPipelinedRequests - The maximum number of pipelined requests.

Method Details

write

public Publisher<Resp> write(Publisher<Req> requestPublisher)

Do a write operation in a pipelined fashion.

Parameters:

requestPublisher - Publisher representing the stream of data for a single "request". impacts how many elements are requested from the requestPublisher depending upon channel writability.

Returns:

Response Publisher for this request.

write

public Publisher<Resp> write(Publisher<Req> requestPublisher,
 Supplier<FlushStrategy> flushStrategySupplier,
 Supplier<WriteDemandEstimator> writeDemandEstimatorSupplier)

Do a write operation in a pipelined fashion.

Parameters:

requestPublisher - Publisher representing the stream of data for a single "request".

flushStrategySupplier - The FlushStrategy to use for this write operation.

writeDemandEstimatorSupplier - A Supplier of WriteDemandEstimator for this request which impacts how many elements are requested from the requestPublisher depending upon channel writability.

Returns:

Response Publisher for this request.

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

@Nullable
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.

transportError

public Single<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.

Note:The Single is not required to be blocking-safe and should be offloaded if the SingleSource.Subscriber may block.

Specified by:

transportError in interface NettyConnectionContext

Returns:

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

onClosing

public Completable onClosing()

Description copied from interface: ListenableAsyncCloseable

Returns a Completable that is notified when closing begins.

Closing begin might be when a close operation is initiated locally (e.g. subscribing to AsyncCloseable.closeAsync()) or it could also be a transport event received from a remote peer (e.g. read a connection: close header).

For backwards compatibility this method maybe functionally equivalent to ListenableAsyncCloseable.onClose(). Therefore, provides a best-effort leading edge notification of closing, but may fall back to notification on trailing edge.

The goal of this method is often to notify asap when closing so this method may not be offloaded and care must be taken to avoid blocking if subscribing to the return Completable.

Specified by:

onClosing in interface ListenableAsyncCloseable

Specified by:

onClosing in interface NettyConnectionContext

Returns:

a Completable that is notified when closing begins.

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 Completable 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.

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 String toString()

Overrides:

toString in class 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.