Ice Reference Documentation
<<< Previous | Slice Documentation | Next >>>

# `IceGrid`

## Overview

    module IceGrid

IceGrid is a server activation and deployment tool. IceGrid, simplifies the complex task of deploying applications in a heterogenous computer network.

### Class Index

AdaptiveLoadBalancingPolicy

BoxedDistributionDescriptor

BoxedString

  A "boxed" string.

CommunicatorDescriptor

  A communicator descriptor.

IceBoxDescriptor

  An IceBox server descriptor.

LoadBalancingPolicy

RandomLoadBalancingPolicy

RoundRobinLoadBalancingPolicy

ServerDescriptor

  An Ice server descriptor.

ServiceDescriptor

  An IceBox service descriptor.

### Interface Index

Admin

  The IceGrid administrative interface.

NodeObserver

  The node observer interface.

Query

  The IceGrid query interface.

RegistryObserver

  The registry observer interface.

Session

SessionManager

### Exception Index

`AccessDeniedException`

  This exception is raised if an operation can't be performed because the regitry lock wasn't acquired or is already acquired by a session.

`AdapterNotExistException`

  This exception is raised if an adapter does not exist.

`ApplicationNotExistException`

  This exception is raised if an application does not exist.

`BadSignalException`

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

`DeploymentException`

  An exception for deployment failure errors.

`NodeNotExistException`

  This exception is raised if a node does not exist.

`NodeUnreachableException`

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

`ObjectExistsException`

  This exception is raised if an object already exists.

`ObjectNotRegisteredException`

  This exception is raised if an object is not registered.

`PatchException`

  This exception is raised if the patching failed.

`ServerNotExistException`

  This exception is raised if a server does not exist.

`ServerStartException`

  This exception is raised if a server failed to start.

### Struct Index

`AdapterDescriptor`

  An Ice object adapter descriptor.

`AdapterDynamicInfo`

  Dynamic information about the state of an adapter.

`AdapterInfo`

  Information on an adapter registered with the IceGrid registry.

`ApplicationDescriptor`

  An application descriptor.

`ApplicationUpdateDescriptor`

`DbEnvDescriptor`

  A Freeze database environment descriptor.

`DistributionDescriptor`

`LoadInfo`

`NodeDescriptor`

`NodeDynamicInfo`

  Dynamic information about the state of a node.

`NodeInfo`

`NodeUpdateDescriptor`

`ObjectDescriptor`

  An Ice object descriptor.

`ObjectInfo`

  Information on an Ice object.

`PropertyDescriptor`

  Property descriptor.

`ReplicaGroupDescriptor`

  A replica group descriptor.

`ServerDynamicInfo`

  Dynamic information about the state of a server.

`ServerInfo`

  Information on a server managed by an IceGrid node.

`ServerInstanceDescriptor`

  A server template instance descriptor.

`ServiceInstanceDescriptor`

`TemplateDescriptor`

### Sequence Index

AdapterDescriptorSeq

  A sequence of adapter descriptors.

AdapterDynamicInfoSeq

  A sequence of adapter dynamic information structures.

ApplicationDescriptorSeq

  A sequence of application descriptors.

DbEnvDescriptorSeq

  A sequence of database environment descriptors.

NodeDynamicInfoSeq

  A sequence of node dynamic information structures.

NodeUpdateDescriptorSeq

ObjectDescriptorSeq

  A sequence of object descriptors.

ObjectInfoSeq

  A sequence of object information structures.

PropertyDescriptorSeq

ReplicaGroupDescriptorSeq

  A sequence of replica groups.

ServerDescriptorSeq

  A sequence of server descriptors.

ServerDynamicInfoSeq

  A sequence of server dynamic information structures.

ServerInstanceDescriptorSeq

  A sequence of server instance descriptors.

ServiceDescriptorSeq

  A sequence of service descriptors.

ServiceInstanceDescriptorSeq

### Dictionary Index

AdapterInfoDict

DistributionDescriptorDict

NodeDescriptorDict

StringObjectProxyDict

  A dictionary of proxies.

StringStringDict

TemplateDescriptorDict

### Enum Index

LoadSample

ServerState

  An enumeration representing the state of the server.

## `AdapterDescriptorSeq`

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

A sequence of adapter descriptors.

### Used By

CommunicatorDescriptor::adapters

## `AdapterDynamicInfoSeq`

    sequence<AdapterDynamicInfo> AdapterDynamicInfoSeq;

A sequence of adapter dynamic information structures.

### Used By

NodeDynamicInfo::adapters

## `ApplicationDescriptorSeq`

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

A sequence of application descriptors.

### Used By

`RegistryObserver::init`

## `DbEnvDescriptorSeq`

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

A sequence of database environment descriptors.

### Used By

CommunicatorDescriptor::dbEnvs

## `NodeDynamicInfoSeq`

    sequence<NodeDynamicInfo> NodeDynamicInfoSeq;

A sequence of node dynamic information structures.

### Used By

`NodeObserver::init`

## `NodeUpdateDescriptorSeq`

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

### Used By

ApplicationUpdateDescriptor::nodes

## `ObjectDescriptorSeq`

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

A sequence of object descriptors.

### Used By

AdapterDescriptor::objects, ReplicaGroupDescriptor::objects

## `ObjectInfoSeq`

    sequence<ObjectInfo> ObjectInfoSeq;

A sequence of object information structures.

### Used By

`Admin::getAllObjectInfos`

## `PropertyDescriptorSeq`

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

### Used By

CommunicatorDescriptor::properties, DbEnvDescriptor::properties

## `ReplicaGroupDescriptorSeq`

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

A sequence of replica groups.

### Used By

ApplicationDescriptor::replicaGroups, ApplicationUpdateDescriptor::replicaGroups

## `ServerDescriptorSeq`

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

A sequence of server descriptors.

### Used By

NodeDescriptor::servers, NodeUpdateDescriptor::servers

## `ServerDynamicInfoSeq`

    sequence<ServerDynamicInfo> ServerDynamicInfoSeq;

A sequence of server dynamic information structures.

### Used By

NodeDynamicInfo::servers

## `ServerInstanceDescriptorSeq`

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

A sequence of server instance descriptors.

### Used By

NodeDescriptor::serverInstances, NodeUpdateDescriptor::serverInstances

## `ServiceDescriptorSeq`

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

A sequence of service descriptors.

## `ServiceInstanceDescriptorSeq`

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

### Used By

IceBoxDescriptor::services

## `AdapterInfoDict`

    dictionary<string, AdapterInfo> AdapterInfoDict;

## `DistributionDescriptorDict`

    dictionary<string, DistributionDescriptor> DistributionDescriptorDict;

## `NodeDescriptorDict`

    dictionary<string, NodeDescriptor> NodeDescriptorDict;

### Used By

ApplicationDescriptor::nodes

## `StringObjectProxyDict`

    dictionary<string, Object*> StringObjectProxyDict;

A dictionary of proxies.

### Used By

`Admin::getAdapterEndpoints`

## `StringStringDict`

    dictionary<string, string> StringStringDict;

### Used By

ApplicationDescriptor::variables, ApplicationUpdateDescriptor::variables, NodeDescriptor::variables, NodeUpdateDescriptor::variables, ServerInstanceDescriptor::parameterValues, ServiceInstanceDescriptor::parameterValues, TemplateDescriptor::parameterDefaults

## `TemplateDescriptorDict`

    dictionary<string, TemplateDescriptor> TemplateDescriptorDict;

### Used By

ApplicationDescriptor::serverTemplates, ApplicationDescriptor::serviceTemplates, ApplicationUpdateDescriptor::serverTemplates, ApplicationUpdateDescriptor::serviceTemplates

<<< Previous | Home | Next >>>
`IceBox::ServiceManager` | Up | `IceGrid::AccessDeniedException`