Class AbstractLoadBalancer`Abstract`

Abstract Load Balancer to be used by built-in and user-provided LoadBalancer implementations.

Hierarchy

AbstractLoadBalancer

Implements

Index

Constructors

Methods

canGetNextDataMember init initLoadBalancer memberAdded memberRemoved next nextDataMember

Constructors

constructor

new AbstractLoadBalancer(): AbstractLoadBalancer
Returns AbstractLoadBalancer

Methods

`Abstract` 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
Implementation of LoadBalancer.canGetNextDataMember
- Defined in src/core/LoadBalancer.ts:83

init

init(_event: InitialMembershipEvent): void
Called when this listener is registered.
Parameters
- _event: InitialMembershipEvent
  
  the MembershipInitializeEvent received when the listener is registered
Returns void
Implementation of InitialMembershipListener.init
- Defined in src/core/LoadBalancer.ts:90

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
Implementation of LoadBalancer.initLoadBalancer
- Defined in src/core/LoadBalancer.ts:85

memberAdded

memberAdded(_membership: MembershipEvent): void
Invoked when a new member is added to the cluster.
Parameters
- _membership: MembershipEvent
  
  event object
Returns void
Implementation of InitialMembershipListener.memberAdded
- Defined in src/core/LoadBalancer.ts:94

memberRemoved

memberRemoved(_membership: MembershipEvent): void
Invoked when an existing member leaves the cluster.
Parameters
- _membership: MembershipEvent
  
  event object
Returns void
Implementation of InitialMembershipListener.memberRemoved
- Defined in src/core/LoadBalancer.ts:98

`Abstract` next

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

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

Returns Member
Implementation of LoadBalancer.next
- Defined in src/core/LoadBalancer.ts:79

`Abstract` 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
Implementation of LoadBalancer.nextDataMember
- Defined in src/core/LoadBalancer.ts:81

Generated using TypeDoc