An Ice server descriptor. More...

#include <IceGrid/IceGrid.h>

Inheritance diagram for IceGrid::ServerDescriptor:

Collaboration diagram for IceGrid::ServerDescriptor:

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 & >	ice_tuple () const
	Obtains a tuple containing all of the value's data members. More...

ServerDescriptor &	operator= (const ServerDescriptor &)=default

ServerDescriptor &	operator= (ServerDescriptor &&)=default

	ServerDescriptor ()=default

	ServerDescriptor (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)
	One-shot constructor to initialize all data members. More...

	ServerDescriptor (const ServerDescriptor &)=default

	ServerDescriptor (ServerDescriptor &&)=default

virtual	~ServerDescriptor ()

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

Public Attributes
::std::string	activation
	The server activation mode (possible values are "on-demand" or "manual"). More...

::std::string	activationTimeout
	The activation timeout (an integer value representing the number of seconds to wait for activation). More...

bool	allocatable
	Specifies if the server is allocatable. More...

bool	applicationDistrib
	Specifies if the server depends on the application distribution. More...

::std::string	deactivationTimeout
	The deactivation timeout (an integer value representing the number of seconds to wait for deactivation). More...

::IceGrid::DistributionDescriptor	distrib
	The distribution descriptor. More...

::Ice::StringSeq	envs
	The server environment variables. More...

::std::string	exe
	The path of the server executable. More...

::std::string	iceVersion
	The Ice version used by this server. More...

::std::string	id
	The server id. More...

::Ice::StringSeq	options
	The command line options to pass to the server executable. More...

::std::string	pwd
	The path to the server working directory. More...

::std::string	user
	The user account used to run the server. More...

Detailed Description

An Ice server descriptor.

Constructor & Destructor Documentation

◆ ~ServerDescriptor()

virtual IceGrid::ServerDescriptor::~ServerDescriptor ( )

virtual

◆ ServerDescriptor() [1/4]

IceGrid::ServerDescriptor::ServerDescriptor ( )

default

◆ ServerDescriptor() [2/4]

IceGrid::ServerDescriptor::ServerDescriptor ( const ServerDescriptor & )

default

◆ ServerDescriptor() [3/4]

IceGrid::ServerDescriptor::ServerDescriptor ( ServerDescriptor && )

default

◆ ServerDescriptor() [4/4]

IceGrid::ServerDescriptor::ServerDescriptor	(	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
	)

inline

One-shot constructor to initialize all data members.

Parameters

adapters	The object adapters.
propertySet	The property set.
dbEnvs	The database environments.
logs	The path of each log file.
description	A description of this descriptor.
id	The server id.
exe	The path of the server executable.
iceVersion	The Ice version used by this server.
pwd	The path to the server working directory.
options	The command line options to pass to the server executable.
envs	The server environment variables.
activation	The server activation mode (possible values are "on-demand" or "manual").
activationTimeout	The activation timeout (an integer value representing the number of seconds to wait for activation).
deactivationTimeout	The deactivation timeout (an integer value representing the number of seconds to wait for deactivation).
applicationDistrib	Specifies if the server depends on the application distribution.
distrib	The distribution descriptor.
allocatable	Specifies if the server is allocatable.
user	The user account used to run the server.

Member Function Documentation

◆ ice_staticId()

static const ::std::string& IceGrid::ServerDescriptor::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&> IceGrid::ServerDescriptor::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]

ServerDescriptor& IceGrid::ServerDescriptor::operator= ( const ServerDescriptor & )

default

◆ operator=() [2/2]

ServerDescriptor& IceGrid::ServerDescriptor::operator= ( ServerDescriptor && )

default

Member Data Documentation

◆ activation

::std::string IceGrid::ServerDescriptor::activation

The server activation mode (possible values are "on-demand" or "manual").

◆ activationTimeout

::std::string IceGrid::ServerDescriptor::activationTimeout

The activation timeout (an integer value representing the number of seconds to wait for activation).

◆ allocatable

bool IceGrid::ServerDescriptor::allocatable

Specifies if the server is allocatable.

◆ applicationDistrib

bool IceGrid::ServerDescriptor::applicationDistrib

Specifies if the server depends on the application distribution.

◆ deactivationTimeout

::std::string IceGrid::ServerDescriptor::deactivationTimeout

The deactivation timeout (an integer value representing the number of seconds to wait for deactivation).

◆ distrib

::IceGrid::DistributionDescriptor IceGrid::ServerDescriptor::distrib

The distribution descriptor.

◆ envs

::Ice::StringSeq IceGrid::ServerDescriptor::envs

The server environment variables.

◆ exe

::std::string IceGrid::ServerDescriptor::exe

The path of the server executable.

◆ iceVersion

::std::string IceGrid::ServerDescriptor::iceVersion

The Ice version used by this server.

This is only required if backward compatibility with servers using old Ice versions is needed (otherwise the registry will assume the server is using the same Ice version). For example "3.1.1", "3.2", "3.3.0".

◆ id

::std::string IceGrid::ServerDescriptor::id

The server id.

◆ options

::Ice::StringSeq IceGrid::ServerDescriptor::options

The command line options to pass to the server executable.

◆ pwd

::std::string IceGrid::ServerDescriptor::pwd

The path to the server working directory.

◆ user

::std::string IceGrid::ServerDescriptor::user

The user account used to run the server.

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

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

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~ServerDescriptor()

◆ ServerDescriptor() [1/4]

◆ ServerDescriptor() [2/4]

◆ ServerDescriptor() [3/4]

◆ ServerDescriptor() [4/4]

Member Function Documentation

◆ ice_staticId()

◆ ice_tuple()

◆ operator=() [1/2]

◆ operator=() [2/2]

Member Data Documentation

◆ activation

◆ activationTimeout

◆ allocatable

◆ applicationDistrib

◆ deactivationTimeout

◆ distrib

◆ envs

◆ exe

◆ iceVersion

◆ id

◆ options

◆ pwd

◆ user