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

Modifier and Type	Field and Description
private final RSocketPool	rSocketPool

Access	Constructor and Description
private	LoadbalanceRSocketClient(RSocketPool rSocketPool)

Method Summary

Modifier and Type	Method and Description
public static LoadbalanceRSocketClient.Builder	Returns: the created builder builder(Publisher<List<LoadbalanceTarget>> refreshes the list of load balance targets periodically targetPublisher) Return a builder for a `LoadbalanceRSocketClient`.
public boolean	connect() Overrides default io.rsocket.core.RSocketClient.connect. Connect to the remote rsocket endpoint, if not yet connected.
public static LoadbalanceRSocketClient	Returns: the created client instance create(RSocketConnector a "template" for connecting to load balance targets connector, Publisher<List<LoadbalanceTarget>> refreshes the list of load balance targets periodically targetPublisher) Shortcut to create an `LoadbalanceRSocketClient` with round-robin load balancing.
public void	dispose() Implements reactor.core.Disposable.dispose. Cancel or dispose the underlying task or resource.
public Mono<Void>	fireAndForget(Mono<Payload> payloadMono) Implements io.rsocket.core.RSocketClient.fireAndForget. Perform a Fire-and-Forget interaction via `RSocket#fireAndForget(Payload)`.
public Mono<Void>	metadataPush(Mono<Payload> payloadMono) Implements io.rsocket.core.RSocketClient.metadataPush. Perform a Metadata Push via `RSocket#metadataPush(Payload)`.
public Mono<Void>	onClose() Overrides default io.rsocket.core.RSocketClient.onClose. Returns a `Mono` that terminates when the instance is terminated by any reason.
public Flux<Payload>	requestChannel(Publisher<Payload> payloads) Implements io.rsocket.core.RSocketClient.requestChannel. Perform a Request-Channel interaction via `RSocket#requestChannel(Publisher)`.
public Mono<Payload>	requestResponse(Mono<Payload> payloadMono) Implements io.rsocket.core.RSocketClient.requestResponse. Perform a Request-Response interaction via `RSocket#requestResponse(Payload)`.
public Flux<Payload>	requestStream(Mono<Payload> payloadMono) Implements io.rsocket.core.RSocketClient.requestStream. Perform a Request-Stream interaction via `RSocket#requestStream(Payload)`.
public Mono<RSocket>	source() Implements io.rsocket.core.RSocketClient.source. Return `Mono` that selects an RSocket from the underlying pool.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

rSocketPool	back to summary
private final RSocketPool rSocketPool

Constructor Detail

LoadbalanceRSocketClient	back to summary
private LoadbalanceRSocketClient(RSocketPool rSocketPool)

Method Detail

builder back to summary

builder	back to summary
public static LoadbalanceRSocketClient.Builder builder(Publisher<List<LoadbalanceTarget>> targetPublisher) Return a builder for a `LoadbalanceRSocketClient`. Parameters targetPublisher:Publisher<List<LoadbalanceTarget>> refreshes the list of load balance targets periodically Returns:LoadbalanceRSocketClient.Builder the created builder

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

Return a builder for a LoadbalanceRSocketClient.

Parameters

targetPublisher:Publisher<List<LoadbalanceTarget>>: refreshes the list of load balance targets periodically

Returns:LoadbalanceRSocketClient.Builder

the created builder

connect back to summary

connect	back to summary
public boolean connect() Overrides default io.rsocket.core.RSocketClient.connect. Doc from io.rsocket.core.RSocketClient.connect. Connect to the remote rsocket endpoint, if not yet connected. This method is a shortcut for `RSocketClient#source().subscribe()`. Returns:boolean `true` if an attempt to connect was triggered or if already connected, or `false` if the client is terminated. Annotations @Override

public boolean connect()

Overrides default io.rsocket.core.RSocketClient.connect.

Doc from io.rsocket.core.RSocketClient.connect.

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

Returns:boolean

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

Annotations

@Override

create back to summary

create	back to summary
public static LoadbalanceRSocketClient create(RSocketConnector connector, 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:RSocketConnector a "template" for connecting to load balance targets targetPublisher:Publisher<List<LoadbalanceTarget>> refreshes the list of load balance targets periodically Returns:LoadbalanceRSocketClient the created client instance

public static LoadbalanceRSocketClient create(RSocketConnector connector, 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:RSocketConnector: a "template" for connecting to load balance targets
targetPublisher:Publisher<List<LoadbalanceTarget>>: refreshes the list of load balance targets periodically

Returns:LoadbalanceRSocketClient

the created client instance

dispose	back to summary
public void dispose() Implements reactor.core.Disposable.dispose. Doc from reactor.core.Disposable.dispose. Cancel or dispose the underlying task or resource. Implementations are required to make this method idempotent. Annotations @Override

dispose

back to summary

public void dispose()

Implements reactor.core.Disposable.dispose.

Doc from reactor.core.Disposable.dispose.

Cancel or dispose the underlying task or resource.

Implementations are required to make this method idempotent.

Annotations

@Override

fireAndForget back to summary

fireAndForget	back to summary
public Mono<Void> fireAndForget(Mono<Payload> payloadMono) Implements io.rsocket.core.RSocketClient.fireAndForget. Doc from io.rsocket.core.RSocketClient.fireAndForget. Perform a Fire-and-Forget interaction via `RSocket#fireAndForget(Payload)`. Allows multiple subscriptions and performs a request per subscriber. Annotations @Override

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

Implements io.rsocket.core.RSocketClient.fireAndForget.

Doc from io.rsocket.core.RSocketClient.fireAndForget.

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

Annotations

@Override

metadataPush back to summary

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

Implements io.rsocket.core.RSocketClient.metadataPush.

Doc from io.rsocket.core.RSocketClient.metadataPush.

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

Annotations

@Override

onClose back to summary

onClose	back to summary
public Mono<Void> onClose() Overrides default io.rsocket.core.RSocketClient.onClose. Doc from io.rsocket.Closeable.onClose. 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 `org.reactivestreams.Subscriber#onError(Throwable)`. Otherwise, `Subscriber#onComplete()` will be called. Returns:Mono<Void> 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. Annotations @Override

public Mono<Void> onClose()

Overrides default io.rsocket.core.RSocketClient.onClose.

Doc from io.rsocket.Closeable.onClose.

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 org.reactivestreams.Subscriber#onError(Throwable). Otherwise, Subscriber#onComplete() will be called.

Returns:Mono<Void>

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.

Annotations

@Override

requestChannel back to summary

requestChannel	back to summary
public Flux<Payload> requestChannel(Publisher<Payload> payloads) Implements io.rsocket.core.RSocketClient.requestChannel. Doc from io.rsocket.core.RSocketClient.requestChannel. Perform a Request-Channel interaction via `RSocket#requestChannel(Publisher)`. Allows multiple subscriptions and performs a request per subscriber. Annotations @Override

public Flux<Payload> requestChannel(Publisher<Payload> payloads)

Implements io.rsocket.core.RSocketClient.requestChannel.

Doc from io.rsocket.core.RSocketClient.requestChannel.

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

Annotations

@Override

requestResponse back to summary

requestResponse	back to summary
public Mono<Payload> requestResponse(Mono<Payload> payloadMono) Implements io.rsocket.core.RSocketClient.requestResponse. Doc from io.rsocket.core.RSocketClient.requestResponse. Perform a Request-Response interaction via `RSocket#requestResponse(Payload)`. Allows multiple subscriptions and performs a request per subscriber. Annotations @Override

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

Implements io.rsocket.core.RSocketClient.requestResponse.

Doc from io.rsocket.core.RSocketClient.requestResponse.

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

Annotations

@Override

requestStream back to summary

requestStream	back to summary
public Flux<Payload> requestStream(Mono<Payload> payloadMono) Implements io.rsocket.core.RSocketClient.requestStream. Doc from io.rsocket.core.RSocketClient.requestStream. Perform a Request-Stream interaction via `RSocket#requestStream(Payload)`. Allows multiple subscriptions and performs a request per subscriber. Annotations @Override

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

Implements io.rsocket.core.RSocketClient.requestStream.

Doc from io.rsocket.core.RSocketClient.requestStream.

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

Annotations

@Override

source back to summary

source	back to summary
public Mono<RSocket> source() Implements io.rsocket.core.RSocketClient.source. Return `Mono` that selects an RSocket from the underlying pool. Annotations @Override

public Mono<RSocket> source()

Implements io.rsocket.core.RSocketClient.source.

Return Mono that selects an RSocket from the underlying pool.

Annotations

@Override

io.rsocket.loadbalance back to summary

public Class LoadbalanceRSocketClient.Builder

Class Inheritance

extends Object

java.lang.Object
io.rsocket.loadbalance.LoadbalanceRSocketClient.Builder

Builder for creating an LoadbalanceRSocketClient.

Field Summary

Modifier and Type	Field and Description
private RSocketConnector	connector
pack-priv LoadbalanceStrategy	loadbalanceStrategy
private final Publisher<List<LoadbalanceTarget>>	targetPublisher

Constructor Summary

Access	Constructor and Description
pack-priv	Builder(Publisher<List<LoadbalanceTarget>> targetPublisher)

Method Summary

Modifier and Type	Method and Description
public LoadbalanceRSocketClient	build() Build the `LoadbalanceRSocketClient` instance.
public LoadbalanceRSocketClient.Builder	connector(RSocketConnector the connector to use as a template connector) Configure the "template" connector to use for connecting to load balance targets.
public LoadbalanceRSocketClient.Builder	loadbalanceStrategy(LoadbalanceStrategy strategy) Configure the `LoadbalanceStrategy` to use.
public LoadbalanceRSocketClient.Builder	roundRobinLoadbalanceStrategy() Configure `RoundRobinLoadbalanceStrategy` as the strategy to use to select targets.
public LoadbalanceRSocketClient.Builder	weightedLoadbalanceStrategy() Configure `WeightedLoadbalanceStrategy` as the strategy to use to select targets.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

connector	back to summary
private RSocketConnector connector Annotations @Nullable

loadbalanceStrategy	back to summary
pack-priv LoadbalanceStrategy loadbalanceStrategy Annotations @Nullable

targetPublisher	back to summary
private final Publisher<List<LoadbalanceTarget>> targetPublisher

Constructor Detail

Builder	back to summary
pack-priv Builder(Publisher<List<LoadbalanceTarget>> targetPublisher)

Method Detail

build	back to summary
public LoadbalanceRSocketClient build() Build the `LoadbalanceRSocketClient` instance.

connector back to summary

connector	back to summary
public LoadbalanceRSocketClient.Builder connector(RSocketConnector connector) Configure the "template" connector to use for connecting to load balance targets. To establish a connection, the `ClientTransport` contained in each target is passed to the connector's `connect` method and thus the same connector with the same settings applies to all targets. By default this is initialized with `RSocketConnector#create()`. Parameters connector:RSocketConnector the connector to use as a template

public LoadbalanceRSocketClient.Builder connector(RSocketConnector connector)

Configure the "template" connector to use for connecting to load balance targets. To establish a connection, the ClientTransport contained in each target is passed to the connector's connect method and thus the same connector with the same settings applies to all targets.

By default this is initialized with RSocketConnector#create().

Parameters

connector:RSocketConnector: the connector to use as a template

loadbalanceStrategy back to summary

loadbalanceStrategy	back to summary
public LoadbalanceRSocketClient.Builder loadbalanceStrategy(LoadbalanceStrategy strategy) Configure the `LoadbalanceStrategy` to use. By default, `RoundRobinLoadbalanceStrategy` is used.

public LoadbalanceRSocketClient.Builder loadbalanceStrategy(LoadbalanceStrategy strategy)

Configure the LoadbalanceStrategy to use.

By default, RoundRobinLoadbalanceStrategy is used.

roundRobinLoadbalanceStrategy back to summary

roundRobinLoadbalanceStrategy	back to summary
public LoadbalanceRSocketClient.Builder roundRobinLoadbalanceStrategy() Configure `RoundRobinLoadbalanceStrategy` as the strategy to use to select targets. This is the strategy used by default.

public LoadbalanceRSocketClient.Builder roundRobinLoadbalanceStrategy()

Configure RoundRobinLoadbalanceStrategy as the strategy to use to select targets.

This is the strategy used by default.

weightedLoadbalanceStrategy back to summary

weightedLoadbalanceStrategy	back to summary
public LoadbalanceRSocketClient.Builder weightedLoadbalanceStrategy() Configure `WeightedLoadbalanceStrategy` as the strategy to use to select targets. By default, `RoundRobinLoadbalanceStrategy` is used.

public LoadbalanceRSocketClient.Builder weightedLoadbalanceStrategy()

Configure WeightedLoadbalanceStrategy as the strategy to use to select targets.

By default, RoundRobinLoadbalanceStrategy is used.

public Class LoadbalanceRSocketClient

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class LoadbalanceRSocketClient.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail