A base class for load balancing policies. More...

#include <IceGrid/IceGrid.h>

Inheritance diagram for IceGrid::LoadBalancingPolicy:

[legend]

Collaboration diagram for IceGrid::LoadBalancingPolicy:

[legend]

Public Types
typedef LoadBalancingPolicyPtr	PointerType
typedef LoadBalancingPolicyPrx	ProxyType

Public Member Functions
virtual::Ice::ObjectPtr	ice_clone () const
	Polymorphically clones this object.
virtual const ::std::string &	ice_id (const ::Ice::Current &current=::Ice::emptyCurrent) const
	Obtains a Slice type ID representing the most-derived interface supported by this object.
virtual ::std::vector< ::std::string >	ice_ids (const ::Ice::Current &current=::Ice::emptyCurrent) const
	Obtains a list of the Slice type IDs representing the interfaces supported by this object.
virtual bool	ice_isA (const ::std::string &id, const ::Ice::Current &current=::Ice::emptyCurrent) const
	Determines whether this object supports an interface with the given Slice type ID.
	LoadBalancingPolicy ()
	LoadBalancingPolicy (const ::std::string &nReplicas)
	One-shot constructor to initialize all data members.
virtual	~LoadBalancingPolicy ()
Public Member Functions inherited from Ice::Object
virtual void	ice_collectable (bool b)
	Determines whether this object, and by extension the graph of all objects reachable from this object, are eligible for garbage collection when all external references to the graph have been released.
virtual bool	ice_dispatch (Ice::Request &request, const DispatchInterceptorAsyncCallbackPtr &cb=0)
	Dispatches an invocation to a servant.
virtual SlicedDataPtr	ice_getSlicedData () const
	Obtains the sliced data associated with this instance.
virtual const std::string &	ice_id (const Current &current=Ice::emptyCurrent) const
	Returns the Slice type ID of the most-derived interface supported by this object.
virtual std::vector< std::string >	ice_ids (const Current &current=Ice::emptyCurrent) const
	Returns the Slice type IDs of the interfaces supported by this object.
virtual bool	ice_isA (const std::string &s, const Current &current=Ice::emptyCurrent) const
	Tests whether this object supports a specific Slice interface.
virtual Int	ice_operationAttributes (const std::string &operation) const
	Returns the Freeze metadata attributes for an operation.
virtual void	ice_ping (const Current &current=Ice::emptyCurrent) const
	Tests whether this object can be reached.
virtual void	ice_postUnmarshal ()
	The Ice run time invokes this method vafter unmarshaling an object's data members.
virtual void	ice_preMarshal ()
	The Ice run time invokes this method prior to marshaling an object's data members.
virtual bool	operator< (const Object &) const
virtual bool	operator== (const Object &) const
Public Member Functions inherited from IceUtil::Shared
void	__clearFlag (unsigned char flag)
virtual void	__decRef ()
virtual int	__getRef () const
bool	__hasFlag (unsigned char flag)
virtual void	__incRef ()
void	__setFlag (unsigned char flag)
virtual void	__setNoDelete (bool)
Shared &	operator= (const Shared &)
	Shared ()
	Shared (const Shared &)
virtual	~Shared ()

Static Public Member Functions
::Ice::ValueFactoryPtr	ice_factory ()
	Obtains a value factory that instantiates this class.
static const ::std::string &	ice_staticId ()
	Obtains the Slice type ID corresponding to this class.
Static Public Member Functions inherited from Ice::Object
static const std::string &	ice_staticId ()
	Obtains the Slice type ID of this type.

Public Attributes
::std::string	nReplicas
	The number of replicas that will be used to gather the endpoints of a replica group.

Additional Inherited Members
Static Public Attributes inherited from IceUtil::Shared
static const unsigned char	NoDelete
Protected Member Functions inherited from Ice::Object
	Object ()
virtual	~Object ()
Protected Attributes inherited from IceUtil::Shared
unsigned char	_flags
IceUtilInternal::Atomic	_ref

Detailed Description

A base class for load balancing policies.

Member Typedef Documentation

◆ PointerType

typedef LoadBalancingPolicyPtr IceGrid::LoadBalancingPolicy::PointerType

◆ ProxyType

typedef LoadBalancingPolicyPrx IceGrid::LoadBalancingPolicy::ProxyType

Constructor & Destructor Documentation

◆ ~LoadBalancingPolicy()

virtual IceGrid::LoadBalancingPolicy::~LoadBalancingPolicy ( )

virtual

◆ LoadBalancingPolicy() [1/2]

IceGrid::LoadBalancingPolicy::LoadBalancingPolicy ( )

inline

◆ LoadBalancingPolicy() [2/2]

IceGrid::LoadBalancingPolicy::LoadBalancingPolicy ( const ::std::string & nReplicas )

inlineexplicit

One-shot constructor to initialize all data members.

Parameters

nReplicas The number of replicas that will be used to gather the endpoints of a replica group.

Member Function Documentation

◆ ice_clone()

virtual::Ice::ObjectPtr IceGrid::LoadBalancingPolicy::ice_clone ( ) const

virtual

Polymorphically clones this object.

Returns: A shallow copy of this object.

Reimplemented from Ice::Object.

Reimplemented in IceGrid::OrderedLoadBalancingPolicy, IceGrid::RandomLoadBalancingPolicy, and IceGrid::RoundRobinLoadBalancingPolicy.

◆ ice_factory()

::Ice::ValueFactoryPtr IceGrid::LoadBalancingPolicy::ice_factory ( )

static

Obtains a value factory that instantiates this class.

Returns: The value factory.

◆ ice_id()

virtual const ::std::string & IceGrid::LoadBalancingPolicy::ice_id ( const ::Ice::Current & current = ::Ice::emptyCurrent ) const

virtual

Obtains a Slice type ID representing the most-derived interface supported by this object.

Parameters

current The Current object for the invocation.

Returns: A fully-scoped type ID.

Reimplemented in IceGrid::AdaptiveLoadBalancingPolicy, IceGrid::OrderedLoadBalancingPolicy, IceGrid::RandomLoadBalancingPolicy, and IceGrid::RoundRobinLoadBalancingPolicy.

◆ ice_ids()

virtual ::std::vector< ::std::string > IceGrid::LoadBalancingPolicy::ice_ids ( const ::Ice::Current & current = ::Ice::emptyCurrent ) const

Obtains a list of the Slice type IDs representing the interfaces supported by this object.

Parameters

current The Current object for the invocation.

Returns: A list of fully-scoped type IDs.

◆ ice_isA()

virtual bool IceGrid::LoadBalancingPolicy::ice_isA	(	const ::std::string &	id,
		const ::Ice::Current &	current = ::Ice::emptyCurrent ) const

virtual

Determines whether this object supports an interface with the given Slice type ID.

Parameters

id	The fully-scoped Slice type ID.
current	The Current object for the invocation.

Returns: True if this object supports the interface, false, otherwise.

Reimplemented in IceGrid::AdaptiveLoadBalancingPolicy, IceGrid::OrderedLoadBalancingPolicy, IceGrid::RandomLoadBalancingPolicy, and IceGrid::RoundRobinLoadBalancingPolicy.

◆ ice_staticId()

const ::std::string & IceGrid::LoadBalancingPolicy::ice_staticId ( )

static

Obtains the Slice type ID corresponding to this class.

Returns: A fully-scoped type ID.

Member Data Documentation

◆ nReplicas

::std::string IceGrid::LoadBalancingPolicy::nReplicas

The number of replicas that will be used to gather the endpoints of a replica group.

The documentation for this class was generated from the following file:

generated/cpp98/x64/Release/IceGrid/Descriptor.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ PointerType

◆ ProxyType

Constructor & Destructor Documentation

◆ ~LoadBalancingPolicy()

◆ LoadBalancingPolicy() [1/2]

◆ LoadBalancingPolicy() [2/2]

Member Function Documentation

◆ ice_clone()

◆ ice_factory()

◆ ice_id()

◆ ice_ids()

◆ ice_isA()

◆ ice_staticId()

Member Data Documentation

◆ nReplicas