io.reactivesocket.client

Class LoadBalancer

java.lang.Object

io.reactivesocket.client.LoadBalancer

All Implemented Interfaces:

io.reactivesocket.Availability, io.reactivesocket.ReactiveSocket

public class LoadBalancer
extends java.lang.Object
implements io.reactivesocket.ReactiveSocket

This ReactiveSocket implementation will load balance the request across a pool of children ReactiveSockets. It estimates the load of each ReactiveSocket based on statistics collected.

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_EXP_FACTOR
static double	DEFAULT_HIGHER_QUANTILE
static double	DEFAULT_LOWER_QUANTILE
static int	DEFAULT_MAX_APERTURE
static double	DEFAULT_MAX_PENDING
static long	DEFAULT_MAX_REFRESH_PERIOD_MS
static int	DEFAULT_MIN_APERTURE
static double	DEFAULT_MIN_PENDING

Constructor Summary

Constructors

Constructor and Description
LoadBalancer(org.reactivestreams.Publisher<? extends java.util.Collection<io.reactivesocket.client.ReactiveSocketClient>> factories)
LoadBalancer(org.reactivestreams.Publisher<? extends java.util.Collection<io.reactivesocket.client.ReactiveSocketClient>> factories, double expFactor, double lowQuantile, double highQuantile, double minPendings, double maxPendings, int minAperture, int maxAperture, long maxRefreshPeriodMs, io.reactivesocket.internal.EventPublisher<io.reactivesocket.events.ClientEventListener> eventPublisher)

Method Summary

Modifier and Type	Method and Description
double	availability()
org.reactivestreams.Publisher<java.lang.Void>	close()
org.reactivestreams.Publisher<java.lang.Void>	fireAndForget(io.reactivesocket.Payload payload)
org.reactivestreams.Publisher<java.lang.Void>	metadataPush(io.reactivesocket.Payload payload)
org.reactivestreams.Publisher<java.lang.Void>	onClose()
org.reactivestreams.Publisher<io.reactivesocket.Payload>	requestChannel(org.reactivestreams.Publisher<io.reactivesocket.Payload> payloads)
org.reactivestreams.Publisher<io.reactivesocket.Payload>	requestResponse(io.reactivesocket.Payload payload)
org.reactivestreams.Publisher<io.reactivesocket.Payload>	requestStream(io.reactivesocket.Payload payload)
org.reactivestreams.Publisher<io.reactivesocket.Payload>	requestSubscription(io.reactivesocket.Payload payload)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_EXP_FACTOR

public static final double DEFAULT_EXP_FACTOR

See Also:

Constant Field Values

DEFAULT_LOWER_QUANTILE

public static final double DEFAULT_LOWER_QUANTILE

See Also:

Constant Field Values

DEFAULT_HIGHER_QUANTILE

public static final double DEFAULT_HIGHER_QUANTILE

See Also:

Constant Field Values

DEFAULT_MIN_PENDING

public static final double DEFAULT_MIN_PENDING

See Also:

Constant Field Values

DEFAULT_MAX_PENDING

public static final double DEFAULT_MAX_PENDING

See Also:

Constant Field Values

DEFAULT_MIN_APERTURE

public static final int DEFAULT_MIN_APERTURE

See Also:

Constant Field Values

DEFAULT_MAX_APERTURE

public static final int DEFAULT_MAX_APERTURE

See Also:

Constant Field Values

DEFAULT_MAX_REFRESH_PERIOD_MS

public static final long DEFAULT_MAX_REFRESH_PERIOD_MS

Constructor Detail

LoadBalancer

public LoadBalancer(org.reactivestreams.Publisher<? extends java.util.Collection<io.reactivesocket.client.ReactiveSocketClient>> factories,
                    double expFactor,
                    double lowQuantile,
                    double highQuantile,
                    double minPendings,
                    double maxPendings,
                    int minAperture,
                    int maxAperture,
                    long maxRefreshPeriodMs,
                    io.reactivesocket.internal.EventPublisher<io.reactivesocket.events.ClientEventListener> eventPublisher)

Parameters:

factories - the source (factories) of ReactiveSocket

expFactor - how aggressive is the algorithm toward outliers. A higher number means we send aggressively less traffic to a server slightly slower.

lowQuantile - the lower bound of the latency band of acceptable values. Any server below that value will be aggressively favored.

highQuantile - the higher bound of the latency band of acceptable values. Any server above that value will be aggressively penalized.

minPendings - The lower band of the average outstanding messages per server.

maxPendings - The higher band of the average outstanding messages per server.

minAperture - the minimum number of connections we want to maintain, independently of the load.

maxAperture - the maximum number of connections we want to maintain, independently of the load.

maxRefreshPeriodMs - the maximum time between two "refreshes" of the list of active ReactiveSocket. This is at that time that the slowest ReactiveSocket is closed. (unit is millisecond)

LoadBalancer

public LoadBalancer(org.reactivestreams.Publisher<? extends java.util.Collection<io.reactivesocket.client.ReactiveSocketClient>> factories)

Method Detail

fireAndForget

public org.reactivestreams.Publisher<java.lang.Void> fireAndForget(io.reactivesocket.Payload payload)

Specified by:

fireAndForget in interface io.reactivesocket.ReactiveSocket

requestResponse

public org.reactivestreams.Publisher<io.reactivesocket.Payload> requestResponse(io.reactivesocket.Payload payload)

Specified by:

requestResponse in interface io.reactivesocket.ReactiveSocket

requestSubscription

public org.reactivestreams.Publisher<io.reactivesocket.Payload> requestSubscription(io.reactivesocket.Payload payload)

Specified by:

requestSubscription in interface io.reactivesocket.ReactiveSocket

requestStream

public org.reactivestreams.Publisher<io.reactivesocket.Payload> requestStream(io.reactivesocket.Payload payload)

Specified by:

requestStream in interface io.reactivesocket.ReactiveSocket

metadataPush

public org.reactivestreams.Publisher<java.lang.Void> metadataPush(io.reactivesocket.Payload payload)

Specified by:

metadataPush in interface io.reactivesocket.ReactiveSocket

requestChannel

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

Specified by:

requestChannel in interface io.reactivesocket.ReactiveSocket

availability

public double availability()

Specified by:

availability in interface io.reactivesocket.Availability

Specified by:

availability in interface io.reactivesocket.ReactiveSocket

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

close

public org.reactivestreams.Publisher<java.lang.Void> close()

Specified by:

close in interface io.reactivesocket.ReactiveSocket

onClose

public org.reactivestreams.Publisher<java.lang.Void> onClose()

Specified by:

onClose in interface io.reactivesocket.ReactiveSocket