rsocket-core 1.1.4 · io.rsocket.DuplexConnection

Method Summary

Modifier and Type	Method and Description
public ByteBufAllocator	Returns: the `ByteBufAllocator` alloc() Returns the assigned `ByteBufAllocator`.
public default double	availability() Implements io.rsocket.Availability.availability.
public Flux<ByteBuf>	Returns: Stream of all `Frame`s received. receive() Returns a stream of all `Frame`s received on this connection.
public SocketAddress	Returns: the address remoteAddress() Return the remote address that this connection is connected to.
public void	sendErrorAndClose(RSocketErrorException to encode in the error frame errorException) Send an error frame and after it is successfully sent, close the connection.
public void	sendFrame(int to which the given frame relates streamId, ByteBuf with the encoded content frame) Delivers the given frame to the underlying transport connection.

Inherited from io.rsocket.Closeable:: onClose

Method Detail

alloc back to summary

alloc	back to summary
public ByteBufAllocator alloc() Returns the assigned `ByteBufAllocator`. Returns:ByteBufAllocator the `ByteBufAllocator`

public ByteBufAllocator alloc()

Returns the assigned ByteBufAllocator.

Returns:ByteBufAllocator: the ByteBufAllocator

availability	back to summary
public default double availability() Implements io.rsocket.Availability.availability. Returns:double Doc from io.rsocket.Availability.availability. a positive numbers representing the availability of the entity. Higher is better, 0.0 means not available Annotations @Override

availability

back to summary

public default double availability()

Implements io.rsocket.Availability.availability.

Returns:double

Doc from io.rsocket.Availability.availability.

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

Annotations

@Override

receive back to summary

receive	back to summary
public Flux<ByteBuf> receive() Returns a stream of all `Frame`s 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:Flux<ByteBuf> Stream of all `Frame`s received.

public 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:Flux<ByteBuf>: Stream of all Frames received.

remoteAddress back to summary

remoteAddress	back to summary
public 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 `java.net.InetSocketAddress`. For local transport, it is `io.rsocket.transport.local.LocalSocketAddress`. Returns:SocketAddress the address Since 1.1

public 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 java.net.InetSocketAddress. For local transport, it is io.rsocket.transport.local.LocalSocketAddress.

Returns:SocketAddress: the address
Since: 1.1

sendErrorAndClose	back to summary
public void sendErrorAndClose(RSocketErrorException errorException) Send an error frame and after it is successfully sent, close the connection. Parameters errorException:RSocketErrorException to encode in the error frame

sendErrorAndClose

back to summary

public void sendErrorAndClose(RSocketErrorException errorException)

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

Parameters

errorException:RSocketErrorException: to encode in the error frame

sendFrame	back to summary
public 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:int to which the given frame relates frame:ByteBuf with the encoded content

sendFrame

back to summary

public 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:int: to which the given frame relates
frame:ByteBuf: with the encoded content

public Interface DuplexConnection

Method Summary

Method Detail