IceGrid Namespace Reference

Deploy and manage Ice servers. More...

Classes
class	AccessDeniedException
	The exception that is thrown when the registry update lock cannot be acquired. More...
struct	AdapterDescriptor
	Describes an indirect object adapter. More...
struct	AdapterDynamicInfo
	Dynamic information about the state of an adapter. More...
struct	AdapterInfo
	Information about an adapter registered with the IceGrid registry. More...
class	AdapterNotExistException
	The exception that is thrown when IceGrid does not know an object adapter with the provided adapter ID. More...
class	AdapterObserver
	Monitors dynamically-registered object adapters. More...
class	AdapterObserverPrx
	Monitors dynamically-registered object adapters. More...
class	AdaptiveLoadBalancingPolicy
	The load balancing policy that returns the endpoints of the server(s) with the lowest load average. More...
class	Admin
	Provides administrative access to an IceGrid deployment.
class	AdminPrx
	Provides administrative access to an IceGrid deployment. More...
class	AdminSession
	Represents an administrative session between an admin tool and an IceGrid registry.
class	AdminSessionPrx
	Represents an administrative session between an admin tool and an IceGrid registry. More...
class	AllocationException
	The exception that is thrown when the allocation of an object failed. More...
class	AllocationTimeoutException
	The exception that is thrown when the request to allocate an object times out. More...
struct	ApplicationDescriptor
	Describes an application. More...
struct	ApplicationInfo
	Information about an IceGrid application. More...
class	ApplicationNotExistException
	The exception that is thrown when IceGrid does not know an application with the provided name. More...
class	ApplicationObserver
	Monitors applications. More...
class	ApplicationObserverPrx
	Monitors applications. More...
struct	ApplicationUpdateDescriptor
	An application update descriptor to describe the updates to apply to a deployed application. More...
struct	ApplicationUpdateInfo
	Information about updates to an IceGrid application. More...
class	AsyncAdapterObserver
	Monitors dynamically-registered object adapters. More...
class	AsyncAdmin
	Provides administrative access to an IceGrid deployment. More...
class	AsyncAdminSession
	Represents an administrative session between an admin tool and an IceGrid registry. More...
class	AsyncApplicationObserver
	Monitors applications. More...
class	AsyncFileIterator
	Iterates over an IceGrid log file. More...
class	AsyncFileParser
	icegridadmin provides a FileParser object to transform XML files into ApplicationDescriptor objects. More...
class	AsyncLocator
	Provides access to the QueryPrx and RegistryPrx objects implemented by the IceGrid registry. More...
class	AsyncNodeObserver
	Monitors changes to the state of the nodes. More...
class	AsyncObjectObserver
	Monitors well-known objects that are added, updated or removed using AdminPrx. More...
class	AsyncQuery
	Finds well-known Ice objects registered with the IceGrid registry. More...
class	AsyncRegistry
	Represents the main entry point into the IceGrid registry service. More...
class	AsyncRegistryObserver
	Monitors changes to the state of the registries. More...
class	AsyncSession
	Represents a session object used by IceGrid clients to allocate and release objects. More...
class	AsyncUserAccountMapper
	Maps user strings in server descriptors to actual user account names. More...
class	BadSignalException
	The exception that is thrown when an unknown signal is sent to a server. More...
class	BoxedDistributionDescriptor
	A "boxed" distribution descriptor. More...
class	BoxedString
	A "boxed" string. More...
class	CommunicatorDescriptor
	Describes an Ice communicator. More...
struct	DbEnvDescriptor
	A Freeze database environment descriptor (deprecated, no longer used). More...
class	DeploymentException
	The exception that is thrown when IceGrid cannot deploy a server. More...
struct	DistributionDescriptor
	Describes a distribution. More...
class	FileIterator
	Iterates over an IceGrid log file.
class	FileIteratorPrx
	Iterates over an IceGrid log file. More...
class	FileNotAvailableException
	The exception that is thrown when a log file is not available. More...
class	FileParser
	icegridadmin provides a FileParser object to transform XML files into ApplicationDescriptor objects.
class	FileParserPrx
	icegridadmin provides a FileParser object to transform XML files into ApplicationDescriptor objects. More...
class	IceBoxDescriptor
	Describes an IceBox server. More...
class	LoadBalancingPolicy
	The base class for load balancing policies. More...
struct	LoadInfo
	Information about the load of a node. More...
class	Locator
	Provides access to the QueryPrx and RegistryPrx objects implemented by the IceGrid registry.
class	LocatorPrx
	Provides access to the QueryPrx and RegistryPrx objects implemented by the IceGrid registry. More...
struct	NodeDescriptor
	Describes an IceGrid node. More...
struct	NodeDynamicInfo
	Dynamic information about the state of a node. More...
struct	NodeInfo
	Information about an IceGrid node. More...
class	NodeNotExistException
	The exception that is thrown when IceGrid does not know a node with the provided name. More...
class	NodeObserver
	Monitors changes to the state of the nodes. More...
class	NodeObserverPrx
	Monitors changes to the state of the nodes. More...
class	NodeUnreachableException
	The exception that is thrown when IceGrid cannot reach a node. More...
struct	NodeUpdateDescriptor
	Describes the updates to apply to a node in a deployed application. More...
struct	ObjectDescriptor
	Describes a well-known Ice object. More...
class	ObjectExistsException
	The exception that is thrown when a well-known object is already registered. More...
struct	ObjectInfo
	Information about an Ice well-known object. More...
class	ObjectNotRegisteredException
	The exception that is thrown when a well-known object is not registered. More...
class	ObjectObserver
	Monitors well-known objects that are added, updated or removed using AdminPrx. More...
class	ObjectObserverPrx
	Monitors well-known objects that are added, updated or removed using AdminPrx. More...
class	ObserverAlreadyRegisteredException
	The exception that is thrown when an observer is already registered with the registry. More...
class	OrderedLoadBalancingPolicy
	The load balancing policy that returns endpoints in order. More...
class	ParseException
	The exception that is thrown when an error occurs during the parsing of an IceGrid XML file. More...
class	PermissionDeniedException
	The exception that is thrown when a client is not allowed to create a session. More...
struct	PropertyDescriptor
	Describes an Ice property. More...
struct	PropertySetDescriptor
	A property set descriptor. More...
class	Query
	Finds well-known Ice objects registered with the IceGrid registry.
class	QueryPrx
	Finds well-known Ice objects registered with the IceGrid registry. More...
class	RandomLoadBalancingPolicy
	The load balancing policy that returns endpoints in a random order. More...
class	Registry
	Represents the main entry point into the IceGrid registry service.
struct	RegistryInfo
	Information about an IceGrid registry replica. More...
class	RegistryNotExistException
	The exception that is thrown when IceGrid does not know a registry with the provided name. More...
class	RegistryObserver
	Monitors changes to the state of the registries. More...
class	RegistryObserverPrx
	Monitors changes to the state of the registries. More...
class	RegistryPluginFacade
	The RegistryPluginFacade is implemented by IceGrid and can be used by plugins and filter implementations to retrieve information from IceGrid about the well-known objects or adapters. More...
class	RegistryPrx
	Represents the main entry point into the IceGrid registry service. More...
class	RegistryUnreachableException
	The exception that is thrown when IceGrid cannot reach a registry. More...
struct	ReplicaGroupDescriptor
	Describes a replica group. More...
class	ReplicaGroupFilter
	The ReplicaGroupFilter is used by IceGrid to filter adapters returned to the client when it resolves a filtered replica group. More...
class	RoundRobinLoadBalancingPolicy
	The load balancing policy that returns endpoints using round-robin. More...
class	ServerDescriptor
	Describes an Ice server. More...
struct	ServerDynamicInfo
	Dynamic information about the state of a server. More...
struct	ServerInfo
	Information about a server managed by an IceGrid node. More...
struct	ServerInstanceDescriptor
	Describes a template instantiation that creates a server. More...
class	ServerNotExistException
	The exception that is thrown when IceGrid does not know a server with the provided server ID. More...
class	ServerStartException
	The exception that is thrown when a server failed to start. More...
class	ServerStopException
	The exception that is thrown when a server failed to stop. More...
class	ServiceDescriptor
	Describes an IceBox service. More...
struct	ServiceInstanceDescriptor
	Describes an IceBox service. More...
class	Session
	Represents a session object used by IceGrid clients to allocate and release objects.
class	SessionPrx
	Represents a session object used by IceGrid clients to allocate and release objects. More...
struct	TemplateDescriptor
	Describes a template for a server or an IceBox service. More...
class	TypeFilter
	The TypeFilter is used by IceGrid to filter well-known proxies returned to the client when it searches a well-known object by type. More...
class	UserAccountMapper
	Maps user strings in server descriptors to actual user account names. More...
class	UserAccountMapperPrx
	Maps user strings in server descriptors to actual user account names. More...
class	UserAccountNotFoundException
	The exception that is thrown when a user account for a given session identifier can't be found. More...

Typedefs
using	AdapterDescriptorSeq = std::vector<AdapterDescriptor>
	A sequence of AdapterDescriptor.
using	AdapterDynamicInfoSeq = std::vector<AdapterDynamicInfo>
	A sequence of AdapterDynamicInfo.
using	AdapterInfoSeq = std::vector<AdapterInfo>
	A sequence of AdapterInfo.
using	AdapterObserverPtr = std::shared_ptr<AdapterObserver>
	A shared pointer to an AdapterObserver.
using	AdaptiveLoadBalancingPolicyPtr = std::shared_ptr<AdaptiveLoadBalancingPolicy>
	A shared pointer to an AdaptiveLoadBalancingPolicy.
using	AdminPtr = std::shared_ptr<Admin>
	A shared pointer to an Admin.
using	AdminSessionPtr = std::shared_ptr<AdminSession>
	A shared pointer to an AdminSession.
using	ApplicationDescriptorSeq = std::vector<ApplicationDescriptor>
	A sequence of ApplicationDescriptor.
using	ApplicationInfoSeq = std::vector<ApplicationInfo>
	A sequence of ApplicationInfo.
using	ApplicationObserverPtr = std::shared_ptr<ApplicationObserver>
	A shared pointer to an ApplicationObserver.
using	AsyncAdapterObserverPtr = std::shared_ptr<AsyncAdapterObserver>
	A shared pointer to an AsyncAdapterObserver.
using	AsyncAdminPtr = std::shared_ptr<AsyncAdmin>
	A shared pointer to an AsyncAdmin.
using	AsyncAdminSessionPtr = std::shared_ptr<AsyncAdminSession>
	A shared pointer to an AsyncAdminSession.
using	AsyncApplicationObserverPtr = std::shared_ptr<AsyncApplicationObserver>
	A shared pointer to an AsyncApplicationObserver.
using	AsyncFileIteratorPtr = std::shared_ptr<AsyncFileIterator>
	A shared pointer to an AsyncFileIterator.
using	AsyncFileParserPtr = std::shared_ptr<AsyncFileParser>
	A shared pointer to an AsyncFileParser.
using	AsyncLocatorPtr = std::shared_ptr<AsyncLocator>
	A shared pointer to an AsyncLocator.
using	AsyncNodeObserverPtr = std::shared_ptr<AsyncNodeObserver>
	A shared pointer to an AsyncNodeObserver.
using	AsyncObjectObserverPtr = std::shared_ptr<AsyncObjectObserver>
	A shared pointer to an AsyncObjectObserver.
using	AsyncQueryPtr = std::shared_ptr<AsyncQuery>
	A shared pointer to an AsyncQuery.
using	AsyncRegistryObserverPtr = std::shared_ptr<AsyncRegistryObserver>
	A shared pointer to an AsyncRegistryObserver.
using	AsyncRegistryPtr = std::shared_ptr<AsyncRegistry>
	A shared pointer to an AsyncRegistry.
using	AsyncSessionPtr = std::shared_ptr<AsyncSession>
	A shared pointer to an AsyncSession.
using	AsyncUserAccountMapperPtr = std::shared_ptr<AsyncUserAccountMapper>
	A shared pointer to an AsyncUserAccountMapper.
using	BoxedStringPtr = std::shared_ptr<BoxedString>
	A shared pointer to a BoxedString.
using	CommunicatorDescriptorPtr = std::shared_ptr<CommunicatorDescriptor>
	A shared pointer to a CommunicatorDescriptor.
using	FileIteratorPtr = std::shared_ptr<FileIterator>
	A shared pointer to a FileIterator.
using	FileParserPtr = std::shared_ptr<FileParser>
	A shared pointer to a FileParser.
using	IceBoxDescriptorPtr = std::shared_ptr<IceBoxDescriptor>
	A shared pointer to an IceBoxDescriptor.
using	LoadBalancingPolicyPtr = std::shared_ptr<LoadBalancingPolicy>
	A shared pointer to a LoadBalancingPolicy.
using	LocatorPtr = std::shared_ptr<Locator>
	A shared pointer to a Locator.
using	NodeDescriptorDict = std::map<std::string, NodeDescriptor>
	Mapping of node name to node descriptor.
using	NodeDynamicInfoSeq = std::vector<NodeDynamicInfo>
	A sequence of NodeDynamicInfo.
using	NodeObserverPtr = std::shared_ptr<NodeObserver>
	A shared pointer to a NodeObserver.
using	NodeUpdateDescriptorSeq = std::vector<NodeUpdateDescriptor>
	A sequence of NodeUpdateDescriptor.
using	ObjectDescriptorSeq = std::vector<ObjectDescriptor>
	A sequence of ObjectDescriptor.
using	ObjectInfoSeq = std::vector<ObjectInfo>
	A sequence of ObjectInfo.
using	ObjectObserverPtr = std::shared_ptr<ObjectObserver>
	A shared pointer to an ObjectObserver.
using	OrderedLoadBalancingPolicyPtr = std::shared_ptr<OrderedLoadBalancingPolicy>
	A shared pointer to an OrderedLoadBalancingPolicy.
using	PropertyDescriptorSeq = std::vector<PropertyDescriptor>
	A sequence of PropertyDescriptor.
using	PropertySetDescriptorDict = std::map<std::string, PropertySetDescriptor>
	A mapping of property set name to property set descriptor.
using	QueryPtr = std::shared_ptr<Query>
	A shared pointer to a Query.
using	RandomLoadBalancingPolicyPtr = std::shared_ptr<RandomLoadBalancingPolicy>
	A shared pointer to a RandomLoadBalancingPolicy.
using	RegistryInfoSeq = std::vector<RegistryInfo>
	A sequence of RegistryInfo.
using	RegistryObserverPtr = std::shared_ptr<RegistryObserver>
	A shared pointer to a RegistryObserver.
using	RegistryPluginFacadePtr = std::shared_ptr<RegistryPluginFacade>
	A shared pointer to a RegistryPluginFacade.
using	RegistryPtr = std::shared_ptr<Registry>
	A shared pointer to a Registry.
using	ReplicaGroupDescriptorSeq = std::vector<ReplicaGroupDescriptor>
	A sequence of ReplicaGroupDescriptor.
using	ReplicaGroupFilterPtr = std::shared_ptr<ReplicaGroupFilter>
	A shared pointer to a ReplicaGroupFilter.
using	RoundRobinLoadBalancingPolicyPtr = std::shared_ptr<RoundRobinLoadBalancingPolicy>
	A shared pointer to a RoundRobinLoadBalancingPolicy.
using	ServerDescriptorPtr = std::shared_ptr<ServerDescriptor>
	A shared pointer to a ServerDescriptor.
using	ServerDescriptorSeq = std::vector<ServerDescriptorPtr>
	A sequence of ServerDescriptor.
using	ServerDynamicInfoSeq = std::vector<ServerDynamicInfo>
	A sequence of ServerDynamicInfo.
using	ServerInstanceDescriptorSeq = std::vector<ServerInstanceDescriptor>
	A sequence of ServerInstanceDescriptor.
using	ServiceDescriptorPtr = std::shared_ptr<ServiceDescriptor>
	A shared pointer to a ServiceDescriptor.
using	ServiceDescriptorSeq = std::vector<ServiceDescriptorPtr>
	A sequence of ServiceDescriptor.
using	ServiceInstanceDescriptorSeq = std::vector<ServiceInstanceDescriptor>
	A sequence of ServiceInstanceDescriptor.
using	SessionPtr = std::shared_ptr<Session>
	A shared pointer to a Session.
using	StringObjectProxyDict = std::map<std::string, std::optional<Ice::ObjectPrx>>
	A dictionary of string to proxies.
using	StringStringDict = std::map<std::string, std::string>
	A mapping of string to string.
using	TemplateDescriptorDict = std::map<std::string, TemplateDescriptor>
	A mapping of template identifier to template descriptor.
using	TypeFilterPtr = std::shared_ptr<TypeFilter>
	A shared pointer to a TypeFilter.
using	UserAccountMapperPtr = std::shared_ptr<UserAccountMapper>
	A shared pointer to an UserAccountMapper.

Enumerations
enum class	LoadSample : std::uint8_t { LoadSample1 , LoadSample5 , LoadSample15 }
	Determines which load sampling interval to use. More...
enum class	ServerState : std::uint8_t {   Inactive , Activating , ActivationTimedOut , Active ,   Deactivating , Destroying , Destroyed }
	Represents the state of a server. More...

Functions
ICEGRID_API RegistryPluginFacadePtr	getRegistryPluginFacade ()
	Gets the plug-in facade for the IceGrid registry.
std::ostream &	operator<< (std::ostream &os, const AdapterDescriptor &value)
	Outputs the description of an AdapterDescriptor to a stream, including all its fields.
std::ostream &	operator<< (std::ostream &os, const AdapterDynamicInfo &value)
	Outputs the description of an AdapterDynamicInfo to a stream, including all its fields.
std::ostream &	operator<< (std::ostream &os, const AdapterInfo &value)
	Outputs the description of an AdapterInfo to a stream, including all its fields.
std::ostream &	operator<< (std::ostream &os, const ApplicationDescriptor &value)
	Outputs the description of an ApplicationDescriptor to a stream, including all its fields.
std::ostream &	operator<< (std::ostream &os, const ApplicationInfo &value)
	Outputs the description of an ApplicationInfo to a stream, including all its fields.
std::ostream &	operator<< (std::ostream &os, const ApplicationUpdateDescriptor &value)
	Outputs the description of an ApplicationUpdateDescriptor to a stream, including all its fields.
std::ostream &	operator<< (std::ostream &os, const ApplicationUpdateInfo &value)
	Outputs the description of an ApplicationUpdateInfo to a stream, including all its fields.
std::ostream &	operator<< (std::ostream &os, const DbEnvDescriptor &value)
	Outputs the description of a DbEnvDescriptor to a stream, including all its fields.
std::ostream &	operator<< (std::ostream &os, const DistributionDescriptor &value)
	Outputs the description of a DistributionDescriptor to a stream, including all its fields.
std::ostream &	operator<< (std::ostream &os, const LoadInfo &value)
	Outputs the description of a LoadInfo to a stream, including all its fields.
std::ostream &	operator<< (std::ostream &os, const NodeDescriptor &value)
	Outputs the description of a NodeDescriptor to a stream, including all its fields.
std::ostream &	operator<< (std::ostream &os, const NodeDynamicInfo &value)
	Outputs the description of a NodeDynamicInfo to a stream, including all its fields.
std::ostream &	operator<< (std::ostream &os, const NodeInfo &value)
	Outputs the description of a NodeInfo to a stream, including all its fields.
std::ostream &	operator<< (std::ostream &os, const NodeUpdateDescriptor &value)
	Outputs the description of a NodeUpdateDescriptor to a stream, including all its fields.
std::ostream &	operator<< (std::ostream &os, const ObjectDescriptor &value)
	Outputs the description of an ObjectDescriptor to a stream, including all its fields.
std::ostream &	operator<< (std::ostream &os, const ObjectInfo &value)
	Outputs the description of an ObjectInfo to a stream, including all its fields.
std::ostream &	operator<< (std::ostream &os, const PropertyDescriptor &value)
	Outputs the description of a PropertyDescriptor to a stream, including all its fields.
std::ostream &	operator<< (std::ostream &os, const PropertySetDescriptor &value)
	Outputs the description of a PropertySetDescriptor to a stream, including all its fields.
std::ostream &	operator<< (std::ostream &os, const RegistryInfo &value)
	Outputs the description of a RegistryInfo to a stream, including all its fields.
std::ostream &	operator<< (std::ostream &os, const ReplicaGroupDescriptor &value)
	Outputs the description of a ReplicaGroupDescriptor to a stream, including all its fields.
std::ostream &	operator<< (std::ostream &os, const ServerDynamicInfo &value)
	Outputs the description of a ServerDynamicInfo to a stream, including all its fields.
std::ostream &	operator<< (std::ostream &os, const ServerInfo &value)
	Outputs the description of a ServerInfo to a stream, including all its fields.
std::ostream &	operator<< (std::ostream &os, const ServerInstanceDescriptor &value)
	Outputs the description of a ServerInstanceDescriptor to a stream, including all its fields.
std::ostream &	operator<< (std::ostream &os, const ServiceInstanceDescriptor &value)
	Outputs the description of a ServiceInstanceDescriptor to a stream, including all its fields.
std::ostream &	operator<< (std::ostream &os, const TemplateDescriptor &value)
	Outputs the description of a TemplateDescriptor to a stream, including all its fields.
std::ostream &	operator<< (std::ostream &os, LoadSample value)
	Outputs the enumerator name or underlying value of a LoadSample to a stream.
std::ostream &	operator<< (std::ostream &os, ServerState value)
	Outputs the enumerator name or underlying value of a ServerState to a stream.

Detailed Description

Deploy and manage Ice servers.