io.rsocket

Interface DuplexConnection

All Superinterfaces:

Availability, Closeable, Disposable

All Known Implementing Classes:

BaseDuplexConnection, DuplexConnectionProxy, FragmentationDuplexConnection, ReassemblyDuplexConnection, ResumableDuplexConnection

public interface DuplexConnection
extends Availability, Closeable

Represents a connection with input/output that the protocol uses.

Nested Class Summary

Nested classes/interfaces inherited from interface reactor.core.Disposable

Disposable.Composite, Disposable.Swap

Method Summary

Modifier and Type	Method and Description
ByteBufAllocator	alloc() Returns the assigned ByteBufAllocator.
default double	availability()
Flux<ByteBuf>	receive() Returns a stream of all Frames received on this connection.
Mono<Void>	send(org.reactivestreams.Publisher<ByteBuf> frames) Sends the source of Frames on this connection and returns the Publisher representing the result of this send.
default Mono<Void>	sendOne(ByteBuf frame) Sends a single Frame on this connection and returns the Publisher representing the result of this send.

Methods inherited from interface io.rsocket.Closeable

onClose

Methods inherited from interface reactor.core.Disposable

dispose, isDisposed

Method Detail

send

Mono<Void> send(org.reactivestreams.Publisher<ByteBuf> frames)

Sends the source of Frames on this connection and returns the Publisher representing the result of this send.

Flow control

The passed Publisher must

Parameters:

frames - Stream of Frames to send on the connection.

Returns:

Publisher that completes when all the frames are written on the connection successfully and errors when it fails.

Throws:

NullPointerException - if frames is null

sendOne

default Mono<Void> sendOne(ByteBuf frame)

Sends a single Frame on this connection and returns the Publisher representing the result of this send.

Parameters:

frame - Frame to send.

Returns:

Publisher that completes when the frame is written on the connection successfully and errors when it fails.

receive

Flux<ByteBuf> receive()

Returns a stream of all Frames received on this connection.

Completion

Returned Publisher MUST never emit a completion event (Subscriber.onComplete().

Error

Returned Publisher can error with various transport errors. If the underlying physical connection is closed by the peer, then the returned stream from here MUST emit an ClosedChannelException.

Multiple Subscriptions

Returned Publisher is not required to support multiple concurrent subscriptions. RSocket will never have multiple subscriptions to this source. Implementations MUST emit an IllegalStateException for subsequent concurrent subscriptions, if they do not support multiple concurrent subscriptions.

Returns:

Stream of all Frames received.

alloc

ByteBufAllocator alloc()

Returns the assigned ByteBufAllocator.

Returns:

the ByteBufAllocator

availability

default double availability()

Specified by:

availability in interface Availability

Returns:

a positive numbers representing the availability of the entity. Higher is better, 0.0 means not available