[["cpp:dll-export:ICEGRID_API"]][["cpp:doxygen:include:IceGrid/IceGrid.h"]][["cpp:header-ext:h"]][["cpp:include:IceGrid/Config.h"]][["ice-prefix"]][["js:module:ice"]][["js:cjs-module"]][["objc:dll-export:ICEGRID_API"]][["objc:header-dir:objc"]][["python:pkgdir:IceGrid"]][["java:package:com.zeroc"]]["objc:prefix:ICEGRID"] module IceGrid { ... }

Interfaces
interface	AdapterObserver
	This interface allows applications to monitor the state of object adapters that are registered with IceGrid. More...

interface	Admin
	The IceGrid administrative interface. More...

interface	AdminSession
	Used by administrative clients to view, update, and receive observer updates from the IceGrid registry. More...

interface	ApplicationObserver
	The database observer interface. More...

interface	FileIterator
	This interface provides access to IceGrid log file contents. More...

interface	FileParser
	`icegridadmin` provides a FileParser object to transform XML files into ApplicationDescriptor objects. More...

interface	Locator
	The IceGrid locator interface provides access to the Query and Registry object of the IceGrid registry. More...

interface	NodeObserver
	The node observer interface. More...

interface	ObjectObserver
	This interface allows applications to monitor IceGrid well-known objects. More...

interface	Query
	The IceGrid query interface. More...

interface	Registry
	The IceGrid registry allows clients create sessions directly with the registry. More...

interface	RegistryObserver
	This interface allows applications to monitor changes the state of the registry. More...

local interface	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...

local interface	ReplicaGroupFilter
	The ReplicaGroupFilter is used by IceGrid to filter adapters returned to the client when it resolves a filtered replica group. More...

interface	Session
	A session object is used by IceGrid clients to allocate and release objects. More...

local interface	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...

interface	UserAccountMapper
	A user account mapper object is used by IceGrid nodes to map session identifiers to user accounts. More...

Classes
class	AdaptiveLoadBalancingPolicy
	Adaptive load balancing policy. More...

class	BoxedDistributionDescriptor
	A "boxed" distribution descriptor. More...

class	BoxedString
	A "boxed" string. More...

class	CommunicatorDescriptor
	A communicator descriptor. More...

class	IceBoxDescriptor
	An IceBox server descriptor. More...

class	LoadBalancingPolicy
	A base class for load balancing policies. More...

class	OrderedLoadBalancingPolicy
	Ordered load balancing policy. More...

class	RandomLoadBalancingPolicy
	Random load balancing policy. More...

class	RoundRobinLoadBalancingPolicy
	Round robin load balancing policy. More...

class	ServerDescriptor
	An Ice server descriptor. More...

class	ServiceDescriptor
	An IceBox service descriptor. More...

Structs
struct	AdapterDescriptor
	An Ice object adapter descriptor. 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
	An application descriptor. 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	DbEnvDescriptor
	A Freeze database environment descriptor. More...

struct	DistributionDescriptor
	A distribution descriptor defines an IcePatch2 server and the directories to retrieve from the patch server. More...

struct	LoadInfo
	Information about the load of a node. More...

struct	NodeDescriptor
	A node descriptor. More...

struct	NodeDynamicInfo
	Dynamic information about the state of a node. More...

struct	NodeInfo
	Information about an IceGrid node. More...

struct	NodeUpdateDescriptor
	A node update descriptor to describe the updates to apply to a node of a deployed application. More...

struct	ObjectDescriptor
	An Ice object descriptor. More...

struct	ObjectInfo
	Information about an Ice object. More...

struct	PropertyDescriptor
	Property descriptor. More...

struct	PropertySetDescriptor
	A property set descriptor. More...

struct	RegistryInfo
	Information about an IceGrid registry replica. More...

struct	ReplicaGroupDescriptor
	A replica group descriptor. 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
	A server template instance descriptor. More...

struct	ServiceInstanceDescriptor
	A service template instance descriptor. More...

struct	TemplateDescriptor
	A template descriptor for server or service templates. More...

Exceptions
exception	AccessDeniedException
	This exception is raised if a registry lock wasn't acquired or is already held by a session. More...

exception	AdapterNotExistException
	This exception is raised if an adapter does not exist. More...

exception	AllocationException
	This exception is raised if the allocation of an object failed. More...

exception	AllocationTimeoutException
	This exception is raised if the request to allocate an object times out. More...

exception	ApplicationNotExistException
	This exception is raised if an application does not exist. More...

exception	BadSignalException
	This exception is raised if an unknown signal was sent to to a server. More...

exception	DeploymentException
	An exception for deployment errors. More...

exception	FileNotAvailableException
	This exception is raised if a file is not available. More...

exception	NodeNotExistException
	This exception is raised if a node does not exist. More...

exception	NodeUnreachableException
	This exception is raised if a node could not be reached. More...

exception	ObjectExistsException
	This exception is raised if an object already exists. More...

exception	ObjectNotRegisteredException
	This exception is raised if an object is not registered. More...

exception	ObserverAlreadyRegisteredException
	This exception is raised if an observer is already registered with the registry. More...

exception	ParseException
	This exception is raised if an error occurs during parsing. More...

exception	PatchException
	This exception is raised if a patch failed. More...

exception	PermissionDeniedException
	This exception is raised if a client is denied the ability to create a session with IceGrid. More...

exception	RegistryNotExistException
	This exception is raised if a registry does not exist. More...

exception	RegistryUnreachableException
	This exception is raised if a registry could not be reached. More...

exception	ServerNotExistException
	This exception is raised if a server does not exist. More...

exception	ServerStartException
	This exception is raised if a server failed to start. More...

exception	ServerStopException
	This exception is raised if a server failed to stop. More...

exception	ServerUnreachableException
	This exception is raised if a server could not be reached. More...

exception	UserAccountNotFoundException
	This exception is raised if a user account for a given session identifier can't be found. More...

Sequences
sequence< AdapterDescriptor >	AdapterDescriptorSeq
	A sequence of adapter descriptors. More...

sequence< AdapterDynamicInfo >	AdapterDynamicInfoSeq
	A sequence of adapter dynamic information structures. More...

sequence< AdapterInfo >	AdapterInfoSeq
	A sequence of adapter information structures. More...

sequence< ApplicationDescriptor >	ApplicationDescriptorSeq
	A sequence of application descriptors. More...

sequence< ApplicationInfo >	ApplicationInfoSeq
	A sequence of ApplicationInfo structures. More...

sequence< DbEnvDescriptor >	DbEnvDescriptorSeq
	A sequence of database environment descriptors. More...

sequence< NodeDynamicInfo >	NodeDynamicInfoSeq
	A sequence of node dynamic information structures. More...

sequence< NodeUpdateDescriptor >	NodeUpdateDescriptorSeq
	A sequence of node update descriptors. More...

sequence< ObjectDescriptor >	ObjectDescriptorSeq
	A sequence of object descriptors. More...

sequence< ObjectInfo >	ObjectInfoSeq
	A sequence of object information structures. More...

sequence< PropertyDescriptor >	PropertyDescriptorSeq
	A sequence of property descriptors. More...

sequence< RegistryInfo >	RegistryInfoSeq
	A sequence of RegistryInfo structures. More...

sequence< ReplicaGroupDescriptor >	ReplicaGroupDescriptorSeq
	A sequence of replica groups. More...

sequence< ServerDescriptor >	ServerDescriptorSeq
	A sequence of server descriptors. More...

sequence< ServerDynamicInfo >	ServerDynamicInfoSeq
	A sequence of server dynamic information structures. More...

sequence< ServerInstanceDescriptor >	ServerInstanceDescriptorSeq
	A sequence of server instance descriptors. More...

sequence< ServiceDescriptor >	ServiceDescriptorSeq
	A sequence of service descriptors. More...

sequence< ServiceInstanceDescriptor >	ServiceInstanceDescriptorSeq
	A sequence of service instance descriptors. More...

Dictionaries
dictionary< string, NodeDescriptor >	NodeDescriptorDict
	Mapping of node name to node descriptor. More...

dictionary< string, PropertySetDescriptor >	PropertySetDescriptorDict
	A mapping of property set name to property set descriptor. More...

dictionary< string, Object >	StringObjectProxyDict
	A dictionary of proxies. More...

dictionary< string, string >	StringStringDict
	A mapping of string to string. More...

dictionary< string, TemplateDescriptor >	TemplateDescriptorDict
	A mapping of template identifier to template descriptor. More...

Enumerations
enum	LoadSample { LoadSample1, LoadSample5, LoadSample15 }
	Determines which load sampling interval to use. More...

enum	ServerState { Inactive, Activating, ActivationTimedOut, Active, Deactivating, Destroying, Destroyed }
	An enumeration representing the state of the server. More...

Sequence Documentation

◆ AdapterDescriptorSeq

["java:type:java.util.LinkedList<AdapterDescriptor>"]

sequence<AdapterDescriptor> AdapterDescriptorSeq

A sequence of adapter descriptors.

◆ AdapterDynamicInfoSeq

["java:type:java.util.LinkedList<AdapterDynamicInfo>"]

sequence<AdapterDynamicInfo> AdapterDynamicInfoSeq

A sequence of adapter dynamic information structures.

◆ AdapterInfoSeq

sequence<AdapterInfo> AdapterInfoSeq

A sequence of adapter information structures.

◆ ApplicationDescriptorSeq

["java:type:java.util.LinkedList<ApplicationDescriptor>"]

sequence<ApplicationDescriptor> ApplicationDescriptorSeq

A sequence of application descriptors.

◆ ApplicationInfoSeq

["java:type:java.util.LinkedList<ApplicationInfo>"]

sequence<ApplicationInfo> ApplicationInfoSeq

A sequence of ApplicationInfo structures.

◆ DbEnvDescriptorSeq

["java:type:java.util.LinkedList<DbEnvDescriptor>"]

sequence<DbEnvDescriptor> DbEnvDescriptorSeq

A sequence of database environment descriptors.

◆ NodeDynamicInfoSeq

sequence<NodeDynamicInfo> NodeDynamicInfoSeq

A sequence of node dynamic information structures.

◆ NodeUpdateDescriptorSeq

["java:type:java.util.LinkedList<NodeUpdateDescriptor>"]

sequence<NodeUpdateDescriptor> NodeUpdateDescriptorSeq

A sequence of node update descriptors.

◆ ObjectDescriptorSeq

["java:type:java.util.LinkedList<ObjectDescriptor>"]

sequence<ObjectDescriptor> ObjectDescriptorSeq

A sequence of object descriptors.

◆ ObjectInfoSeq

sequence<ObjectInfo> ObjectInfoSeq

A sequence of object information structures.

◆ PropertyDescriptorSeq

["java:type:java.util.LinkedList<PropertyDescriptor>"]

sequence<PropertyDescriptor> PropertyDescriptorSeq

A sequence of property descriptors.

◆ RegistryInfoSeq

sequence<RegistryInfo> RegistryInfoSeq

A sequence of RegistryInfo structures.

◆ ReplicaGroupDescriptorSeq

["java:type:java.util.LinkedList<ReplicaGroupDescriptor>"]

sequence<ReplicaGroupDescriptor> ReplicaGroupDescriptorSeq

A sequence of replica groups.

◆ ServerDescriptorSeq

["java:type:java.util.LinkedList<ServerDescriptor>"]

sequence<ServerDescriptor> ServerDescriptorSeq

A sequence of server descriptors.

◆ ServerDynamicInfoSeq

["java:type:java.util.LinkedList<ServerDynamicInfo>"]

sequence<ServerDynamicInfo> ServerDynamicInfoSeq

A sequence of server dynamic information structures.

◆ ServerInstanceDescriptorSeq

["java:type:java.util.LinkedList<ServerInstanceDescriptor>"]

sequence<ServerInstanceDescriptor> ServerInstanceDescriptorSeq

A sequence of server instance descriptors.

◆ ServiceDescriptorSeq

["java:type:java.util.LinkedList<ServiceDescriptor>"]

sequence<ServiceDescriptor> ServiceDescriptorSeq

A sequence of service descriptors.

◆ ServiceInstanceDescriptorSeq

["java:type:java.util.LinkedList<ServiceInstanceDescriptor>"]

sequence<ServiceInstanceDescriptor> ServiceInstanceDescriptorSeq

A sequence of service instance descriptors.

Dictionary Documentation

◆ NodeDescriptorDict

dictionary<string, NodeDescriptor> NodeDescriptorDict

Mapping of node name to node descriptor.

◆ PropertySetDescriptorDict

dictionary<string, PropertySetDescriptor> PropertySetDescriptorDict

A mapping of property set name to property set descriptor.

◆ StringObjectProxyDict

dictionary<string, Object> StringObjectProxyDict

A dictionary of proxies.

◆ StringStringDict

dictionary<string, string> StringStringDict

A mapping of string to string.

◆ TemplateDescriptorDict

dictionary<string, TemplateDescriptor> TemplateDescriptorDict

A mapping of template identifier to template descriptor.

Enumeration Type Documentation

◆ LoadSample

enum LoadSample

Determines which load sampling interval to use.

Enumerator
LoadSample1	Sample every minute.
LoadSample5	Sample every five minutes.
LoadSample15	Sample every fifteen minutes.

◆ ServerState

enum ServerState

An enumeration representing the state of the server.

Enumerator
Inactive	The server is not running.
Activating	The server is being activated and will change to the active state when the registered server object adapters are activated or to the activation timed out state if the activation timeout expires.
ActivationTimedOut	The activation timed out state indicates that the server activation timed out.
Active	The server is running.
Deactivating	The server is being deactivated.
Destroying	The server is being destroyed.
Destroyed	The server is destroyed.

Interfaces

Classes

Structs

Exceptions

Sequences

Dictionaries

Enumerations