Ice 3.7 Slice API Reference
|
Go to the documentation of this file.
7 [[
"cpp:dll-export:ICEGRID_API"]]
8 [[
"cpp:doxygen:include:IceGrid/IceGrid.h"]]
10 [[
"cpp:include:IceGrid/Config.h"]]
17 [[
"objc:dll-export:ICEGRID_API"]]
18 [[
"objc:header-dir:objc"]]
20 [[
"python:pkgdir:IceGrid"]]
30 #ifndef __SLICE2JAVA_COMPAT__
31 [[
"java:package:com.zeroc"]]
34 [
"objc:prefix:ICEGRID"]
611 ["nonmutating", "cpp:const"] idempotent
Ice::
StringSeq getAllApplicationNames();
624 ["nonmutating", "cpp:const"] idempotent
ServerInfo getServerInfo(
string id)
644 ["nonmutating", "cpp:const"] idempotent
ServerState getServerState(
string id)
665 ["nonmutating", "cpp:const"] idempotent
int getServerPid(
string id)
678 idempotent
string getServerAdminCategory();
698 idempotent
Object* getServerAdmin(
string id)
721 idempotent
void enableServer(
string id,
bool enabled)
742 ["nonmutating", "cpp:const"] idempotent
bool isServerEnabled(
string id)
764 ["amd"]
void startServer(
string id)
786 ["amd"]
void stopServer(
string id)
810 ["amd"]
void patchServer(
string id,
bool shutdown)
834 void sendSignal(
string id,
string signal)
844 ["nonmutating", "cpp:const"] idempotent
Ice::
StringSeq getAllServerIds();
877 void removeAdapter(
string id)
887 ["nonmutating", "cpp:const"] idempotent
Ice::
StringSeq getAllAdapterIds();
905 void addObject(
Object* obj)
925 void updateObject(
Object* obj)
943 void addObjectWithType(
Object* obj,
string type)
964 void removeObject(
Ice::Identity
id)
979 ["nonmutating", "cpp:const"] idempotent
ObjectInfo getObjectInfo(
Ice::Identity
id)
992 ["nonmutating", "cpp:const"] idempotent
ObjectInfoSeq getObjectInfosByType(
string type);
1007 ["nonmutating", "cpp:const"] idempotent
ObjectInfoSeq getAllObjectInfos(
string expr);
1020 ["nonmutating", "cpp:const"] idempotent
bool pingNode(
string name)
1037 ["nonmutating", "cpp:const"] idempotent
LoadInfo getNodeLoad(
string name)
1054 ["nonmutating", "cpp:const"] idempotent
NodeInfo getNodeInfo(
string name)
1071 ["cpp:const"] idempotent
Object* getNodeAdmin(
string name)
1095 ["nonmutating", "cpp:const"] idempotent
int getNodeProcessorSocketCount(
string name)
1110 void shutdownNode(
string name)
1127 ["nonmutating", "cpp:const"] idempotent
string getNodeHostname(
string name)
1150 ["cpp:const"] idempotent
bool pingRegistry(
string name)
1181 ["cpp:const"] idempotent
Object* getRegistryAdmin(
string name)
1196 idempotent
void shutdownRegistry(
string name)
1760 ["cpp:const"] idempotent
string getReplicaName();
void addApplication(ApplicationDescriptor descriptor)
Add an application to IceGrid.
string replicaGroupId
The replica group id of the object adapter, or empty if the adapter doesn't belong to a replica group...
Definition: Admin.ice:164
string application
The server application.
Definition: Admin.ice:186
string uuid
The application uuid.
Definition: Admin.ice:193
int startUpdate()
Acquires an exclusive lock to start updating the registry applications.
Information about the load of a node.
Definition: Admin.ice:327
Information about a server managed by an IceGrid node.
Definition: Admin.ice:180
int revision
The application revision number.
Definition: Admin.ice:361
Object * proxy
The direct proxy containing the adapter endpoints.
Definition: Admin.ice:1325
This exception is raised if a registry does not exist.
Definition: Exception.ice:177
void updateApplication(ApplicationUpdateDescriptor descriptor)
Update a deployed application with the given update application descriptor.
NodeInfo info
Some static information about the node.
Definition: Admin.ice:1347
bool enabled
Indicates whether the server is enabled.
Definition: Admin.ice:1296
void destroy()
Destroy the iterator.
void objectAdded(ObjectInfo info)
The objectAdded operation is called to notify an observer when an object was added to the Admin inter...
string id
The id of the adapter.
Definition: Admin.ice:1318
void applicationUpdated(int serial, ApplicationUpdateInfo desc)
The applicationUpdated operation is called to notify an observer that an application was updated.
void updateAdapter(string node, AdapterDynamicInfo updatedInfo)
The updateAdapter operation is called to notify an observer that the state of an adapter changed.
void adapterRemoved(string id)
The adapterRemoved operation is called to notify an observer when a dynamically-registered adapter wa...
float avg15
The load average over the past 15 minutes.
Definition: Admin.ice:335
This exception is raised if an object already exists.
Definition: Exception.ice:132
void nodeUp(NodeDynamicInfo node)
The nodeUp operation is called to notify an observer that a node came up.
void objectUpdated(ObjectInfo info)
objectUpdated is called to notify an observer when an object registered with the Admin interface was ...
string release
The operation system release level (as defined in uname()).
Definition: Admin.ice:258
dictionary< string, Object > StringObjectProxyDict
A dictionary of proxies.
Definition: Admin.ice:104
Dynamic information about the state of a node.
Definition: Admin.ice:1341
string type
The type of the object.
Definition: Admin.ice:126
sequence< RegistryInfo > RegistryInfoSeq
A sequence of RegistryInfo structures.
Definition: Admin.ice:319
This exception is raised if an observer is already registered with the registry.
Definition: Exception.ice:365
This exception is raised if a patch failed.
Definition: Exception.ice:289
sequence< NodeDynamicInfo > NodeDynamicInfoSeq
A sequence of node dynamic information structures.
Definition: Admin.ice:1408
Used by administrative clients to view, update, and receive observer updates from the IceGrid registr...
Definition: Admin.ice:1644
sequence< string > StringSeq
A sequence of strings.
Definition: BuiltinSequences.ice:51
@ Inactive
The server is not running.
Definition: Admin.ice:50
This interface provides access to IceGrid log file contents.
Definition: Admin.ice:1231
int pid
The process id of the server.
Definition: Admin.ice:1289
ServerDynamicInfoSeq servers
The dynamic information of the servers deployed on this node.
Definition: Admin.ice:1354
Object * proxy
The proxy of the object.
Definition: Admin.ice:119
string hostname
The network name of the host running this node (as defined in uname()).
Definition: Admin.ice:251
This exception is raised if an adapter does not exist.
Definition: Exception.ice:117
This interface allows applications to monitor IceGrid well-known objects.
Definition: Admin.ice:1590
float avg5
The load average over the past 5 minutes.
Definition: Admin.ice:332
idempotent void setObservers(RegistryObserver *registryObs, NodeObserver *nodeObs, ApplicationObserver *appObs, AdapterObserver *adptObs, ObjectObserver *objObs)
Set the observer proxies that receive notifications when the state of the registry or nodes changes.
This exception is raised if a node could not be reached.
Definition: Exception.ice:207
idempotent Object * getAdminCallbackTemplate()
Get a "template" proxy for admin callback objects.
long createTime
The creation time.
Definition: Admin.ice:349
The IceGrid administrative interface.
Definition: Admin.ice:403
This exception is raised if a file is not available.
Definition: Exception.ice:387
ServerState
An enumeration representing the state of the server.
Definition: Admin.ice:44
@ Destroyed
The server is destroyed.
Definition: Admin.ice:96
void syncApplication(ApplicationDescriptor descriptor)
Synchronize a deployed application with the given application descriptor.
string version
The operation system version (as defined in uname()).
Definition: Admin.ice:265
void syncApplicationWithoutRestart(ApplicationDescriptor descriptor)
Synchronize a deployed application with the given application descriptor.
Dynamic information about the state of a server.
Definition: Admin.ice:1269
string id
The id of the adapter.
Definition: Admin.ice:149
void applicationRemoved(int serial, string name)
The applicationRemoved operation is called to notify an observer that an application was removed.
sequence< ServerDynamicInfo > ServerDynamicInfoSeq
A sequence of server dynamic information structures.
Definition: Admin.ice:1304
string uuid
Unique application identifier.
Definition: Admin.ice:346
void adapterAdded(AdapterInfo info)
The adapterAdded operation is called to notify an observer when a dynamically-registered adapter was ...
Information about an IceGrid application.
Definition: Admin.ice:344
ApplicationDescriptor descriptor
The application descriptor.
Definition: Admin.ice:364
@ Deactivating
The server is being deactivated.
Definition: Admin.ice:82
void applicationAdded(int serial, ApplicationInfo desc)
The applicationAdded operation is called to notify an observer that an application was added.
string createUser
The user who created the application.
Definition: Admin.ice:352
sequence< ApplicationInfo > ApplicationInfoSeq
A sequence of ApplicationInfo structures.
Definition: Admin.ice:372
int nProcessors
The number of processor threads on the node.
Definition: Admin.ice:281
void nodeDown(string name)
The nodeDown operation is called to notify an observer that a node went down.
string name
The name of the registry.
Definition: Admin.ice:303
@ Destroying
The server is being destroyed.
Definition: Admin.ice:89
Information about an IceGrid node.
Definition: Admin.ice:230
long updateTime
The update time.
Definition: Admin.ice:355
An exception for deployment errors.
Definition: Exception.ice:192
ServerDescriptor descriptor
The server descriptor.
Definition: Admin.ice:214
@ Activating
The server is being activated and will change to the active state when the registered server object a...
Definition: Admin.ice:60
AdapterDynamicInfoSeq adapters
The dynamic information of the adapters deployed on this node.
Definition: Admin.ice:1361
This exception is raised if a server failed to start.
Definition: Exception.ice:73
This interface allows applications to monitor the state of object adapters that are registered with I...
Definition: Admin.ice:1542
idempotent void keepAlive()
Keep the session alive.
sequence< ObjectInfo > ObjectInfoSeq
A sequence of object information structures.
Definition: Admin.ice:134
void patchApplication(string name, bool shutdown)
Patch the given application data.
This exception is raised if an object is not registered.
Definition: Exception.ice:147
sequence< AdapterInfo > AdapterInfoSeq
A sequence of adapter information structures.
Definition: Admin.ice:172
This exception is raised if a registry could not be reached.
Definition: Exception.ice:251
string updateUser
The user who updated the application.
Definition: Admin.ice:385
string id
The id of the server.
Definition: Admin.ice:1275
void nodeInit(NodeDynamicInfoSeq nodes)
The nodeInit operation indicates the current state of nodes.
idempotent Admin * getAdmin()
Get the admin interface.
This exception is raised if a server does not exist.
Definition: Exception.ice:58
ServerState state
The state of the server.
Definition: Admin.ice:1282
sequence< AdapterDynamicInfo > AdapterDynamicInfoSeq
A sequence of adapter dynamic information structures.
Definition: Admin.ice:1333
string machine
The machine hardware type (as defined in uname()).
Definition: Admin.ice:272
long updateTime
The update time.
Definition: Admin.ice:382
idempotent void setObserversByIdentity(Ice::Identity registryObs, Ice::Identity nodeObs, Ice::Identity appObs, Ice::Identity adptObs, Ice::Identity objObs)
Set the observer identities that receive notifications the state of the registry or nodes changes.
This exception is raised if a server failed to stop.
Definition: Exception.ice:95
void applicationInit(int serial, ApplicationInfoSeq applications)
applicationInit is called after the registration of an observer to indicate the state of the registry...
This exception is raised if an unknown signal was sent to to a server.
Definition: Exception.ice:274
The node observer interface.
Definition: Admin.ice:1418
string sessionId
The id of the session which allocated the server.
Definition: Admin.ice:221
The Ice core library.
Definition: BuiltinSequences.ice:27
Object * proxy
A dummy direct proxy that contains the adapter endpoints.
Definition: Admin.ice:156
void updateApplicationWithoutRestart(ApplicationUpdateDescriptor descriptor)
Update a deployed application with the given update application descriptor only if no server restarts...
float avg1
The load average over the past minute.
Definition: Admin.ice:329
string name
The name of the node.
Definition: Admin.ice:236
void updateServer(string node, ServerDynamicInfo updatedInfo)
The updateServer operation is called to notify an observer that the state of a server changed.
Information about updates to an IceGrid application.
Definition: Admin.ice:380
string dataDir
The path to the node data directory.
Definition: Admin.ice:288
@ Active
The server is running.
Definition: Admin.ice:75
This exception is raised if a node does not exist.
Definition: Exception.ice:162
dictionary< string, string > SliceChecksumDict
A mapping from type IDs to Slice checksums.
Definition: SliceChecksumDict.ice:34
idempotent ApplicationInfo getApplicationInfo(string name)
Get an application descriptor.
A client-visible session object, which is tied to the lifecycle of a Router.
Definition: Session.ice:57
void registryDown(string name)
The nodeDown operation is called to notify an observer that a node went down.
void instantiateServer(string application, string node, ServerInstanceDescriptor desc)
Instantiate a server template from an application on the given node.
void adapterUpdated(AdapterInfo info)
The adapterUpdated operation is called to notify an observer when a dynamically-registered adapter wa...
This exception is raised if a registry lock wasn't acquired or is already held by a session.
Definition: Exception.ice:305
An application update descriptor to describe the updates to apply to a deployed application.
Definition: Descriptor.ice:986
void objectInit(ObjectInfoSeq objects)
objectInit is called after the registration of an observer to indicate the state of the registry.
An application descriptor.
Definition: Descriptor.ice:797
void adapterInit(AdapterInfoSeq adpts)
adapterInit is called after registration of an observer to indicate the state of the registry.
void registryInit(RegistryInfoSeq registries)
The registryInit operation is called after registration of an observer to indicate the state of the r...
int revision
The application revision number.
Definition: Admin.ice:388
The identity of an Ice object.
Definition: Identity.ice:40
int revision
The application revision.
Definition: Admin.ice:200
void registryUp(RegistryInfo node)
The nodeUp operation is called to notify an observer that a node came up.
Information about an adapter registered with the IceGrid registry.
Definition: Admin.ice:143
idempotent ApplicationDescriptor getDefaultApplicationDescriptor()
Get the default application descriptor.
This exception is raised if an application does not exist.
Definition: Exception.ice:43
void objectRemoved(Ice::Identity id)
objectRemoved is called to notify an observer when an object registered with the Admin interface was ...
string node
The server node.
Definition: Admin.ice:207
string os
The operating system name.
Definition: Admin.ice:243
string updateUser
The user who updated the application.
Definition: Admin.ice:358
void removeApplication(string name)
Remove an application from IceGrid.
Dynamic information about the state of an adapter.
Definition: Admin.ice:1312
string hostname
The network name of the host running this registry (as defined in uname()).
Definition: Admin.ice:311
An Ice server descriptor.
Definition: Descriptor.ice:337
The database observer interface.
Definition: Admin.ice:1482
Information about an Ice object.
Definition: Admin.ice:113
ApplicationUpdateDescriptor descriptor
The update descriptor.
Definition: Admin.ice:391
@ ActivationTimedOut
The activation timed out state indicates that the server activation timed out.
Definition: Admin.ice:68
bool read(int size, out Ice::StringSeq lines)
Read lines from the log file.
This interface allows applications to monitor changes the state of the registry.
Definition: Admin.ice:1371
A server template instance descriptor.
Definition: Descriptor.ice:481
Information about an IceGrid registry replica.
Definition: Admin.ice:297