io.servicetalk.transport.netty.internal

Interface NettyConnection<Read,Write>

Type Parameters:

Read - Type of objects read from this connection.

Write - Type of objects written to this connection.

All Superinterfaces:

AsyncCloseable, ConnectionContext, ListenableAsyncCloseable, NettyConnectionContext

All Known Implementing Classes:

DefaultNettyConnection

public interface NettyConnection<Read,Write>
extends NettyConnectionContext

A wrapper over a physical connection providing a way to read/write as a Publisher.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	NettyConnection.RequestNSupplier A supplier that provides a correct value of n for calls to PublisherSource.Subscription.request(long) per PublisherSource.Subscription.
static class	NettyConnection.TerminalPredicate<Read> A dynamic Predicate to detect terminal message in a stream as returned by read().

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

Method Summary

Modifier and Type	Method and Description
Publisher<Read>	read() Returns Publisher that emits all items as read from this connection.
NettyConnection.TerminalPredicate<Read>	terminalMsgPredicate() Returns the NettyConnection.TerminalPredicate associated with this NettyConnection to detect terminal messages for the otherwise infinite Publisher returned by read().
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<NettyConnection.RequestNSupplier> requestNSupplierFactory) Writes all elements emitted by the passed Publisher on this connection.
Completable	writeAndFlush(Single<Write> write) Write and flushes the object emitted by the passed Single on this connection.
Completable	writeAndFlush(Write write) Write and flushes the passed Buffer 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, protocol, remoteAddress, socketOption, sslSession

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

onClose

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

closeAsync, closeAsyncGracefully

Method Detail

read

Publisher<Read> read()

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

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.

terminalMsgPredicate

NettyConnection.TerminalPredicate<Read> terminalMsgPredicate()

Returns the NettyConnection.TerminalPredicate associated with this NettyConnection to detect terminal messages for the otherwise infinite Publisher returned by read().

Returns:

NettyConnection.TerminalPredicate for this connection.

write

Completable write(Publisher<Write> write)

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

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

Completable write(Publisher<Write> write,
                  java.util.function.Supplier<NettyConnection.RequestNSupplier> requestNSupplierFactory)

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

Parameters:

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

requestNSupplierFactory - A Supplier of NettyConnection.RequestNSupplier 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.

writeAndFlush

Completable writeAndFlush(Single<Write> write)

Write and flushes the object emitted by the passed Single on this connection.

Parameters:

write - Single, result of which is written on this connection.

Returns:

Completable that terminates as follows:

• With an error, if the item emitted can not be written successfully on the connection.
• With an error, If Single emits an error.
• With an error, if there is a already an active write on this connection.
• Successfully when result of the Single is written successfully.

writeAndFlush

Completable writeAndFlush(Write write)

Write and flushes the passed Buffer on this connection.

Parameters:

write - Buffer to write on this connection.

Returns:

Completable that terminates as follows:

• With an error, if Buffer could not be written successfully on the connection.
• With an error, if there is a already an active write on this connection.
• Successfully, if Buffer could was written successfully on the connection.