io.rsocket.loadbalance

Class LoadbalanceRSocketClient

java.lang.Object

io.rsocket.loadbalance.LoadbalanceRSocketClient

All Implemented Interfaces:

Closeable, RSocketClient, Disposable

public class LoadbalanceRSocketClient
extends Object
implements RSocketClient

An implementation of RSocketClient backed by a pool of RSocket instances and using a LoadbalanceStrategy to select the RSocket to use for a given request.

Since:

1.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LoadbalanceRSocketClient.Builder Builder for creating an LoadbalanceRSocketClient.

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

Disposable.Composite, Disposable.Swap

Method Summary

Modifier and Type	Method and Description
static LoadbalanceRSocketClient.Builder	builder(org.reactivestreams.Publisher<List<LoadbalanceTarget>> targetPublisher) Return a builder for a LoadbalanceRSocketClient.
boolean	connect() Connect to the remote rsocket endpoint, if not yet connected.
static LoadbalanceRSocketClient	create(RSocketConnector connector, org.reactivestreams.Publisher<List<LoadbalanceTarget>> targetPublisher) Shortcut to create an LoadbalanceRSocketClient with round-robin load balancing.
void	dispose()
Mono<Void>	fireAndForget(Mono<Payload> payloadMono) Perform a Fire-and-Forget interaction via RSocket.fireAndForget(Payload).
Mono<Void>	metadataPush(Mono<Payload> payloadMono) Perform a Metadata Push via RSocket.metadataPush(Payload).
Mono<Void>	onClose() Returns a Mono that terminates when the instance is terminated by any reason.
Flux<Payload>	requestChannel(org.reactivestreams.Publisher<Payload> payloads) Perform a Request-Channel interaction via RSocket.requestChannel(Publisher).
Mono<Payload>	requestResponse(Mono<Payload> payloadMono) Perform a Request-Response interaction via RSocket.requestResponse(Payload).
Flux<Payload>	requestStream(Mono<Payload> payloadMono) Perform a Request-Stream interaction via RSocket.requestStream(Payload).
Mono<RSocket>	source() Return Mono that selects an RSocket from the underlying pool.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.rsocket.core.RSocketClient

from, from

Methods inherited from interface reactor.core.Disposable

isDisposed

Method Detail

onClose

public Mono<Void> onClose()

Description copied from interface: Closeable

Returns a Mono that terminates when the instance is terminated by any reason. Note, in case of error termination, the cause of error will be propagated as an error signal through Subscriber.onError(Throwable). Otherwise, Subscriber.onComplete() will be called.

Specified by:

onClose in interface Closeable

Specified by:

onClose in interface RSocketClient

Returns:

a Mono to track completion with success or error of the underlying resource. When the underlying resource is an `RSocket`, the Mono exposes stream 0 (i.e. connection level) errors.

connect

public boolean connect()

Description copied from interface: RSocketClient

Connect to the remote rsocket endpoint, if not yet connected. This method is a shortcut for RSocketClient#source().subscribe().

Specified by:

connect in interface RSocketClient

Returns:

true if an attempt to connect was triggered or if already connected, or false if the client is terminated.

source

public Mono<RSocket> source()

Return Mono that selects an RSocket from the underlying pool.

Specified by:

source in interface RSocketClient

fireAndForget

public Mono<Void> fireAndForget(Mono<Payload> payloadMono)

Description copied from interface: RSocketClient

Perform a Fire-and-Forget interaction via RSocket.fireAndForget(Payload). Allows multiple subscriptions and performs a request per subscriber.

Specified by:

fireAndForget in interface RSocketClient

requestResponse

public Mono<Payload> requestResponse(Mono<Payload> payloadMono)

Description copied from interface: RSocketClient

Perform a Request-Response interaction via RSocket.requestResponse(Payload). Allows multiple subscriptions and performs a request per subscriber.

Specified by:

requestResponse in interface RSocketClient

requestStream

public Flux<Payload> requestStream(Mono<Payload> payloadMono)

Description copied from interface: RSocketClient

Perform a Request-Stream interaction via RSocket.requestStream(Payload). Allows multiple subscriptions and performs a request per subscriber.

Specified by:

requestStream in interface RSocketClient

requestChannel

public Flux<Payload> requestChannel(org.reactivestreams.Publisher<Payload> payloads)

Description copied from interface: RSocketClient

Perform a Request-Channel interaction via RSocket.requestChannel(Publisher). Allows multiple subscriptions and performs a request per subscriber.

Specified by:

requestChannel in interface RSocketClient

metadataPush

public Mono<Void> metadataPush(Mono<Payload> payloadMono)

Description copied from interface: RSocketClient

Perform a Metadata Push via RSocket.metadataPush(Payload). Allows multiple subscriptions and performs a request per subscriber.

Specified by:

metadataPush in interface RSocketClient

dispose

public void dispose()

Specified by:

dispose in interface Disposable

create

public static LoadbalanceRSocketClient create(RSocketConnector connector,
                                              org.reactivestreams.Publisher<List<LoadbalanceTarget>> targetPublisher)

Shortcut to create an LoadbalanceRSocketClient with round-robin load balancing. Effectively a shortcut for:

 LoadbalanceRSocketClient.builder(targetPublisher)
    .connector(RSocketConnector.create())
    .build();
 

Parameters:

connector - a "template" for connecting to load balance targets

targetPublisher - refreshes the list of load balance targets periodically

Returns:

the created client instance

builder

public static LoadbalanceRSocketClient.Builder builder(org.reactivestreams.Publisher<List<LoadbalanceTarget>> targetPublisher)

Return a builder for a LoadbalanceRSocketClient.

Parameters:

targetPublisher - refreshes the list of load balance targets periodically

Returns:

the created builder