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

An IceBox server descriptor. More...

#include <IceGrid/IceGrid.h>

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

Public Member Functions

std::tuple< const ::IceGrid::AdapterDescriptorSeq &, const ::IceGrid::PropertySetDescriptor &, const ::IceGrid::DbEnvDescriptorSeq &, const ::Ice::StringSeq &, const ::std::string &, const ::std::string &, const ::std::string &, const ::std::string &, const ::std::string &, const ::Ice::StringSeq &, const ::Ice::StringSeq &, const ::std::string &, const ::std::string &, const ::std::string &, const bool &, const ::IceGrid::DistributionDescriptor &, const bool &, const ::std::string &, const ::IceGrid::ServiceInstanceDescriptorSeq & > ice_tuple () const
 Obtains a tuple containing all of the value's data members. More...
 
 IceBoxDescriptor ()=default
 
 IceBoxDescriptor (const ::IceGrid::AdapterDescriptorSeq &adapters, const ::IceGrid::PropertySetDescriptor &propertySet, const ::IceGrid::DbEnvDescriptorSeq &dbEnvs, const ::Ice::StringSeq &logs, const ::std::string &description, const ::std::string &id, const ::std::string &exe, const ::std::string &iceVersion, const ::std::string &pwd, const ::Ice::StringSeq &options, const ::Ice::StringSeq &envs, const ::std::string &activation, const ::std::string &activationTimeout, const ::std::string &deactivationTimeout, bool applicationDistrib, const ::IceGrid::DistributionDescriptor &distrib, bool allocatable, const ::std::string &user, const ::IceGrid::ServiceInstanceDescriptorSeq &services)
 One-shot constructor to initialize all data members. More...
 
 IceBoxDescriptor (const IceBoxDescriptor &)=default
 
 IceBoxDescriptor (IceBoxDescriptor &&)=default
 
IceBoxDescriptoroperator= (const IceBoxDescriptor &)=default
 
IceBoxDescriptoroperator= (IceBoxDescriptor &&)=default
 
virtual ~IceBoxDescriptor ()
 

Static Public Member Functions

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

Public Attributes

::IceGrid::ServiceInstanceDescriptorSeq services
 The service instances. More...
 

Detailed Description

An IceBox server descriptor.

Constructor & Destructor Documentation

◆ ~IceBoxDescriptor()

virtual IceGrid::IceBoxDescriptor::~IceBoxDescriptor ( )
virtual

◆ IceBoxDescriptor() [1/4]

IceGrid::IceBoxDescriptor::IceBoxDescriptor ( )
default

◆ IceBoxDescriptor() [2/4]

IceGrid::IceBoxDescriptor::IceBoxDescriptor ( const IceBoxDescriptor )
default

◆ IceBoxDescriptor() [3/4]

IceGrid::IceBoxDescriptor::IceBoxDescriptor ( IceBoxDescriptor &&  )
default

◆ IceBoxDescriptor() [4/4]

IceGrid::IceBoxDescriptor::IceBoxDescriptor ( const ::IceGrid::AdapterDescriptorSeq adapters,
const ::IceGrid::PropertySetDescriptor propertySet,
const ::IceGrid::DbEnvDescriptorSeq dbEnvs,
const ::Ice::StringSeq logs,
const ::std::string &  description,
const ::std::string &  id,
const ::std::string &  exe,
const ::std::string &  iceVersion,
const ::std::string &  pwd,
const ::Ice::StringSeq options,
const ::Ice::StringSeq envs,
const ::std::string &  activation,
const ::std::string &  activationTimeout,
const ::std::string &  deactivationTimeout,
bool  applicationDistrib,
const ::IceGrid::DistributionDescriptor distrib,
bool  allocatable,
const ::std::string &  user,
const ::IceGrid::ServiceInstanceDescriptorSeq services 
)
inline

One-shot constructor to initialize all data members.

Parameters
adaptersThe object adapters.
propertySetThe property set.
dbEnvsThe database environments.
logsThe path of each log file.
descriptionA description of this descriptor.
idThe server id.
exeThe path of the server executable.
iceVersionThe Ice version used by this server.
pwdThe path to the server working directory.
optionsThe command line options to pass to the server executable.
envsThe server environment variables.
activationThe server activation mode (possible values are "on-demand" or "manual").
activationTimeoutThe activation timeout (an integer value representing the number of seconds to wait for activation).
deactivationTimeoutThe deactivation timeout (an integer value representing the number of seconds to wait for deactivation).
applicationDistribSpecifies if the server depends on the application distribution.
distribThe distribution descriptor.
allocatableSpecifies if the server is allocatable.
userThe user account used to run the server.
servicesThe service instances.

Member Function Documentation

◆ ice_staticId()

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

Obtains the Slice type ID of this value.

Returns
The fully-scoped type ID.

◆ ice_tuple()

std::tuple<const ::IceGrid::AdapterDescriptorSeq&, const ::IceGrid::PropertySetDescriptor&, const ::IceGrid::DbEnvDescriptorSeq&, const ::Ice::StringSeq&, const ::std::string&, const ::std::string&, const ::std::string&, const ::std::string&, const ::std::string&, const ::Ice::StringSeq&, const ::Ice::StringSeq&, const ::std::string&, const ::std::string&, const ::std::string&, const bool&, const ::IceGrid::DistributionDescriptor&, const bool&, const ::std::string&, const ::IceGrid::ServiceInstanceDescriptorSeq&> IceGrid::IceBoxDescriptor::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]

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

◆ operator=() [2/2]

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

Member Data Documentation

◆ services

::IceGrid::ServiceInstanceDescriptorSeq IceGrid::IceBoxDescriptor::services

The service instances.


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