IceGrid::IceBoxDescriptor Class Reference

Describes an IceBox server. More...

#include <IceGrid/IceGrid.h>

Inheritance diagram for IceGrid::IceBoxDescriptor:

Public Member Functions
	IceBoxDescriptor () noexcept=default
	Default constructor.
	IceBoxDescriptor (::IceGrid::AdapterDescriptorSeq adapters, ::IceGrid::PropertySetDescriptor propertySet, ::IceGrid::DbEnvDescriptorSeq dbEnvs, ::Ice::StringSeq logs, std::string description, std::string id, std::string exe, std::string iceVersion, std::string pwd, ::Ice::StringSeq options, ::Ice::StringSeq envs, std::string activation, std::string activationTimeout, std::string deactivationTimeout, bool applicationDistrib, ::IceGrid::DistributionDescriptor distrib, bool allocatable, std::string user, ::IceGrid::ServiceInstanceDescriptorSeq services) noexcept
	One-shot constructor to initialize all data members.
IceBoxDescriptorPtr	ice_clone () const
	Creates a shallow polymorphic copy of this instance.
const char *	ice_id () const noexcept override
	Gets the Slice type ID of the most-derived class supported by this object.
void	ice_printFields (std::ostream &os) const override
	Outputs the name and value of each field of this instance, including inherited fields, to the stream.
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
	Creates a tuple with all the fields of this class.
Public Member Functions inherited from IceGrid::ServerDescriptor
	ServerDescriptor () noexcept=default
	Default constructor.
	ServerDescriptor (::IceGrid::AdapterDescriptorSeq adapters, ::IceGrid::PropertySetDescriptor propertySet, ::IceGrid::DbEnvDescriptorSeq dbEnvs, ::Ice::StringSeq logs, std::string description, std::string id, std::string exe, std::string iceVersion, std::string pwd, ::Ice::StringSeq options, ::Ice::StringSeq envs, std::string activation, std::string activationTimeout, std::string deactivationTimeout, bool applicationDistrib, ::IceGrid::DistributionDescriptor distrib, bool allocatable, std::string user) noexcept
	One-shot constructor to initialize all data members.
ServerDescriptorPtr	ice_clone () const
	Creates a shallow polymorphic copy of this instance.
const char *	ice_id () const noexcept override
	Gets the Slice type ID of the most-derived class supported by this object.
void	ice_printFields (std::ostream &os) const override
	Outputs the name and value of each field of this instance, including inherited fields, to the stream.
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
	Creates a tuple with all the fields of this class.
Public Member Functions inherited from IceGrid::CommunicatorDescriptor
	CommunicatorDescriptor () noexcept=default
	Default constructor.
	CommunicatorDescriptor (::IceGrid::AdapterDescriptorSeq adapters, ::IceGrid::PropertySetDescriptor propertySet, ::IceGrid::DbEnvDescriptorSeq dbEnvs, ::Ice::StringSeq logs, std::string description) noexcept
	One-shot constructor to initialize all data members.
CommunicatorDescriptorPtr	ice_clone () const
	Creates a shallow polymorphic copy of this instance.
std::tuple< const ::IceGrid::AdapterDescriptorSeq &, const ::IceGrid::PropertySetDescriptor &, const ::IceGrid::DbEnvDescriptorSeq &, const ::Ice::StringSeq &, const std::string & >	ice_tuple () const
	Creates a tuple with all the fields of this class.
Public Member Functions inherited from Ice::Value
	Value () noexcept=default
	Default constructor.
	Value (Value &&)=delete
ValuePtr	ice_clone () const
	Creates a shallow polymorphic copy of this instance.
SlicedDataPtr	ice_getSlicedData () const
	Gets the sliced data associated with this instance.
virtual void	ice_postUnmarshal ()
	Validates or updates the fields of this object after unmarshaling.
virtual void	ice_preMarshal ()
	Validates or updates the fields of this object before marshaling.
virtual void	ice_print (std::ostream &os) const
	Outputs a description of this instance to the stream.
Value &	operator= (const Value &)=delete
Value &	operator= (Value &&)=delete

Static Public Member Functions
static const char *	ice_staticId () noexcept
	Gets the type ID of the associated Slice class.
Static Public Member Functions inherited from IceGrid::ServerDescriptor
static const char *	ice_staticId () noexcept
	Gets the type ID of the associated Slice class.
Static Public Member Functions inherited from IceGrid::CommunicatorDescriptor
static const char *	ice_staticId () noexcept
	Gets the type ID of the associated Slice class.
Static Public Member Functions inherited from Ice::Value
static const char *	ice_staticId () noexcept
	Gets the Slice type ID of this type.

Public Attributes
::IceGrid::ServiceInstanceDescriptorSeq	services
	The service instances.
Public Attributes inherited from IceGrid::ServerDescriptor
std::string	activation
	The server activation mode. Possible values are "on-demand" and "manual".
std::string	activationTimeout
	The activation timeout.
bool	allocatable
	Specifies if the server is allocatable.
bool	applicationDistrib {false}
	Specifies if the server depends on the application distribution.
std::string	deactivationTimeout
	The deactivation timeout.
::IceGrid::DistributionDescriptor	distrib
	The distribution descriptor.
::Ice::StringSeq	envs
	The server environment variables.
std::string	exe
	The path of the server executable.
std::string	iceVersion
	The Ice version used by this server.
std::string	id
	The server ID.
::Ice::StringSeq	options
	The command line options to pass to the server executable.
std::string	pwd
	The path to the server working directory.
std::string	user
	The user account used to run the server.
Public Attributes inherited from IceGrid::CommunicatorDescriptor
::IceGrid::AdapterDescriptorSeq	adapters
	The indirect object adapters.
::IceGrid::DbEnvDescriptorSeq	dbEnvs
	The database environments.
std::string	description
	A description of this descriptor.
::Ice::StringSeq	logs
	The path of each log file.
::IceGrid::PropertySetDescriptor	propertySet
	The property set.

Protected Member Functions
	IceBoxDescriptor (const IceBoxDescriptor &)=default
	Copy constructor.
Protected Member Functions inherited from IceGrid::ServerDescriptor
	ServerDescriptor (const ServerDescriptor &)=default
	Copy constructor.
Protected Member Functions inherited from IceGrid::CommunicatorDescriptor
	CommunicatorDescriptor (const CommunicatorDescriptor &)=default
	Copy constructor.

Detailed Description

Describes an IceBox server.

Definition at line 722 of file Descriptor.h.

---

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

• generated/IceGrid/Descriptor.h