An Ice server descriptor. More...

#include <IceGrid/IceGrid.h>

Inheritance diagram for IceGrid::ServerDescriptor:

[legend]

Collaboration diagram for IceGrid::ServerDescriptor:

[legend]

Public Types
typedef ServerDescriptorPtr	PointerType

typedef ServerDescriptorPrx	ProxyType

Public Types inherited from IceGrid::CommunicatorDescriptor
typedef CommunicatorDescriptorPtr	PointerType

typedef CommunicatorDescriptorPrx	ProxyType

Public Member Functions
virtual ::Ice::ObjectPtr	ice_clone () const
	Polymorphically clones this object. More...

virtual const ::std::string &	ice_id (const ::Ice::Current &current=::Ice::emptyCurrent) const
	Obtains a Slice type ID representing the most-derived interface supported by this object. More...

virtual ::std::vector< ::std::string >	ice_ids (const ::Ice::Current &current=::Ice::emptyCurrent) const
	Obtains a list of the Slice type IDs representing the interfaces supported by this object. More...

virtual bool	ice_isA (const ::std::string &id, const ::Ice::Current &current=::Ice::emptyCurrent) const
	Determines whether this object supports an interface with the given Slice type ID. More...

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

virtual	~ServerDescriptor ()

Public Member Functions inherited from IceGrid::CommunicatorDescriptor
	CommunicatorDescriptor ()

	CommunicatorDescriptor (const ::IceGrid::AdapterDescriptorSeq &adapters, const ::IceGrid::PropertySetDescriptor &propertySet, const ::IceGrid::DbEnvDescriptorSeq &dbEnvs, const ::Ice::StringSeq &logs, const ::std::string &description)
	One-shot constructor to initialize all data members. More...

virtual ::std::vector< ::std::string >	ice_ids (const ::Ice::Current &current=::Ice::emptyCurrent) const
	Obtains a list of the Slice type IDs representing the interfaces supported by this object. More...

virtual	~CommunicatorDescriptor ()

Public Member Functions inherited from Ice::Object
virtual void	ice_collectable (bool b)
	Determines whether this object, and by extension the graph of all objects reachable from this object, are eligible for garbage collection when all external references to the graph have been released. More...

virtual bool	ice_dispatch (Ice::Request &request, const DispatchInterceptorAsyncCallbackPtr &cb=0)
	Dispatches an invocation to a servant. More...

virtual SlicedDataPtr	ice_getSlicedData () const
	Obtains the sliced data associated with this instance. More...

virtual const std::string &	ice_id (const Current &current=Ice::emptyCurrent) const
	Returns the Slice type ID of the most-derived interface supported by this object. More...

virtual std::vector< std::string >	ice_ids (const Current &current=Ice::emptyCurrent) const
	Returns the Slice type IDs of the interfaces supported by this object. More...

virtual bool	ice_isA (const std::string &s, const Current &current=Ice::emptyCurrent) const
	Tests whether this object supports a specific Slice interface. More...

virtual Int	ice_operationAttributes (const std::string &operation) const
	Returns the Freeze metadata attributes for an operation. More...

virtual void	ice_ping (const Current &current=Ice::emptyCurrent) const
	Tests whether this object can be reached. More...

virtual void	ice_postUnmarshal ()
	The Ice run time invokes this method vafter unmarshaling an object's data members. More...

virtual void	ice_preMarshal ()
	The Ice run time invokes this method prior to marshaling an object's data members. More...

virtual bool	operator< (const Object &) const

virtual bool	operator== (const Object &) const

Public Member Functions inherited from IceUtil::Shared
void	__clearFlag (unsigned char flag)

virtual void	__decRef ()

virtual int	__getRef () const

bool	__hasFlag (unsigned char flag)

virtual void	__incRef ()

void	__setFlag (unsigned char flag)

virtual void	__setNoDelete (bool)

Shared &	operator= (const Shared &)

	Shared ()

	Shared (const Shared &)

virtual	~Shared ()

Static Public Member Functions
::Ice::ValueFactoryPtr	ice_factory ()
	Obtains a value factory that instantiates this class. More...

static const ::std::string &	ice_staticId ()
	Obtains the Slice type ID corresponding to this class. More...

Static Public Member Functions inherited from IceGrid::CommunicatorDescriptor
::Ice::ValueFactoryPtr	ice_factory ()
	Obtains a value factory that instantiates this class. More...

static const ::std::string &	ice_staticId ()
	Obtains the Slice type ID corresponding to this class. More...

Static Public Member Functions inherited from Ice::Object
static const std::string &	ice_staticId ()
	Obtains the Slice type ID of this type. 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...

Public Attributes inherited from IceGrid::CommunicatorDescriptor
::IceGrid::AdapterDescriptorSeq	adapters
	The object adapters. More...

::IceGrid::DbEnvDescriptorSeq	dbEnvs
	The database environments. More...

::std::string	description
	A description of this descriptor. More...

::Ice::StringSeq	logs
	The path of each log file. More...

::IceGrid::PropertySetDescriptor	propertySet
	The property set. More...

Additional Inherited Members
Static Public Attributes inherited from IceUtil::Shared
static const unsigned char	NoDelete

Protected Member Functions inherited from Ice::Object
	Object ()

virtual	~Object ()

Protected Attributes inherited from IceUtil::Shared
unsigned char	_flags

IceUtilInternal::Atomic	_ref

Detailed Description

An Ice server descriptor.

Member Typedef Documentation

◆ PointerType

typedef ServerDescriptorPtr IceGrid::ServerDescriptor::PointerType

◆ ProxyType

typedef ServerDescriptorPrx IceGrid::ServerDescriptor::ProxyType

Constructor & Destructor Documentation

◆ ~ServerDescriptor()

virtual IceGrid::ServerDescriptor::~ServerDescriptor ( )

virtual

◆ ServerDescriptor() [1/2]

IceGrid::ServerDescriptor::ServerDescriptor ( )

inline

◆ ServerDescriptor() [2/2]

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_clone()

virtual ::Ice::ObjectPtr IceGrid::ServerDescriptor::ice_clone ( ) const

virtual

Polymorphically clones this object.

Returns: A shallow copy of this object.

Reimplemented from IceGrid::CommunicatorDescriptor.

Reimplemented in IceGrid::IceBoxDescriptor.

◆ ice_factory()

::Ice::ValueFactoryPtr IceGrid::ServerDescriptor::ice_factory ( )

static

Obtains a value factory that instantiates this class.

Returns: The value factory.

◆ ice_id()

virtual const ::std::string& IceGrid::ServerDescriptor::ice_id ( const ::Ice::Current & current = ::Ice::emptyCurrent ) const

virtual

Obtains a Slice type ID representing the most-derived interface supported by this object.

Parameters

current The Current object for the invocation.

Returns: A fully-scoped type ID.

Reimplemented from IceGrid::CommunicatorDescriptor.

Reimplemented in IceGrid::IceBoxDescriptor.

◆ ice_ids()

virtual ::std::vector< ::std::string> IceGrid::ServerDescriptor::ice_ids ( const ::Ice::Current & current = ::Ice::emptyCurrent ) const

Obtains a list of the Slice type IDs representing the interfaces supported by this object.

Parameters

current The Current object for the invocation.

Returns: A list of fully-scoped type IDs.

◆ ice_isA()

virtual bool IceGrid::ServerDescriptor::ice_isA	(	const ::std::string &	id,
		const ::Ice::Current &	current = `::Ice::emptyCurrent`
	)		const

virtual

Determines whether this object supports an interface with the given Slice type ID.

Parameters

id	The fully-scoped Slice type ID.
current	The Current object for the invocation.

Returns: True if this object supports the interface, false, otherwise.

Reimplemented from IceGrid::CommunicatorDescriptor.

Reimplemented in IceGrid::IceBoxDescriptor.

◆ ice_staticId()

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

static

Obtains the Slice type ID corresponding to this class.

Returns: A fully-scoped type ID.

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/cpp98/x64/Release/IceGrid/Descriptor.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ PointerType

◆ ProxyType

Constructor & Destructor Documentation

◆ ~ServerDescriptor()

◆ ServerDescriptor() [1/2]

◆ ServerDescriptor() [2/2]

Member Function Documentation

◆ ice_clone()

◆ ice_factory()

◆ ice_id()

◆ ice_ids()

◆ ice_isA()

◆ ice_staticId()

Member Data Documentation

◆ activation

◆ activationTimeout

◆ allocatable

◆ applicationDistrib

◆ deactivationTimeout

◆ distrib

◆ envs

◆ exe

◆ iceVersion

◆ id

◆ options

◆ pwd

◆ user