NamingExtensions::LoadBalancer Interface Reference

This interface allows a LoadBalancer object to bound in to the service and retrieved. More...

import "NamingExtensions.idl";

Inherited by NamingExtensions::LoadBalancerAlias.

List of all members.

Public Member Functions

void add (in Object obj)
 This operation accepts an Object to bind into the load balancing implementation.
Object get () raises (NoneBound, PluginFailure)
 This operation returns one of the objects bound into the implementation.
void remove (in Object name) raises (ObjectNotFound)
 This operation removes the named Object.
Types::ObjectSeq list ()
 This operation lists all the objects in the LoadBalancer.
void setPolicy (in string policy) raises (InvalidPolicy)
 This operation allows the policy for returning the objects to be set if multiple algorithms are supported.
void addPlugin (in string classname) raises (InvalidPlugin)
 This operation allows a plugin to be added to the LoadBalancer.
LoadBalancerAlias getAlias ()
 This operation allows the LoadBalancer to retrieve the alias object.

Classes

exception  InvalidPlugin
 Indicates that the chosen plugin is not valid. More...
exception  InvalidPolicy
 Indicates that the chosen policy is not valid. More...
exception  NoneBound
 Indicates that this load balancer contains no objects. More...
exception  ObjectNotFound
 Indicates that the object was not found. More...
exception  PluginFailure
 Indicates that the plugin failured to retrieve an object. More...


Detailed Description

This interface allows a LoadBalancer object to bound in to the service and retrieved.

It allows the alias object to be obtained which can be bound in to do the actual load balancing.


Member Function Documentation

void NamingExtensions::LoadBalancer::add ( in Object  obj  ) 

This operation accepts an Object to bind into the load balancing implementation.

obj - an Object

void NamingExtensions::LoadBalancer::addPlugin ( in string  classname  )  raises (InvalidPlugin)

This operation allows a plugin to be added to the LoadBalancer.

The plugin will be used during the get() operation. The LoadBalancer implementation is responsible for instantiating the plugin.

plugin - the plugin classname. InvalidPlugin - if the plugin is invalid

Object NamingExtensions::LoadBalancer::get (  )  raises (NoneBound, PluginFailure)

This operation returns one of the objects bound into the implementation.

NoneBound - if no objects have been bound in. PluginFailure - if the plugin throws an error.

LoadBalancerAlias NamingExtensions::LoadBalancer::getAlias (  ) 

This operation allows the LoadBalancer to retrieve the alias object.

Types::ObjectSeq NamingExtensions::LoadBalancer::list (  ) 

This operation lists all the objects in the LoadBalancer.

void NamingExtensions::LoadBalancer::remove ( in Object  name  )  raises (ObjectNotFound)

This operation removes the named Object.

obj - an Object ObjectNotFound - if no objects have been found.

void NamingExtensions::LoadBalancer::setPolicy ( in string  policy  )  raises (InvalidPolicy)

This operation allows the policy for returning the objects to be set if multiple algorithms are supported.

policy - the policy InvalidPolicy - if the policy is invalid.