io.rsocket.fragmentation

Class FragmentationDuplexConnection

java.lang.Object

io.rsocket.fragmentation.FragmentationDuplexConnection

All Implemented Interfaces:

Availability, Closeable, DuplexConnection, Disposable

public final class FragmentationDuplexConnection
extends Object
implements DuplexConnection

A DuplexConnection implementation that fragments and reassembles Frames.

See Also:

Fragmentation and Reassembly

Nested Class Summary

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

Disposable.Composite, Disposable.Swap

Constructor Summary

Constructors

Constructor and Description
FragmentationDuplexConnection(ByteBufAllocator byteBufAllocator, DuplexConnection delegate, int maxFragmentSize) Creates a new instance.
FragmentationDuplexConnection(DuplexConnection delegate, int maxFragmentSize) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
double	availability()
void	dispose()
boolean	isDisposed()
Mono<Void>	onClose() Returns a Publisher that completes when this RSocket is closed.
Flux<Frame>	receive() Returns a stream of all Frames received on this connection.
Mono<Void>	send(org.reactivestreams.Publisher<Frame> frames) Sends the source of Frames on this connection and returns the Publisher representing the result of this send.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.rsocket.DuplexConnection

sendOne

Constructor Detail

FragmentationDuplexConnection

public FragmentationDuplexConnection(DuplexConnection delegate,
                                     int maxFragmentSize)

Creates a new instance.

Parameters:

delegate - the DuplexConnection to decorate

maxFragmentSize - the maximum fragment size

Throws:

NullPointerException - if delegate is null

IllegalArgumentException - if maxFragmentSize is not positive

FragmentationDuplexConnection

public FragmentationDuplexConnection(ByteBufAllocator byteBufAllocator,
                                     DuplexConnection delegate,
                                     int maxFragmentSize)

Creates a new instance.

Parameters:

byteBufAllocator - the ByteBufAllocator to use

delegate - the DuplexConnection to decorate

maxFragmentSize - the maximum fragment size. A value of 0 indicates that frames should not be fragmented.

Throws:

NullPointerException - if byteBufAllocator or delegate are null

IllegalArgumentException - if maxFragmentSize is not positive

Method Detail

availability

public double availability()

Specified by:

availability in interface Availability

Specified by:

availability in interface DuplexConnection

Returns:

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

dispose

public void dispose()

Specified by:

dispose in interface Disposable

isDisposed

public boolean isDisposed()

Specified by:

isDisposed in interface Disposable

onClose

public Mono<Void> onClose()

Description copied from interface: Closeable

Returns a Publisher that completes when this RSocket is closed. A RSocket can be closed by explicitly calling Disposable.dispose() or when the underlying transport connection is closed.

Specified by:

onClose in interface Closeable

Returns:

A Publisher that completes when this RSocket close is complete.

receive

public Flux<Frame> receive()

Description copied from interface: DuplexConnection

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.

Specified by:

receive in interface DuplexConnection

Returns:

Stream of all Frames received.

send

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

Description copied from interface: DuplexConnection

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

Flow control

The passed Publisher must

Specified by:

send in interface DuplexConnection

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.