io.servicetalk.transport.netty.internal

Interface NettyPipelinedConnection<Req,Resp>

Type Parameters:

Req - Type of requests sent on this connection.

Resp - Type of responses read from this connection.

All Superinterfaces:

AsyncCloseable, ConnectionContext, ListenableAsyncCloseable, NettyConnectionContext

All Known Implementing Classes:

DefaultNettyPipelinedConnection

public interface NettyPipelinedConnection<Req,Resp>
extends 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

Modifier and Type	Interface and Description
static interface	NettyPipelinedConnection.Writer A writer to write a request on a connection.

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

NettyConnectionContext.FlushStrategyProvider

Method Summary

Modifier and Type	Method and Description
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.

Methods inherited from interface io.servicetalk.transport.netty.internal.NettyConnectionContext

defaultFlushStrategy, nettyChannel, onClosing, transportError, updateFlushStrategy

Methods inherited from interface io.servicetalk.transport.api.ConnectionContext

executionContext, localAddress, remoteAddress, sslSession

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

onClose

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

closeAsync, closeAsyncGracefully

Method Detail

request

Publisher<Resp> request(Req request)

Writes a Req object on this connection.

Use request(Object, Supplier) to override the predicate used to mark the end of response.

Parameters:

request - to write.

Returns:

Response Publisher for this request.

request

Publisher<Resp> request(NettyPipelinedConnection.Writer writer)

Writes on this connection a request encapsulated in the passed NettyPipelinedConnection.Writer.

Use request(Writer, Supplier) to override the predicate used to mark the end of response.

Parameters:

writer - to write the request.

Returns:

Response Publisher for this request.

request

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.

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

Publisher<Resp> request(Req request,
                        java.util.function.Supplier<java.util.function.Predicate<Resp>> terminalMsgPredicateSupplier)

Writes a Req object on this connection.

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

Publisher<Resp> request(Single<Req> request)

Send request produced by a Single on this connection.

Use request(Single, Supplier) to override the predicate used to mark the end of response.

Parameters:

request - to write.

Returns:

Response Publisher for this request.

request

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.

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

Publisher<Resp> request(Publisher<Req> request)

Send request(s) produced by a Publisher on this connection.

Use request(Publisher, Supplier) to override the predicate used to mark the end of response.

Parameters:

request - Publisher producing the request(s) to write.

Returns:

Response Publisher for this request.

request

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.

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

Publisher<Resp> request(Publisher<Req> request,
                        java.util.function.Supplier<NettyConnection.RequestNSupplier> requestNSupplierFactory)

Send request(s) produced by a Publisher on this connection.

Use request(Publisher, Supplier, Supplier) to override the predicate used to mark the end of response.

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

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.

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.