IceGrid Module Reference

Deploy and manage Ice servers. More...

[["cpp:dll-export:ICEGRID_API"]][["cpp:doxygen:include:IceGrid/IceGrid.h"]][["cpp:header-ext:h"]][["cpp:include:IceGrid/Config.h"]][["js:module:@zeroc/ice"]]["java:identifier:com.zeroc.IceGrid"]
module IceGrid { ... }

Interfaces
interface	AdapterObserver
	Monitors dynamically-registered object adapters. More...
interface	Admin
	Provides administrative access to an IceGrid deployment. More...
interface	AdminSession
	Represents an administrative session between an admin tool and an IceGrid registry. More...
interface	ApplicationObserver
	Monitors applications. More...
interface	FileIterator
	Iterates over an IceGrid log file. More...
interface	FileParser
	icegridadmin provides a FileParser object to transform XML files into ApplicationDescriptor objects. More...
interface	Locator
	Provides access to the Query and Registry objects implemented by the IceGrid registry. More...
interface	NodeObserver
	Monitors changes to the state of the nodes. More...
interface	ObjectObserver
	Monitors well-known objects that are added, updated or removed using Admin. More...
interface	Query
	Finds well-known Ice objects registered with the IceGrid registry. More...
interface	Registry
	Represents the main entry point into the IceGrid registry service. More...
interface	RegistryObserver
	Monitors changes to the state of the registries. More...
interface	Session
	Represents a session object used by IceGrid clients to allocate and release objects. More...
interface	UserAccountMapper
	Maps user strings in server descriptors to actual user account names. More...

Classes
class	AdaptiveLoadBalancingPolicy
	The load balancing policy that returns the endpoints of the server(s) with the lowest load average. More...
class	BoxedDistributionDescriptor
	A "boxed" distribution descriptor. More...
class	BoxedString
	A "boxed" string. More...
class	CommunicatorDescriptor
	Describes an Ice communicator. More...
class	IceBoxDescriptor
	Describes an IceBox server. More...
class	LoadBalancingPolicy
	The base class for load balancing policies. More...
class	OrderedLoadBalancingPolicy
	The load balancing policy that returns endpoints in order. More...
class	RandomLoadBalancingPolicy
	The load balancing policy that returns endpoints in a random order. More...
class	RoundRobinLoadBalancingPolicy
	The load balancing policy that returns endpoints using round-robin. More...
class	ServerDescriptor
	Describes an Ice server. More...
class	ServiceDescriptor
	Describes an IceBox service. More...

Structs
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...
struct	ApplicationDescriptor
	Describes an application. More...
struct	ApplicationInfo
	Information about an IceGrid application. 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...
struct	DistributionDescriptor
	Describes a distribution. More...
struct	LoadInfo
	Information about the load of a node. 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...
struct	NodeUpdateDescriptor
	Describes the updates to apply to a node in a deployed application. More...
struct	ObjectDescriptor
	Describes a well-known Ice object. More...
struct	ObjectInfo
	Information about an Ice well-known object. More...
struct	PropertyDescriptor
	Describes an Ice property. More...
struct	PropertySetDescriptor
	A property set descriptor. More...
struct	RegistryInfo
	Information about an IceGrid registry replica. More...
struct	ReplicaGroupDescriptor
	Describes a replica group. 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...
struct	ServiceInstanceDescriptor
	Describes an IceBox service. More...
struct	TemplateDescriptor
	Describes a template for a server or an IceBox service. More...

Exceptions
exception	AccessDeniedException
	The exception that is thrown when the registry update lock cannot be acquired. More...
exception	AdapterNotExistException
	The exception that is thrown when IceGrid does not know an object adapter with the provided adapter ID. More...
exception	AllocationException
	The exception that is thrown when the allocation of an object failed. More...
exception	AllocationTimeoutException
	The exception that is thrown when the request to allocate an object times out. More...
exception	ApplicationNotExistException
	The exception that is thrown when IceGrid does not know an application with the provided name. More...
exception	BadSignalException
	The exception that is thrown when an unknown signal is sent to a server. More...
exception	DeploymentException
	The exception that is thrown when IceGrid cannot deploy a server. More...
exception	FileNotAvailableException
	The exception that is thrown when a log file is not available. More...
exception	NodeNotExistException
	The exception that is thrown when IceGrid does not know a node with the provided name. More...
exception	NodeUnreachableException
	The exception that is thrown when IceGrid cannot reach a node. More...
exception	ObjectExistsException
	The exception that is thrown when a well-known object is already registered. More...
exception	ObjectNotRegisteredException
	The exception that is thrown when a well-known object is not registered. More...
exception	ObserverAlreadyRegisteredException
	The exception that is thrown when an observer is already registered with the registry. More...
exception	ParseException
	The exception that is thrown when an error occurs during the parsing of an IceGrid XML file. More...
exception	PermissionDeniedException
	The exception that is thrown when a client is not allowed to create a session. More...
exception	RegistryNotExistException
	The exception that is thrown when IceGrid does not know a registry with the provided name. More...
exception	RegistryUnreachableException
	The exception that is thrown when IceGrid cannot reach a registry. More...
exception	ServerNotExistException
	The exception that is thrown when IceGrid does not know a server with the provided server ID. More...
exception	ServerStartException
	The exception that is thrown when a server failed to start. More...
exception	ServerStopException
	The exception that is thrown when a server failed to stop. More...
exception	ServerUnreachableException
	The exception that is thrown when IceGrid cannot reach a server. More...
exception	UserAccountNotFoundException
	The exception that is thrown when a user account for a given session identifier can't be found. More...

Sequences
sequence< AdapterDescriptor >	AdapterDescriptorSeq
	A sequence of AdapterDescriptor.
sequence< AdapterDynamicInfo >	AdapterDynamicInfoSeq
	A sequence of AdapterDynamicInfo.
sequence< AdapterInfo >	AdapterInfoSeq
	A sequence of AdapterInfo.
sequence< ApplicationDescriptor >	ApplicationDescriptorSeq
	A sequence of ApplicationDescriptor.
sequence< ApplicationInfo >	ApplicationInfoSeq
	A sequence of ApplicationInfo.
sequence< NodeDynamicInfo >	NodeDynamicInfoSeq
	A sequence of NodeDynamicInfo.
sequence< NodeUpdateDescriptor >	NodeUpdateDescriptorSeq
	A sequence of NodeUpdateDescriptor.
sequence< ObjectDescriptor >	ObjectDescriptorSeq
	A sequence of ObjectDescriptor.
sequence< ObjectInfo >	ObjectInfoSeq
	A sequence of ObjectInfo.
sequence< PropertyDescriptor >	PropertyDescriptorSeq
	A sequence of PropertyDescriptor.
sequence< RegistryInfo >	RegistryInfoSeq
	A sequence of RegistryInfo.
sequence< ReplicaGroupDescriptor >	ReplicaGroupDescriptorSeq
	A sequence of ReplicaGroupDescriptor.
sequence< ServerDescriptor >	ServerDescriptorSeq
	A sequence of ServerDescriptor.
sequence< ServerDynamicInfo >	ServerDynamicInfoSeq
	A sequence of ServerDynamicInfo.
sequence< ServerInstanceDescriptor >	ServerInstanceDescriptorSeq
	A sequence of ServerInstanceDescriptor.
sequence< ServiceDescriptor >	ServiceDescriptorSeq
	A sequence of ServiceDescriptor.
sequence< ServiceInstanceDescriptor >	ServiceInstanceDescriptorSeq
	A sequence of ServiceInstanceDescriptor.

Dictionaries
dictionary< string, NodeDescriptor >	NodeDescriptorDict
	Mapping of node name to node descriptor.
dictionary< string, PropertySetDescriptor >	PropertySetDescriptorDict
	A mapping of property set name to property set descriptor.
dictionary< string, Object >	StringObjectProxyDict
	A dictionary of string to proxies.
dictionary< string, string >	StringStringDict
	A mapping of string to string.
dictionary< string, TemplateDescriptor >	TemplateDescriptorDict
	A mapping of template identifier to template descriptor.

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

Detailed Description

Deploy and manage Ice servers.