io.rsocket

Interface DuplexConnection

All Superinterfaces:

Availability, Closeable, Disposable

All Known Implementing Classes:

BaseDuplexConnection, 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.
SocketAddress	remoteAddress() Return the remote address that this connection is connected to.
void	sendErrorAndClose(RSocketErrorException errorException) Send an error frame and after it is successfully sent, close the connection.
void	sendFrame(int streamId, ByteBuf frame) Delivers the given frame to the underlying transport connection.

Methods inherited from interface io.rsocket.Closeable

onClose

Methods inherited from interface reactor.core.Disposable

dispose, isDisposed

Method Detail

sendFrame

void sendFrame(int streamId,
               ByteBuf frame)

Delivers the given frame to the underlying transport connection. This method is non-blocking and can be safely executed from multiple threads. This method does not provide any flow-control mechanism.

Parameters:

streamId - to which the given frame relates

frame - with the encoded content

sendErrorAndClose

void sendErrorAndClose(RSocketErrorException errorException)

Send an error frame and after it is successfully sent, close the connection.

Parameters:

errorException - to encode in the error frame

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

remoteAddress

SocketAddress remoteAddress()

Return the remote address that this connection is connected to. The returned SocketAddress varies by transport type and should be downcast to obtain more detailed information. For TCP and WebSocket, the address type is InetSocketAddress. For local transport, it is io.rsocket.transport.local.LocalSocketAddress.

Returns:

the address

Since:

1.1

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