Interface LoadBalancer

A LoadBalancer selects one of the endpoints(Members) for the next send operation that be directed to many endpoints. It is up to the implementation to use different load balancing policies.

If the client is a smart client configured with ClientNetworkConfig.smartRouting, only the operations that are not key based will be routed via LoadBalancer. If the client is not a smart client, the LoadBalancer will not be used.

Hierarchy

LoadBalancer

Implemented by

AbstractLoadBalancer

Index

Methods

canGetNextDataMember initLoadBalancer next nextDataMember

Methods

canGetNextDataMember

canGetNextDataMember(): boolean
Returns whether this instance supports getting data members through a call to nextDataMember.

Returns
Returns true if this load balancer can get a data member.

Deprecated
Since 5.0, the method is unused

Returns boolean
- Defined in src/core/LoadBalancer.ts:66

initLoadBalancer

initLoadBalancer(cluster: Cluster, config: ClientConfig): void
Initializes the LoadBalancer.
Parameters
- cluster: Cluster
  
  the Cluster this LoadBalancer uses to select members from.
- config: ClientConfig
  
  the ClientConfig.
Returns void
- Defined in src/core/LoadBalancer.ts:43

next

next(): Member
Returns the next member to route to.

Returns
Returns the next member or null if no member is available

Returns Member
- Defined in src/core/LoadBalancer.ts:50

nextDataMember

nextDataMember(): Member
Returns the next data member to route to.

Returns
Returns the next data member or null if no data member is available

Deprecated
Since 5.0, the method is unused

Returns Member
- Defined in src/core/LoadBalancer.ts:58

Generated using TypeDoc