Platform SDK Java 8.5 API Reference

com.genesyslab.platform.clusterprotocol.lb
Interface ClusterProtocolLoadBalancer

All Known Implementing Classes:
DefaultClusterLoadBalancer

public interface ClusterProtocolLoadBalancer

Common interface for Cluster Protocol Load Balancer component.

It allows user applications to implement custom load balancing strategies.

See Also:
ClusterProtocolBuilder.withLoadBalancer(ClusterProtocolLoadBalancer)

Method Summary
 void addNode(Protocol node)
          This method is to add just connected Cluster Protocol Node to load balancing strategy.
 Protocol chooseNode(Message message)
          This method is to apply load balancing strategy on available cluster nodes.
 void clear()
          This method is called when Cluster Protocol is being closed.
 void configure(ConnectionConfiguration config)
          This method is to choose and apply load balancer specific options from the cluster connection configuration.
 void removeNode(Protocol node)
          This method is to remove Cluster Protocol Node from load balancing strategy.
Its called when node is removed from the cluster, or its protocol connection is lost.
 

Method Detail

configure

void configure(ConnectionConfiguration config)
This method is to choose and apply load balancer specific options from the cluster connection configuration.

Parameters:
config - connection configuration from the Cluster Protocol base Endpoint.
See Also:
ClusterProtocol.setEndpoint(Endpoint)

addNode

void addNode(Protocol node)
This method is to add just connected Cluster Protocol Node to load balancing strategy.

Parameters:
node - cluster protocol node.

removeNode

void removeNode(Protocol node)
This method is to remove Cluster Protocol Node from load balancing strategy.
Its called when node is removed from the cluster, or its protocol connection is lost.

Parameters:
node - cluster protocol node.

clear

void clear()
This method is called when Cluster Protocol is being closed.


chooseNode

Protocol chooseNode(Message message)
This method is to apply load balancing strategy on available cluster nodes.

Parameters:
message - user specified protocol message for sending (may be null).
Returns:
selected cluster protocol node.

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.