Ice 3.7 C++11 API Reference
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
IceGrid::AdaptiveLoadBalancingPolicy Class Reference

Adaptive load balancing policy. More...

#include <IceGrid/IceGrid.h>

Inheritance diagram for IceGrid::AdaptiveLoadBalancingPolicy:
Inheritance graph
[legend]
Collaboration diagram for IceGrid::AdaptiveLoadBalancingPolicy:
Collaboration graph
[legend]

Public Member Functions

 AdaptiveLoadBalancingPolicy ()=default
 
 AdaptiveLoadBalancingPolicy (AdaptiveLoadBalancingPolicy &&)=default
 
 AdaptiveLoadBalancingPolicy (const ::std::string &nReplicas, const ::std::string &loadSample)
 One-shot constructor to initialize all data members. More...
 
 AdaptiveLoadBalancingPolicy (const AdaptiveLoadBalancingPolicy &)=default
 
std::tuple< const ::std::string &, const ::std::string & > ice_tuple () const
 Obtains a tuple containing all of the value's data members. More...
 
AdaptiveLoadBalancingPolicyoperator= (AdaptiveLoadBalancingPolicy &&)=default
 
AdaptiveLoadBalancingPolicyoperator= (const AdaptiveLoadBalancingPolicy &)=default
 
virtual ~AdaptiveLoadBalancingPolicy ()
 

Static Public Member Functions

static const ::std::string & ice_staticId ()
 Obtains the Slice type ID of this value. More...
 

Public Attributes

::std::string loadSample
 The load sample to use for the load balancing. More...
 

Detailed Description

Adaptive load balancing policy.

Constructor & Destructor Documentation

◆ ~AdaptiveLoadBalancingPolicy()

virtual IceGrid::AdaptiveLoadBalancingPolicy::~AdaptiveLoadBalancingPolicy ( )
virtual

◆ AdaptiveLoadBalancingPolicy() [1/4]

IceGrid::AdaptiveLoadBalancingPolicy::AdaptiveLoadBalancingPolicy ( )
default

◆ AdaptiveLoadBalancingPolicy() [2/4]

IceGrid::AdaptiveLoadBalancingPolicy::AdaptiveLoadBalancingPolicy ( const AdaptiveLoadBalancingPolicy )
default

◆ AdaptiveLoadBalancingPolicy() [3/4]

IceGrid::AdaptiveLoadBalancingPolicy::AdaptiveLoadBalancingPolicy ( AdaptiveLoadBalancingPolicy &&  )
default

◆ AdaptiveLoadBalancingPolicy() [4/4]

IceGrid::AdaptiveLoadBalancingPolicy::AdaptiveLoadBalancingPolicy ( const ::std::string &  nReplicas,
const ::std::string &  loadSample 
)
inline

One-shot constructor to initialize all data members.

Parameters
nReplicasThe number of replicas that will be used to gather the endpoints of a replica group.
loadSampleThe load sample to use for the load balancing.

Member Function Documentation

◆ ice_staticId()

static const ::std::string& IceGrid::AdaptiveLoadBalancingPolicy::ice_staticId ( )
static

Obtains the Slice type ID of this value.

Returns
The fully-scoped type ID.

◆ ice_tuple()

std::tuple<const ::std::string&, const ::std::string&> IceGrid::AdaptiveLoadBalancingPolicy::ice_tuple ( ) const
inline

Obtains a tuple containing all of the value's data members.

Returns
The data members in a tuple.

◆ operator=() [1/2]

AdaptiveLoadBalancingPolicy& IceGrid::AdaptiveLoadBalancingPolicy::operator= ( AdaptiveLoadBalancingPolicy &&  )
default

◆ operator=() [2/2]

AdaptiveLoadBalancingPolicy& IceGrid::AdaptiveLoadBalancingPolicy::operator= ( const AdaptiveLoadBalancingPolicy )
default

Member Data Documentation

◆ loadSample

::std::string IceGrid::AdaptiveLoadBalancingPolicy::loadSample

The load sample to use for the load balancing.

The allowed values for this attribute are "1", "5" and "15", representing respectively the load average over the past minute, the past 5 minutes and the past 15 minutes.


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