Ice 3.7 C++11 API Reference
Public Member Functions | Public Attributes | List of all members
IceGrid::AdapterDescriptor Struct Reference

An Ice object adapter descriptor. More...

#include <IceGrid/IceGrid.h>

Public Member Functions

std::tuple< const ::std::string &, const ::std::string &, const ::std::string &, const ::std::string &, const ::std::string &, const bool &, const bool &, const ::IceGrid::ObjectDescriptorSeq &, const ::IceGrid::ObjectDescriptorSeq & > ice_tuple () const
 Obtains a tuple containing all of the struct's data members. More...
 

Public Attributes

::IceGrid::ObjectDescriptorSeq allocatables
 The allocatable object descriptors associated with this object adapter. More...
 
::std::string description
 The description of this object adapter. More...
 
::std::string id
 The object adapter id. More...
 
::std::string name
 The object adapter name. More...
 
::IceGrid::ObjectDescriptorSeq objects
 The well-known object descriptors associated with this object adapter. More...
 
::std::string priority
 The adapter priority. More...
 
bool registerProcess
 Flag to specify if the object adapter will register a process object. More...
 
::std::string replicaGroupId
 The replica id of this adapter. More...
 
bool serverLifetime
 If true the lifetime of this object adapter is the same of the server lifetime. More...
 

Detailed Description

An Ice object adapter descriptor.

Member Function Documentation

◆ ice_tuple()

std::tuple<const ::std::string&, const ::std::string&, const ::std::string&, const ::std::string&, const ::std::string&, const bool&, const bool&, const ::IceGrid::ObjectDescriptorSeq&, const ::IceGrid::ObjectDescriptorSeq&> IceGrid::AdapterDescriptor::ice_tuple ( ) const
inline

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

Returns
The data members in a tuple.

Member Data Documentation

◆ allocatables

::IceGrid::ObjectDescriptorSeq IceGrid::AdapterDescriptor::allocatables

The allocatable object descriptors associated with this object adapter.

◆ description

::std::string IceGrid::AdapterDescriptor::description

The description of this object adapter.

◆ id

::std::string IceGrid::AdapterDescriptor::id

The object adapter id.

◆ name

::std::string IceGrid::AdapterDescriptor::name

The object adapter name.

◆ objects

::IceGrid::ObjectDescriptorSeq IceGrid::AdapterDescriptor::objects

The well-known object descriptors associated with this object adapter.

◆ priority

::std::string IceGrid::AdapterDescriptor::priority

The adapter priority.

This is eventually used when the adapter is member of a replica group to sort the adapter endpoints by priority.

◆ registerProcess

bool IceGrid::AdapterDescriptor::registerProcess

Flag to specify if the object adapter will register a process object.

◆ replicaGroupId

::std::string IceGrid::AdapterDescriptor::replicaGroupId

The replica id of this adapter.

◆ serverLifetime

bool IceGrid::AdapterDescriptor::serverLifetime

If true the lifetime of this object adapter is the same of the server lifetime.

This information is used by the IceGrid node to figure out the server state: the server is active only if all its "server lifetime" adapters are active.


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