Ice 3.7 Slice API Reference
|
Go to the documentation of this file.
7 [[
"cpp:doxygen:include:IceGrid/IceGrid.h"]]
9 [[
"cpp:include:IceGrid/Config.h"]]
16 [[
"objc:header-dir:objc"]]
18 [[
"python:pkgdir:IceGrid"]]
20 #ifndef ICE_BUILDING_ICEGRIDDB
21 [[
"cpp:dll-export:ICEGRID_API"]]
23 [[
"objc:dll-export:ICEGRID_API"]]
29 #ifndef __SLICE2JAVA_COMPAT__
30 [[
"java:package:com.zeroc"]]
33 [
"objc:prefix:ICEGRID"]
517 [
"java:type:java.util.LinkedList<ServerInstanceDescriptor>"]
598 [
"java:type:java.util.LinkedList<ServiceInstanceDescriptor>"]
dictionary< string, NodeDescriptor > NodeDescriptorDict
Mapping of node name to node descriptor.
Definition: Descriptor.ice:671
string deactivationTimeout
The deactivation timeout (an integer value representing the number of seconds to wait for deactivatio...
Definition: Descriptor.ice:406
Ice::StringSeq envs
The server environment variables.
Definition: Descriptor.ice:382
string priority
The adapter priority.
Definition: Descriptor.ice:184
Ice::StringSeq removeServiceTemplates
The ids of the service template to remove.
Definition: Descriptor.ice:1077
ServerInstanceDescriptorSeq serverInstances
The server instances to update.
Definition: Descriptor.ice:936
ServerInstanceDescriptorSeq serverInstances
The server instances.
Definition: Descriptor.ice:635
PropertySetDescriptor propertySet
The property set.
Definition: Descriptor.ice:590
string description
The description of this node.
Definition: Descriptor.ice:656
Ice::StringSeq references
References to named property sets.
Definition: Descriptor.ice:86
A distribution descriptor defines an IcePatch2 server and the directories to retrieve from the patch ...
Definition: Descriptor.ice:323
A node descriptor.
Definition: Descriptor.ice:622
A property set descriptor.
Definition: Descriptor.ice:80
sequence< ReplicaGroupDescriptor > ReplicaGroupDescriptorSeq
A sequence of replica groups.
Definition: Descriptor.ice:789
An Ice object adapter descriptor.
Definition: Descriptor.ice:148
ObjectDescriptorSeq objects
The object descriptors associated with this object adapter.
Definition: Descriptor.ice:767
ObjectDescriptorSeq allocatables
The allocatable object descriptors associated with this object adapter.
Definition: Descriptor.ice:215
string value
The value of the boxed string.
Definition: Descriptor.ice:877
Ice::Identity id
The identity of the object.
Definition: Descriptor.ice:115
string id
The server id.
Definition: Descriptor.ice:343
ObjectDescriptorSeq objects
The well-known object descriptors associated with this object adapter.
Definition: Descriptor.ice:208
bool serverLifetime
If true the lifetime of this object adapter is the same of the server lifetime.
Definition: Descriptor.ice:201
string loadSample
The load sample to use for the load balancing.
Definition: Descriptor.ice:731
dictionary< string, string > StringStringDict
A mapping of string to string.
Definition: Descriptor.ice:42
string icepatch
The proxy of the IcePatch2 server.
Definition: Descriptor.ice:325
Ice::StringSeq removeVariables
The variables to remove.
Definition: Descriptor.ice:915
DbEnvDescriptorSeq dbEnvs
The database environments.
Definition: Descriptor.ice:298
Ice::StringSeq removePropertySets
The property sets to remove.
Definition: Descriptor.ice:1035
string activationTimeout
The activation timeout (an integer value representing the number of seconds to wait for activation).
Definition: Descriptor.ice:398
A "boxed" distribution descriptor.
Definition: Descriptor.ice:974
sequence< string > StringSeq
A sequence of strings.
Definition: BuiltinSequences.ice:51
string id
The object adapter id.
Definition: Descriptor.ice:168
sequence< DbEnvDescriptor > DbEnvDescriptorSeq
A sequence of database environment descriptors.
Definition: Descriptor.ice:270
Ice::StringSeq options
The command line options to pass to the server executable.
Definition: Descriptor.ice:375
string id
The id of the replica group.
Definition: Descriptor.ice:746
StringStringDict parameterDefaults
The parameters default values.
Definition: Descriptor.ice:546
Ice::StringSeq logs
The path of each log file.
Definition: Descriptor.ice:305
Ice::StringSeq parameters
The parameters required to instantiate the template.
Definition: Descriptor.ice:539
string type
The object type.
Definition: Descriptor.ice:122
string exe
The path of the server executable.
Definition: Descriptor.ice:350
string description
The description of this database environment.
Definition: Descriptor.ice:245
LoadBalancingPolicy loadBalancing
The load balancing policy.
Definition: Descriptor.ice:753
string name
The service name.
Definition: Descriptor.ice:457
dictionary< string, PropertySetDescriptor > PropertySetDescriptorDict
A mapping of property set name to property set descriptor.
Definition: Descriptor.ice:101
Property descriptor.
Definition: Descriptor.ice:50
StringStringDict variables
The variables defined in the application descriptor.
Definition: Descriptor.ice:810
StringStringDict variables
The variables to update.
Definition: Descriptor.ice:1014
A node update descriptor to describe the updates to apply to a node of a deployed application.
Definition: Descriptor.ice:887
PropertySetDescriptor propertySet
The property set.
Definition: Descriptor.ice:501
PropertySetDescriptorDict propertySets
The property sets to update.
Definition: Descriptor.ice:922
A service template instance descriptor.
Definition: Descriptor.ice:562
Ice::StringSeq removeServerTemplates
The ids of the server template to remove.
Definition: Descriptor.ice:1063
A communicator descriptor.
Definition: Descriptor.ice:278
string name
The name of the database environment.
Definition: Descriptor.ice:238
BoxedString loadFactor
The updated load factor of the node (or null if the load factor was not updated).
Definition: Descriptor.ice:958
TemplateDescriptorDict serverTemplates
The server templates.
Definition: Descriptor.ice:824
StringStringDict parameterValues
The template parameter values.
Definition: Descriptor.ice:575
sequence< ObjectDescriptor > ObjectDescriptorSeq
A sequence of object descriptors.
Definition: Descriptor.ice:139
CommunicatorDescriptor descriptor
The template.
Definition: Descriptor.ice:532
Ice::StringSeq removeServers
The ids of the servers to remove.
Definition: Descriptor.ice:950
sequence< NodeUpdateDescriptor > NodeUpdateDescriptorSeq
A sequence of node update descriptors.
Definition: Descriptor.ice:966
A template descriptor for server or service templates.
Definition: Descriptor.ice:526
Ordered load balancing policy.
Definition: Descriptor.ice:704
StringStringDict variables
The variables defined for the node.
Definition: Descriptor.ice:628
A Freeze database environment descriptor.
Definition: Descriptor.ice:232
string iceVersion
The Ice version used by this server.
Definition: Descriptor.ice:361
string loadFactor
Load factor of the node.
Definition: Descriptor.ice:649
DistributionDescriptor distrib
The application distribution.
Definition: Descriptor.ice:845
sequence< PropertyDescriptor > PropertyDescriptorSeq
A sequence of property descriptors.
Definition: Descriptor.ice:71
TemplateDescriptorDict serviceTemplates
The service templates to update.
Definition: Descriptor.ice:1070
StringStringDict parameterValues
The template parameter values.
Definition: Descriptor.ice:494
sequence< ServerDescriptor > ServerDescriptorSeq
A sequence of server descriptors.
Definition: Descriptor.ice:443
string description
The description of this replica group.
Definition: Descriptor.ice:774
A replica group descriptor.
Definition: Descriptor.ice:740
AdapterDescriptorSeq adapters
The object adapters.
Definition: Descriptor.ice:284
sequence< ServiceDescriptor > ServiceDescriptorSeq
A sequence of service descriptors.
Definition: Descriptor.ice:472
string name
The name of the node to update.
Definition: Descriptor.ice:893
bool registerProcess
Flag to specify if the object adapter will register a process object.
Definition: Descriptor.ice:191
string name
The object adapter name.
Definition: Descriptor.ice:154
NodeDescriptorDict nodes
The application nodes.
Definition: Descriptor.ice:838
ServerDescriptorSeq servers
Servers (which are not template instances).
Definition: Descriptor.ice:642
bool allocatable
Specifies if the server is allocatable.
Definition: Descriptor.ice:428
PropertySetDescriptorDict propertySets
Property set descriptors.
Definition: Descriptor.ice:663
string proxyOptions
Default options for proxies created for the replica group.
Definition: Descriptor.ice:760
string name
The application name.
Definition: Descriptor.ice:803
DistributionDescriptor distrib
The distribution descriptor.
Definition: Descriptor.ice:421
string activation
The server activation mode (possible values are "on-demand" or "manual").
Definition: Descriptor.ice:390
dictionary< string, TemplateDescriptor > TemplateDescriptorDict
A mapping of template identifier to template descriptor.
Definition: Descriptor.ice:554
ReplicaGroupDescriptorSeq replicaGroups
The replica groups.
Definition: Descriptor.ice:817
string dbHome
The home of the database environment (i.e., the directory where the database files will be stored).
Definition: Descriptor.ice:255
bool applicationDistrib
Specifies if the server depends on the application distribution.
Definition: Descriptor.ice:414
string proxyOptions
Proxy options to use with the proxy created for this Ice object.
Definition: Descriptor.ice:131
Ice::StringSeq removeNodes
The nodes to remove.
Definition: Descriptor.ice:1091
Random load balancing policy.
Definition: Descriptor.ice:695
PropertyDescriptorSeq properties
The configuration properties of the database environment.
Definition: Descriptor.ice:262
PropertySetDescriptorDict propertySets
Property set descriptors.
Definition: Descriptor.ice:859
PropertyDescriptorSeq properties
The property set properties.
Definition: Descriptor.ice:93
PropertySetDescriptorDict propertySets
The property sets to update.
Definition: Descriptor.ice:1028
string description
The description of this application.
Definition: Descriptor.ice:852
Adaptive load balancing policy.
Definition: Descriptor.ice:722
ServiceInstanceDescriptorSeq services
The service instances.
Definition: Descriptor.ice:613
string replicaGroupId
The replica id of this adapter.
Definition: Descriptor.ice:175
Ice::StringSeq removeVariables
The variables to remove.
Definition: Descriptor.ice:1021
sequence< ServiceInstanceDescriptor > ServiceInstanceDescriptorSeq
A sequence of service instance descriptors.
Definition: Descriptor.ice:599
PropertySetDescriptorDict servicePropertySets
The services property sets.
Definition: Descriptor.ice:509
sequence< ApplicationDescriptor > ApplicationDescriptorSeq
A sequence of application descriptors.
Definition: Descriptor.ice:867
NodeUpdateDescriptorSeq nodes
The application nodes to update.
Definition: Descriptor.ice:1084
string filter
The filter to use for this replica group.
Definition: Descriptor.ice:781
BoxedDistributionDescriptor distrib
The updated distribution application descriptor.
Definition: Descriptor.ice:1007
Ice::StringSeq removeReplicaGroups
The replica groups to remove.
Definition: Descriptor.ice:1049
string name
The name of the property.
Definition: Descriptor.ice:56
TemplateDescriptorDict serviceTemplates
The service templates.
Definition: Descriptor.ice:831
DistributionDescriptor value
The value of the boxed distribution descriptor.
Definition: Descriptor.ice:976
An application update descriptor to describe the updates to apply to a deployed application.
Definition: Descriptor.ice:986
Ice::StringSeq removePropertySets
The property sets to remove.
Definition: Descriptor.ice:929
ReplicaGroupDescriptorSeq replicaGroups
The replica groups to update.
Definition: Descriptor.ice:1042
An Ice object descriptor.
Definition: Descriptor.ice:109
An application descriptor.
Definition: Descriptor.ice:797
string user
The user account used to run the server.
Definition: Descriptor.ice:435
ServiceDescriptor descriptor
The service definition if the instance isn't a template instance (i.e.
Definition: Descriptor.ice:583
sequence< ServerInstanceDescriptor > ServerInstanceDescriptorSeq
A sequence of server instance descriptors.
Definition: Descriptor.ice:518
string name
The name of the application to update.
Definition: Descriptor.ice:992
A base class for load balancing policies.
Definition: Descriptor.ice:679
The identity of an Ice object.
Definition: Identity.ice:40
BoxedString description
The updated description (or null if the description wasn't updated.)
Definition: Descriptor.ice:1000
Ice::StringSeq directories
The source directories.
Definition: Descriptor.ice:328
StringStringDict variables
The variables to update.
Definition: Descriptor.ice:908
BoxedString description
The updated description (or null if the description wasn't updated.)
Definition: Descriptor.ice:901
A "boxed" string.
Definition: Descriptor.ice:875
TemplateDescriptorDict serverTemplates
The server templates to update.
Definition: Descriptor.ice:1056
Round robin load balancing policy.
Definition: Descriptor.ice:713
string pwd
The path to the server working directory.
Definition: Descriptor.ice:368
An Ice server descriptor.
Definition: Descriptor.ice:337
An IceBox service descriptor.
Definition: Descriptor.ice:451
string nReplicas
The number of replicas that will be used to gather the endpoints of a replica group.
Definition: Descriptor.ice:686
ServerDescriptorSeq servers
The servers which are not template instances to update.
Definition: Descriptor.ice:943
A server template instance descriptor.
Definition: Descriptor.ice:481
string description
The description of this object adapter.
Definition: Descriptor.ice:161
sequence< AdapterDescriptor > AdapterDescriptorSeq
A sequence of adapter descriptors.
Definition: Descriptor.ice:223
PropertySetDescriptor propertySet
The property set.
Definition: Descriptor.ice:291
An IceBox server descriptor.
Definition: Descriptor.ice:607
string entry
The entry point of the IceBox service.
Definition: Descriptor.ice:464
string value
The value of the property.
Definition: Descriptor.ice:63
string description
A description of this descriptor.
Definition: Descriptor.ice:312