DefaultNettyPipelinedConnection

java.lang.Object
- io.servicetalk.transport.netty.internal.DefaultNettyPipelinedConnection<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, NettyConnectionContext, NettyPipelinedConnection<Req,Resp>
```
public final class DefaultNettyPipelinedConnection<Req,Resp>
extends java.lang.Object
implements NettyPipelinedConnection<Req,Resp>
```
Implementation of NettyPipelinedConnection using a NettyConnection.

Nested Class Summary
- Nested classes/interfaces inherited from interface io.servicetalk.transport.netty.internal.NettyPipelinedConnection
  NettyPipelinedConnection.Writer
- Nested classes/interfaces inherited from interface io.servicetalk.transport.netty.internal.NettyConnectionContext
  NettyConnectionContext.FlushStrategyProvider
- Nested classes/interfaces inherited from interface io.servicetalk.transport.api.ConnectionContext
  ConnectionContext.Protocol

Constructor Summary

Constructors
Constructor and Description

DefaultNettyPipelinedConnection(NettyConnection<Resp,Req> connection, int initialQueueSize)
New instance.

Constructors
Constructor and Description
`DefaultNettyPipelinedConnection(NettyConnection<Resp,Req> connection, int initialQueueSize)` New instance.

Method Summary

All Methods Instance Methods Concrete Methods
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.
`FlushStrategy`	`defaultFlushStrategy()` Returns the `FlushStrategy` used by default for this `NettyConnectionContext`.
`ExecutionContext`	`executionContext()` Get the `ExecutionContext` for this `ConnectionContext`.
`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`	`onClose()` Returns a `Completable` that is notified once the `ListenableAsyncCloseable` was closed.
`Completable`	`onClosing()` Returns a `Completable` that notifies when the connection has begun its closing sequence.
`ConnectionContext.Protocol`	`protocol()` Get the `ConnectionContext.Protocol` for this `ConnectionContext`.
`java.net.SocketAddress`	`remoteAddress()` The `SocketAddress` to which the associated connection is connected.
`Publisher<Resp>`	`request(NettyPipelinedConnection.Writer writer)` Writes on this connection a request encapsulated in the passed `NettyPipelinedConnection.Writer`.
`Publisher<Resp>`	`request(NettyPipelinedConnection.Writer writer, java.util.function.Supplier<java.util.function.Predicate<Resp>> terminalMsgPredicateSupplier)` Writes on this connection a request encapsulated in the passed `NettyPipelinedConnection.Writer`.
`Publisher<Resp>`	`request(Publisher<Req> request)` Send request(s) produced by a `Publisher` on this connection.
`Publisher<Resp>`	`request(Publisher<Req> request, java.util.function.Supplier<NettyConnection.RequestNSupplier> requestNSupplierFactory)` Send request(s) produced by a `Publisher` on this connection.
`Publisher<Resp>`	`request(Publisher<Req> request, java.util.function.Supplier<NettyConnection.RequestNSupplier> requestNSupplierFactory, java.util.function.Supplier<java.util.function.Predicate<Resp>> terminalMsgPredicateSupplier)` Send request(s) produced by a `Publisher` on this connection.
`Publisher<Resp>`	`request(Req request)` Writes a `Req` object on this connection.
`Publisher<Resp>`	`request(Req request, java.util.function.Supplier<java.util.function.Predicate<Resp>> terminalMsgPredicateSupplier)` Writes a `Req` object on this connection.
`Publisher<Resp>`	`request(Single<Req> request)` Send request produced by a `Single` on this connection.
`Publisher<Resp>`	`request(Single<Req> request, java.util.function.Supplier<java.util.function.Predicate<Resp>> terminalMsgPredicateSupplier)` Send request produced by a `Single` on this connection.
`Publisher<Resp>`	`request(java.util.function.Supplier<java.util.function.Predicate<Resp>> terminalMsgPredicateSupplier, Publisher<Req> request)` Send request(s) produced by a `Publisher` on this connection.
`<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.
`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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DefaultNettyPipelinedConnection
```
public DefaultNettyPipelinedConnection(NettyConnection<Resp,Req> connection,
                                       int initialQueueSize)
```
    New instance.
    
    Parameters:
    
    connection - NettyConnection requests to which are to be pipelined.
    
    initialQueueSize - Initial size for the write and read queues.
- Method Detail
  - request
```
public Publisher<Resp> request(Req request)
```
    Description copied from interface: NettyPipelinedConnection
    
    Writes a Req object on this connection.
    Use NettyPipelinedConnection.request(Object, Supplier) to override the predicate used to mark the end of response.
    
    Specified by:
    
    request in interface NettyPipelinedConnection<Req,Resp>
    
    Parameters:
    
    request - to write.
    
    Returns:
    
    Response Publisher for this request.
  - request
```
public Publisher<Resp> request(NettyPipelinedConnection.Writer writer)
```
    Description copied from interface: NettyPipelinedConnection
    
    Writes on this connection a request encapsulated in the passed NettyPipelinedConnection.Writer.
    Use NettyPipelinedConnection.request(Writer, Supplier) to override the predicate used to mark the end of response.
    
    Specified by:
    
    request in interface NettyPipelinedConnection<Req,Resp>
    
    Parameters:
    
    writer - to write the request.
    
    Returns:
    
    Response Publisher for this request.
  - request
```
public Publisher<Resp> request(NettyPipelinedConnection.Writer writer,
                               java.util.function.Supplier<java.util.function.Predicate<Resp>> terminalMsgPredicateSupplier)
```
    Description copied from interface: NettyPipelinedConnection
    
    Writes on this connection a request encapsulated in the passed NettyPipelinedConnection.Writer.
    
    Specified by:
    
    request in interface NettyPipelinedConnection<Req,Resp>
    
    Parameters:
    
    writer - to write the request.
    
    terminalMsgPredicateSupplier - Supplier of a dynamic Predicate for this request that will mark the end of the response.
    
    Returns:
    
    Response Publisher for this request.
  - request
```
public Publisher<Resp> request(Req request,
                               java.util.function.Supplier<java.util.function.Predicate<Resp>> terminalMsgPredicateSupplier)
```
    Description copied from interface: NettyPipelinedConnection
    
    Writes a Req object on this connection.
    
    Specified by:
    
    request in interface NettyPipelinedConnection<Req,Resp>
    
    Parameters:
    
    request - to write.
    
    terminalMsgPredicateSupplier - Supplier of a dynamic Predicate for this request that will mark the end of the response.
    
    Returns:
    
    Response Publisher for this request.
  - request
```
public Publisher<Resp> request(Single<Req> request)
```
    Description copied from interface: NettyPipelinedConnection
    
    Send request produced by a Single on this connection.
    Use NettyPipelinedConnection.request(Single, Supplier) to override the predicate used to mark the end of response.
    
    Specified by:
    
    request in interface NettyPipelinedConnection<Req,Resp>
    
    Parameters:
    
    request - to write.
    
    Returns:
    
    Response Publisher for this request.
  - request
```
public Publisher<Resp> request(Single<Req> request,
                               java.util.function.Supplier<java.util.function.Predicate<Resp>> terminalMsgPredicateSupplier)
```
    Description copied from interface: NettyPipelinedConnection
    
    Send request produced by a Single on this connection.
    
    Specified by:
    
    request in interface NettyPipelinedConnection<Req,Resp>
    
    Parameters:
    
    request - Single producing the request to write.
    
    terminalMsgPredicateSupplier - Supplier of a dynamic Predicate for this request that will mark the end of the response.
    
    Returns:
    
    Response Publisher for this request.
  - request
```
public Publisher<Resp> request(Publisher<Req> request)
```
    Description copied from interface: NettyPipelinedConnection
    
    Send request(s) produced by a Publisher on this connection.
    Use NettyPipelinedConnection.request(Publisher, Supplier) to override the predicate used to mark the end of response.
    
    Specified by:
    
    request in interface NettyPipelinedConnection<Req,Resp>
    
    Parameters:
    
    request - Publisher producing the request(s) to write.
    
    Returns:
    
    Response Publisher for this request.
  - request
```
public Publisher<Resp> request(java.util.function.Supplier<java.util.function.Predicate<Resp>> terminalMsgPredicateSupplier,
                               Publisher<Req> request)
```
    Description copied from interface: NettyPipelinedConnection
    
    Send request(s) produced by a Publisher on this connection.
    
    Specified by:
    
    request in interface NettyPipelinedConnection<Req,Resp>
    
    Parameters:
    
    terminalMsgPredicateSupplier - Supplier of a dynamic Predicate for this request that will mark the end of the response.
    
    request - Publisher producing the request(s) to write.
    
    Returns:
    
    Response Publisher for this request.
  - request
```
public Publisher<Resp> request(Publisher<Req> request,
                               java.util.function.Supplier<NettyConnection.RequestNSupplier> requestNSupplierFactory)
```
    Description copied from interface: NettyPipelinedConnection
    
    Send request(s) produced by a Publisher on this connection.
    Use NettyPipelinedConnection.request(Publisher, Supplier, Supplier) to override the predicate used to mark the end of response.
    
    Specified by:
    
    request in interface NettyPipelinedConnection<Req,Resp>
    
    Parameters:
    
    request - Publisher producing the request(s) to write.
    
    requestNSupplierFactory - A Supplier of NettyConnection.RequestNSupplier for this request.
    
    Returns:
    
    Response Publisher for this request.
  - request
```
public Publisher<Resp> request(Publisher<Req> request,
                               java.util.function.Supplier<NettyConnection.RequestNSupplier> requestNSupplierFactory,
                               java.util.function.Supplier<java.util.function.Predicate<Resp>> terminalMsgPredicateSupplier)
```
    Description copied from interface: NettyPipelinedConnection
    
    Send request(s) produced by a Publisher on this connection.
    
    Specified by:
    
    request in interface NettyPipelinedConnection<Req,Resp>
    
    Parameters:
    
    request - Publisher producing the request(s) to write.
    
    requestNSupplierFactory - A Supplier of NettyConnection.RequestNSupplier for this request.
    
    terminalMsgPredicateSupplier - Supplier of a dynamic Predicate for this request that will mark the end of the response.
    
    Returns:
    
    Response Publisher for this request.
  - 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
```
@Nullable
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.
  - 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.
  - 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.
  - 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.
  - 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.

Class DefaultNettyPipelinedConnection<Req,Resp>

Nested Class Summary

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

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

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultNettyPipelinedConnection

Method Detail

request

request

request

request

request

request

request

request

request

request

localAddress

remoteAddress

sslSession

executionContext

socketOption

protocol

transportError

onClosing

onClose

closeAsync

closeAsyncGracefully

nettyChannel

toString

updateFlushStrategy

defaultFlushStrategy