io.rsocket.keepalive

Class KeepAliveConnection

java.lang.Object

io.rsocket.util.DuplexConnectionProxy

io.rsocket.keepalive.KeepAliveConnection

All Implemented Interfaces:

Availability, Closeable, DuplexConnection, ResumePositionsConnection, Disposable

public class KeepAliveConnection
extends DuplexConnectionProxy
implements ResumePositionsConnection

Nested Class Summary

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

Disposable.Composite, Disposable.Swap

Method Summary

Modifier and Type	Method and Description
void	acceptResumeState(ResumeStateHolder resumeStateHolder)
static KeepAliveConnection	ofClient(ByteBufAllocator allocator, DuplexConnection duplexConnection, Function<ByteBuf,KeepAliveData> keepAliveData, Consumer<Throwable> errorConsumer)
static KeepAliveConnection	ofServer(ByteBufAllocator allocator, DuplexConnection duplexConnection, Function<ByteBuf,KeepAliveData> keepAliveData, Consumer<Throwable> errorConsumer)
Mono<Void>	onClose() Returns a Publisher that completes when this RSocket is closed.
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.

Methods inherited from class io.rsocket.util.DuplexConnectionProxy

availability, delegate, dispose, isDisposed

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

availability, sendOne

Methods inherited from interface reactor.core.Disposable

dispose, isDisposed

Method Detail

ofClient

public static KeepAliveConnection ofClient(ByteBufAllocator allocator,
                                           DuplexConnection duplexConnection,
                                           Function<ByteBuf,KeepAliveData> keepAliveData,
                                           Consumer<Throwable> errorConsumer)

ofServer

public static KeepAliveConnection ofServer(ByteBufAllocator allocator,
                                           DuplexConnection duplexConnection,
                                           Function<ByteBuf,KeepAliveData> keepAliveData,
                                           Consumer<Throwable> errorConsumer)

send

public Mono<Void> send(org.reactivestreams.Publisher<ByteBuf> 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

Overrides:

send in class DuplexConnectionProxy

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.

receive

public Flux<ByteBuf> 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

Overrides:

receive in class DuplexConnectionProxy

Returns:

Stream of all Frames received.

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

Overrides:

onClose in class DuplexConnectionProxy

Returns:

A Publisher that completes when this RSocket close is complete.

acceptResumeState

public void acceptResumeState(ResumeStateHolder resumeStateHolder)

Specified by:

acceptResumeState in interface ResumePositionsConnection