zeroc-ice 3.6.5 → 3.7.4

data/slice/IceDiscovery/IceDiscovery.ice

@@ -1,32 +1,97 @@
-// **********************************************************************
 //
-// Copyright (c) 2003-2018 ZeroC, Inc. All rights reserved.
+// Copyright (c) ZeroC, Inc. All rights reserved.
 //
-// This copy of Ice is licensed to you under the terms described in the
-// ICE_LICENSE file included in this distribution.
-//
-// **********************************************************************
 
 #pragma once
-[["cpp:header-ext:h", "objc:header-dir:objc"]]
+
+[["cpp:doxygen:include:IceDiscovery/IceDiscovery.h"]]
+[["cpp:header-ext:h"]]
+
+[["ice-prefix"]]
+
+[["js:module:ice"]]
+
+[["objc:header-dir:objc"]]
+
+[["python:pkgdir:IceDiscovery"]]
 
 #include <Ice/Identity.ice>
 
+#ifndef __SLICE2JAVA_COMPAT__
+[["java:package:com.zeroc"]]
+#endif
+
 module IceDiscovery
 {
 
+/**
+ *
+ * The LookupReply interface is used by IceDiscovery clients to answer requests
+ * received on the Lookup interface.
+ *
+ **/
 interface LookupReply
 {
+    /**
+     * Reply to the findObjectById request.
+     *
+     * @param id The identity of the object.
+     *
+     * @param prx The proxy of the object.
+     *
+     **/
     void foundObjectById(Ice::Identity id, Object* prx);
 
+    /**
+     * Reply to the findAdpaterById request.
+     *
+     * @param id The adapter ID.
+     *
+     * @param prx The adapter proxy (a dummy proxy created by the adapter).
+     * The proxy provides the adapter endpoints.
+     *
+     * @param isReplicaGroup True if the adapter is also a member of a
+     * replica group.
+     *
+     **/
     void foundAdapterById(string id, Object* prx, bool isReplicaGroup);
-};
+}
 
+/**
+ *
+ * The Lookup interface is used by IceDiscovery clients to look for objects
+ * and adapters using UDP multicast.
+ *
+ **/
 interface Lookup
 {
+    /**
+     * Request to find an Ice object
+     *
+     * @param domainId The IceDiscovery domain identifier. An IceDiscovery client only
+     * replies to requests with a matching domain identifier.
+     *
+     * @param id The object identity.
+     *
+     * @param reply The proxy of the LookupReply interface that should be used to send
+     * the reply if a matching object is found.
+     *
+     **/
     idempotent void findObjectById(string domainId, Ice::Identity id, LookupReply* reply);
 
+    /**
+     * Request to find an object adapter
+     *
+     * @param domainId The IceDiscovery domain identifier. An IceDiscovery client only
+     * replies to requests with a matching domain identifier.
+     *
+     * @param id The adapter ID.
+     *
+     * @param reply The proxy of the LookupReply interface that should be used to send
+     * the reply if a matching adapter is found.
+     *
+     **/
     idempotent void findAdapterById(string domainId, string id, LookupReply* reply);
-};
+}
 
-};
+}

data/slice/IceGrid/Admin.ice

@@ -1,17 +1,23 @@
-// **********************************************************************
 //
-// Copyright (c) 2003-2018 ZeroC, Inc. All rights reserved.
+// Copyright (c) ZeroC, Inc. All rights reserved.
 //
-// This copy of Ice is licensed to you under the terms described in the
-// ICE_LICENSE file included in this distribution.
-//
-// **********************************************************************
 
 #pragma once
 
-[["cpp:header-ext:h", "objc:header-dir:objc", "js:ice-build"]]
+[["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"]]
+
+[["objc:dll-export:ICEGRID_API"]]
+[["objc:header-dir:objc"]]
+
+[["python:pkgdir:IceGrid"]]
+
 #include <Ice/Identity.ice>
 #include <Ice/BuiltinSequences.ice>
 #include <Ice/Properties.ice>
@@ -20,6 +26,10 @@
 #include <IceGrid/Exception.ice>
 #include <IceGrid/Descriptor.ice>
 
+#ifndef __SLICE2JAVA_COMPAT__
+[["java:package:com.zeroc"]]
+#endif
+
 ["objc:prefix:ICEGRID"]
 module IceGrid
 {
@@ -83,7 +93,7 @@ enum ServerState
      *
      **/
     Destroyed
-};
+}
 
 /**
  *
@@ -113,7 +123,7 @@ struct ObjectInfo
      *
      **/
     string type;
-};
+}
 
 /**
  *
@@ -151,7 +161,7 @@ struct AdapterInfo
      *
      **/
     string replicaGroupId;
-};
+}
 
 /**
  *
@@ -208,7 +218,7 @@ struct ServerInfo
      *
      **/
     string sessionId;
-};
+}
 
 /**
  *
@@ -275,7 +285,7 @@ struct NodeInfo
      *
      **/
     string dataDir;
-};
+}
 
 /**
  *
@@ -298,7 +308,7 @@ struct RegistryInfo
      *
      **/
     string hostname;
-};
+}
 
 /**
  *
@@ -322,7 +332,7 @@ struct LoadInfo
 
     /** The load average over the past 15 minutes. */
     float avg15;
-};
+}
 
 /**
  *
@@ -351,7 +361,7 @@ struct ApplicationInfo
 
     /** The application descriptor */
     ApplicationDescriptor descriptor;
-};
+}
 
 /**
  *
@@ -378,7 +388,7 @@ struct ApplicationUpdateInfo
 
     /** The update descriptor. */
     ApplicationUpdateDescriptor descriptor;
-};
+}
 
 /**
  *
@@ -450,7 +460,6 @@ interface Admin
     void updateApplication(ApplicationUpdateDescriptor descriptor)
         throws AccessDeniedException, DeploymentException, ApplicationNotExistException;
 
-
     /**
      *
      * Synchronize a deployed application with the given application
@@ -688,7 +697,6 @@ interface Admin
     idempotent Object* getServerAdmin(string id)
         throws ServerNotExistException, NodeUnreachableException, DeploymentException;
 
-
     /**
      *
      * Enable or disable a server. A disabled server can't be started
@@ -859,7 +867,6 @@ interface Admin
      * Remove the adapter with the given id.
      *
      * @param id The adapter id.
-     *
      * @throws AdapterNotExistException Raised if the adapter doesn't
      * exist.
      *
@@ -881,7 +888,7 @@ interface Admin
     /**
      *
      * Add an object to the object registry. IceGrid will get the
-     * object type by calling <tt>ice_id</tt> on the given proxy. The object
+     * object type by calling <code>ice_id</code> on the given proxy. The object
      * must be reachable.
      *
      * @param obj The object to be added to the registry.
@@ -990,7 +997,7 @@ interface Admin
      *
      * @param expr The expression to match against the stringified
      * identities of registered objects. The expression may contain
-     * a trailing wildcard (<tt>*</tt>) character.
+     * a trailing wildcard (<code>*</code>) character.
      *
      * @return All the object infos with a stringified identity
      * matching the given expression.
@@ -1046,7 +1053,6 @@ interface Admin
     ["nonmutating", "cpp:const"] idempotent NodeInfo getNodeInfo(string name)
         throws NodeNotExistException, NodeUnreachableException;
 
-
     /**
      *
      * Get a proxy to the IceGrid node's admin object.
@@ -1213,7 +1219,7 @@ interface Admin
      *
      **/
     ["nonmutating", "cpp:const"] idempotent Ice::SliceChecksumDict getSliceChecksums();
-};
+}
 
 /**
  *
@@ -1251,23 +1257,386 @@ interface FileIterator
      *
      **/
     void destroy();
-};
+}
+
+/**
+ *
+ * Dynamic information about the state of a server.
+ *
+ **/
+struct ServerDynamicInfo
+{
+    /**
+     *
+     * The id of the server.
+     *
+     **/
+    string id;
+
+    /**
+     *
+     * The state of the server.
+     *
+     **/
+    ServerState state;
+
+    /**
+     *
+     * The process id of the server.
+     *
+     **/
+    int pid;
+
+    /**
+     *
+     * Indicates whether the server is enabled.
+     *
+     **/
+    bool enabled;
+}
+
+/**
+ *
+ * A sequence of server dynamic information structures.
+ *
+ **/
+["java:type:java.util.LinkedList<ServerDynamicInfo>"] sequence<ServerDynamicInfo> ServerDynamicInfoSeq;
+
+/**
+ *
+ * Dynamic information about the state of an adapter.
+ *
+ **/
+struct AdapterDynamicInfo
+{
+    /**
+     *
+     * The id of the adapter.
+     *
+     **/
+    string id;
+
+    /**
+     *
+     * The direct proxy containing the adapter endpoints.
+     *
+     **/
+    Object* proxy;
+}
+
+/**
+ *
+ * A sequence of adapter dynamic information structures.
+ *
+ **/
+["java:type:java.util.LinkedList<AdapterDynamicInfo>"] sequence<AdapterDynamicInfo> AdapterDynamicInfoSeq;
 
-interface RegistryObserver;
-interface NodeObserver;
-interface ApplicationObserver;
-interface AdapterObserver;
-interface ObjectObserver;
+/**
+ *
+ * Dynamic information about the state of a node.
+ *
+ **/
+struct NodeDynamicInfo
+{
+    /**
+     *
+     * Some static information about the node.
+     *
+     **/
+    NodeInfo info;
+
+    /**
+     *
+     * The dynamic information of the servers deployed on this node.
+     *
+     **/
+    ServerDynamicInfoSeq servers;
+
+    /**
+     *
+     * The dynamic information of the adapters deployed on this node.
+     *
+     **/
+    AdapterDynamicInfoSeq adapters;
+}
+
+/**
+ *
+ * This interface allows applications to monitor changes the state
+ * of the registry.
+ *
+ **/
+interface RegistryObserver
+{
+    /**
+     *
+     * The <code>registryInit</code> operation is called after registration of
+     * an observer to indicate the state of the registries.
+     *
+     * @param registries The current state of the registries.
+     *
+     **/
+    void registryInit(RegistryInfoSeq registries);
+
+    /**
+     *
+     * The <code>nodeUp</code> operation is called to notify an observer that a node
+     * came up.
+     *
+     * @param node The node state.
+     *
+     **/
+    void registryUp(RegistryInfo node);
+
+    /**
+     *
+     * The <code>nodeDown</code> operation is called to notify an observer that a node
+     * went down.
+     *
+     * @param name The node name.
+     *
+     **/
+    void registryDown(string name);
+}
+
+/**
+ *
+ * A sequence of node dynamic information structures.
+ *
+ **/
+sequence<NodeDynamicInfo> NodeDynamicInfoSeq;
+
+/**
+ *
+ * The node observer interface. Observers should implement this
+ * interface to receive information about the state of the IceGrid
+ * nodes.
+ *
+ **/
+interface NodeObserver
+{
+    /**
+     *
+     * The <code>nodeInit</code> operation indicates the current state
+     * of nodes. It is called after the registration of an observer.
+     *
+     * @param nodes The current state of the nodes.
+     *
+     **/
+    void nodeInit(NodeDynamicInfoSeq nodes);
+
+    /**
+     *
+     * The <code>nodeUp</code> operation is called to notify an observer that a node
+     * came up.
+     *
+     * @param node The node state.
+     *
+     **/
+    void nodeUp(NodeDynamicInfo node);
+
+    /**
+     *
+     * The <code>nodeDown</code> operation is called to notify an observer that a node
+     * went down.
+     *
+     * @param name The node name.
+     *
+     **/
+    void nodeDown(string name);
+
+    /**
+     *
+     * The <code>updateServer</code> operation is called to notify an observer that
+     * the state of a server changed.
+     *
+     * @param node The node hosting the server.
+     *
+     * @param updatedInfo The new server state.
+     *
+     **/
+    void updateServer(string node, ServerDynamicInfo updatedInfo);
+
+    /**
+     *
+     * The <code>updateAdapter</code> operation is called to notify an observer that
+     * the state of an adapter changed.
+     *
+     * @param node The node hosting the adapter.
+     *
+     * @param updatedInfo The new adapter state.
+     *
+     **/
+     void updateAdapter(string node, AdapterDynamicInfo updatedInfo);
+}
+
+/**
+ *
+ * The database observer interface. Observers should implement this
+ * interface to receive information about the state of the IceGrid
+ * registry database.
+ *
+ **/
+interface ApplicationObserver
+{
+    /**
+     *
+     * <code>applicationInit</code> is called after the registration
+     * of an observer to indicate the state of the registry.
+     *
+     * @param serial The current serial number of the registry
+     * database. This serial number allows observers to make sure that
+     * their internal state is synchronized with the registry.
+     *
+     * @param applications The applications currently registered with
+     * the registry.
+     *
+     **/
+    void applicationInit(int serial, ApplicationInfoSeq applications);
+
+    /**
+     *
+     * The <code>applicationAdded</code> operation is called to notify an observer
+     * that an application was added.
+     *
+     * @param serial The new serial number of the registry database.
+     *
+     * @param desc The descriptor of the new application.
+     *
+     **/
+    void applicationAdded(int serial, ApplicationInfo desc);
+
+    /**
+     *
+     * The <code>applicationRemoved</code> operation is called to notify an observer
+     * that an application was removed.
+     *
+     * @param serial The new serial number of the registry database.
+     *
+     * @param name The name of the application that was removed.
+     *
+     **/
+    void applicationRemoved(int serial, string name);
+
+    /**
+     *
+     * The <code>applicationUpdated</code> operation is called to notify an observer
+     * that an application was updated.
+     *
+     * @param serial The new serial number of the registry database.
+     *
+     * @param desc The descriptor of the update.
+     *
+     **/
+    void applicationUpdated(int serial, ApplicationUpdateInfo desc);
+}
+
+/**
+ *
+ * This interface allows applications to monitor the state of object
+ * adapters that are registered with IceGrid.
+ *
+ **/
+interface AdapterObserver
+{
+    /**
+     *
+     * <code>adapterInit</code> is called after registration of
+     * an observer to indicate the state of the registry.
+     *
+     * @param adpts The adapters that were dynamically registered
+     * with the registry (not through the deployment mechanism).
+     *
+     **/
+    void adapterInit(AdapterInfoSeq adpts);
+
+    /**
+     *
+     * The <code>adapterAdded</code> operation is called to notify an observer when
+     * a dynamically-registered adapter was added.
+     *
+     * @param info The details of the new adapter.
+     **/
+    void adapterAdded(AdapterInfo info);
+
+    /**
+     *
+     * The adapterUpdated operation is called to notify an observer when
+     * a dynamically-registered adapter was updated.
+     *
+     * @param info The details of the updated adapter.
+     *
+     **/
+    void adapterUpdated(AdapterInfo info);
+
+    /**
+     *
+     * The adapterRemoved operation is called to notify an observer when
+     * a dynamically-registered adapter was removed.
+     *
+     * @param id The ID of the removed adapter.
+     *
+     **/
+    void adapterRemoved(string id);
+}
+
+/**
+ *
+ * This interface allows applications to monitor IceGrid well-known objects.
+ *
+ **/
+interface ObjectObserver
+{
+    /**
+     *
+     * <code>objectInit</code> is called after the registration of
+     * an observer to indicate the state of the registry.
+     *
+     * @param objects The objects registered with the {@link Admin}
+     * interface (not through the deployment mechanism).
+     *
+     **/
+    void objectInit(ObjectInfoSeq objects);
+
+    /**
+     *
+     * The <code>objectAdded</code> operation is called to notify an observer when an
+     * object was added to the {@link Admin} interface.
+     *
+     * @param info The details of the added object.
+     *
+     **/
+    void objectAdded(ObjectInfo info);
+
+    /**
+     *
+     * <code>objectUpdated</code> is called to notify an observer when
+     * an object registered with the {@link Admin} interface was updated.
+     *
+     * @param info The details of the updated object.
+     *
+     **/
+    void objectUpdated(ObjectInfo info);
+
+    /**
+     *
+     * <code>objectRemoved</code> is called to notify an observer when
+     * an object registered with the {@link Admin} interface was removed.
+     *
+     * @param id The identity of the removed object.
+     *
+     **/
+    void objectRemoved(Ice::Identity id);
+}
 
 /**
  *
  * Used by administrative clients to view,
  * update, and receive observer updates from the IceGrid
- * registry. Admin sessions are created either with the {@link Registry}
- * object or the registry admin {@link Glacier2.SessionManager} object.
+ * registry. Admin sessions are created either via the {@link Registry}
+ * object or via the registry admin <code>SessionManager</code> object.
  *
  * @see Registry
- * @see Glacier2.SessionManager
  *
  **/
 interface AdminSession extends Glacier2::Session
@@ -1292,7 +1661,6 @@ interface AdminSession extends Glacier2::Session
      **/
     ["nonmutating", "cpp:const"] idempotent Admin* getAdmin();
 
-
     /**
      *
      * Get a "template" proxy for admin callback objects.
@@ -1306,7 +1674,6 @@ interface AdminSession extends Glacier2::Session
      **/
     ["cpp:const"] idempotent Object* getAdminCallbackTemplate();
 
-
     /**
      *
      * Set the observer proxies that receive
@@ -1404,7 +1771,7 @@ interface AdminSession extends Glacier2::Session
      *
      * @param count Specifies where to start reading the file. If
      * negative, the file is read from the begining. If 0 or positive,
-     * the file is read from the last <tt>count</tt> lines.
+     * the file is read from the last <code>count</code> lines.
      *
      * @return An iterator to read the file.
      *
@@ -1433,7 +1800,7 @@ interface AdminSession extends Glacier2::Session
      *
      * @param count Specifies where to start reading the file. If
      * negative, the file is read from the begining. If 0 or positive,
-     * the file is read from the last <tt>count</tt> lines.
+     * the file is read from the last <code>count</code> lines.
      *
      * @return An iterator to read the file.
      *
@@ -1462,7 +1829,7 @@ interface AdminSession extends Glacier2::Session
      *
      * @param count Specifies where to start reading the file. If
      * negative, the file is read from the begining. If 0 or positive,
-     * the file is read from the last <tt>count</tt> lines.
+     * the file is read from the last <code>count</code> lines.
      *
      * @return An iterator to read the file.
      *
@@ -1491,7 +1858,7 @@ interface AdminSession extends Glacier2::Session
      *
      * @param count Specifies where to start reading the file. If
      * negative, the file is read from the begining. If 0 or positive,
-     * the file is read from the last <tt>count</tt> lines.
+     * the file is read from the last <code>count</code> lines.
      *
      * @return An iterator to read the file.
      *
@@ -1516,7 +1883,7 @@ interface AdminSession extends Glacier2::Session
      *
      * @param count Specifies where to start reading the file. If
      * negative, the file is read from the begining. If 0 or positive,
-     * the file is read from the last <tt>count</tt> lines.
+     * the file is read from the last <code>count</code> lines.
      *
      * @return An iterator to read the file.
      *
@@ -1541,7 +1908,7 @@ interface AdminSession extends Glacier2::Session
      *
      * @param count Specifies where to start reading the file. If
      * negative, the file is read from the begining. If 0 or positive,
-     * the file is read from the last <tt>count</tt> lines.
+     * the file is read from the last <code>count</code> lines.
      *
      * @return An iterator to read the file.
      *
@@ -1567,7 +1934,7 @@ interface AdminSession extends Glacier2::Session
      *
      * @param count Specifies where to start reading the file. If
      * negative, the file is read from the begining. If 0 or positive,
-     * the file is read from the last <tt>count</tt> lines.
+     * the file is read from the last <code>count</code> lines.
      *
      * @return An iterator to read the file.
      *
@@ -1584,7 +1951,6 @@ interface AdminSession extends Glacier2::Session
     FileIterator * openRegistryStdOut(string name, int count)
         throws FileNotAvailableException, RegistryNotExistException, RegistryUnreachableException;
 
-};
-
-};
+}
 
+}