zeroc-ice 3.7.9.1 → 3.7.11

data/dist/ice/slice/Ice/Properties.ice

@@ -0,0 +1,244 @@
+//
+// Copyright (c) ZeroC, Inc. All rights reserved.
+//
+
+#pragma once
+
+[["cpp:dll-export:ICE_API"]]
+[["cpp:doxygen:include:Ice/Ice.h"]]
+[["cpp:header-ext:h"]]
+
+[["ice-prefix"]]
+
+[["js:module:ice"]]
+[["js:cjs-module"]]
+
+[["objc:dll-export:ICE_API"]]
+[["objc:header-dir:objc"]]
+
+[["python:pkgdir:Ice"]]
+
+#include <Ice/PropertiesAdmin.ice>
+
+#ifndef __SLICE2JAVA_COMPAT__
+[["java:package:com.zeroc"]]
+#endif
+
+["objc:prefix:ICE"]
+module Ice
+{
+
+#if !defined(__SLICE2PHP__)
+
+/**
+ *
+ * A property set used to configure Ice and Ice applications.
+ * Properties are key/value pairs, with both keys and values
+ * being strings. By convention, property keys should have the form
+ * <em>application-name</em>[.<em>category</em>[.<em>sub-category</em>]].<em>name</em>.
+ *
+ **/
+local interface Properties
+{
+    /**
+     *
+     * Get a property by key. If the property is not set, an empty
+     * string is returned.
+     *
+     * @param key The property key.
+     *
+     * @return The property value.
+     *
+     * @see #setProperty
+     *
+     **/
+    ["cpp:noexcept", "swift:noexcept"] string getProperty(string key);
+
+    /**
+     *
+     * Get a property by key. If the property is not set, the
+     * given default value is returned.
+     *
+     * @param key The property key.
+     *
+     * @param value The default value to use if the property does not
+     * exist.
+     *
+     * @return The property value or the default value.
+     *
+     * @see #setProperty
+     *
+     **/
+    ["cpp:noexcept", "swift:noexcept"] string getPropertyWithDefault(string key, string \value);
+
+    /**
+     *
+     * Get a property as an integer. If the property is not set, 0
+     * is returned.
+     *
+     * @param key The property key.
+     *
+     * @return The property value interpreted as an integer.
+     *
+     * @see #setProperty
+     *
+     **/
+    ["cpp:noexcept", "swift:noexcept"] int getPropertyAsInt(string key);
+
+    /**
+     *
+     * Get a property as an integer. If the property is not set, the
+     * given default value is returned.
+     *
+     * @param key The property key.
+     *
+     * @param value The default value to use if the property does not
+     * exist.
+     *
+     * @return The property value interpreted as an integer, or the
+     * default value.
+     *
+     * @see #setProperty
+     *
+     **/
+    ["cpp:noexcept", "swift:noexcept"] int getPropertyAsIntWithDefault(string key, int \value);
+
+     /**
+     *
+     * Get a property as a list of strings. The strings must be
+     * separated by whitespace or comma. If the property is not set,
+     * an empty list is returned. The strings in the list can contain
+     * whitespace and commas if they are enclosed in single or double
+     * quotes. If quotes are mismatched, an empty list is returned.
+     * Within single quotes or double quotes, you can escape the
+     * quote in question with a backslash, e.g. O'Reilly can be written as
+     * O'Reilly, "O'Reilly" or 'O\'Reilly'.
+     *
+     * @param key The property key.
+     *
+     * @return The property value interpreted as a list of strings.
+     *
+     * @see #setProperty
+     *
+     **/
+    ["cpp:noexcept", "swift:noexcept"] StringSeq getPropertyAsList(string key);
+
+    /**
+     *
+     * Get a property as a list of strings.  The strings must be
+     * separated by whitespace or comma. If the property is not set,
+     * the default list is returned. The strings in the list can contain
+     * whitespace and commas if they are enclosed in single or double
+     * quotes. If quotes are mismatched, the default list is returned.
+     * Within single quotes or double quotes, you can escape the
+     * quote in question with a backslash, e.g. O'Reilly can be written as
+     * O'Reilly, "O'Reilly" or 'O\'Reilly'.
+     *
+     * @param key The property key.
+     *
+     * @param value The default value to use if the property is not set.
+     *
+     * @return The property value interpreted as list of strings, or the
+     * default value.
+     *
+     * @see #setProperty
+     *
+     **/
+    ["cpp:noexcept", "swift:noexcept"] StringSeq getPropertyAsListWithDefault(string key, StringSeq \value);
+
+    /**
+     *
+     * Get all properties whose keys begins with
+     * <em>prefix</em>. If
+     * <em>prefix</em> is an empty string,
+     * then all properties are returned.
+     *
+     * @param prefix The prefix to search for (empty string if none).
+     * @return The matching property set.
+     *
+     **/
+    ["cpp:noexcept", "swift:noexcept"] PropertyDict getPropertiesForPrefix(string prefix);
+
+    /**
+     *
+     * Set a property. To unset a property, set it to
+     * the empty string.
+     *
+     * @param key The property key.
+     * @param value The property value.
+     *
+     * @see #getProperty
+     *
+     **/
+    ["swift:noexcept"] void setProperty(string key, string \value);
+
+    /**
+     *
+     * Get a sequence of command-line options that is equivalent to
+     * this property set. Each element of the returned sequence is
+     * a command-line option of the form
+     * <code>--<em>key</em>=<em>value</em></code>.
+     *
+     * @return The command line options for this property set.
+     *
+     **/
+    ["cpp:noexcept", "swift:noexcept"] StringSeq getCommandLineOptions();
+
+    /**
+     *
+     * Convert a sequence of command-line options into properties.
+     * All options that begin with
+     * <code>--<em>prefix</em>.</code> are
+     * converted into properties. If the prefix is empty, all options
+     * that begin with <code>--</code> are converted to properties.
+     *
+     * @param prefix The property prefix, or an empty string to
+     * convert all options starting with <code>--</code>.
+     *
+     * @param options The command-line options.
+     *
+     * @return The command-line options that do not start with the specified
+     * prefix, in their original order.
+     *
+     **/
+    StringSeq parseCommandLineOptions(string prefix, StringSeq options);
+
+    /**
+     *
+     * Convert a sequence of command-line options into properties.
+     * All options that begin with one of the following prefixes
+     * are converted into properties: <code>--Ice</code>, <code>--IceBox</code>, <code>--IceGrid</code>,
+     * <code>--IcePatch2</code>, <code>--IceSSL</code>, <code>--IceStorm</code>, <code>--Freeze</code>, and <code>--Glacier2</code>.
+     *
+     * @param options The command-line options.
+     *
+     * @return The command-line options that do not start with one of
+     * the listed prefixes, in their original order.
+     *
+     **/
+    StringSeq parseIceCommandLineOptions(StringSeq options);
+
+#ifndef __SLICE2JS__
+    /**
+     *
+     * Load properties from a file.
+     *
+     * @param file The property file.
+     *
+     **/
+    void load(string file);
+#endif
+
+    /**
+     *
+     * Create a copy of this property set.
+     *
+     * @return A copy of this property set.
+     *
+     **/
+    ["cpp:noexcept", "swift:noexcept", "swift:nonnull"] Properties clone();
+}
+
+#endif
+
+}

data/dist/ice/slice/Ice/Router.ice

@@ -0,0 +1,103 @@
+//
+// Copyright (c) ZeroC, Inc. All rights reserved.
+//
+
+#pragma once
+
+[["cpp:dll-export:ICE_API"]]
+[["cpp:doxygen:include:Ice/Ice.h"]]
+[["cpp:header-ext:h"]]
+
+[["ice-prefix"]]
+
+[["js:module:ice"]]
+[["js:cjs-module"]]
+
+[["objc:dll-export:ICE_API"]]
+[["objc:header-dir:objc"]]
+
+[["python:pkgdir:Ice"]]
+
+#include <Ice/BuiltinSequences.ice>
+
+#ifndef __SLICE2JAVA_COMPAT__
+[["java:package:com.zeroc"]]
+#endif
+
+["objc:prefix:ICE"]
+module Ice
+{
+
+/**
+ *
+ * The Ice router interface. Routers can be set either globally with
+ * {@link Communicator#setDefaultRouter}, or with <code>ice_router</code> on specific
+ * proxies.
+ *
+ **/
+interface Router
+{
+    /**
+     *
+     * Get the router's client proxy, i.e., the proxy to use for
+     * forwarding requests from the client to the router.
+     *
+     * If a null proxy is returned, the client will forward requests
+     * to the router's endpoints.
+     *
+     * @param hasRoutingTable Indicates whether or not the router supports a routing
+     * table. If it is supported, the Ice runtime will call addProxies to populate the
+     * routing table. This out parameter is only supported starting with Ice 3.7.
+     * The Ice runtime assumes the router has a routing table if the optional is not
+     * set.
+     *
+     * @return The router's client proxy.
+     *
+     **/
+    ["nonmutating", "cpp:const"] idempotent Object* getClientProxy(out optional(1) bool hasRoutingTable);
+
+    /**
+     *
+     * Get the router's server proxy, i.e., the proxy to use for
+     * forwarding requests from the server to the router.
+     *
+     * @return The router's server proxy.
+     *
+     **/
+    ["nonmutating", "cpp:const"] idempotent Object* getServerProxy();
+
+    /**
+     *
+     * Add new proxy information to the router's routing table.
+     *
+     * @param proxies The proxies to add.
+     *
+     * @return Proxies discarded by the router.
+     *
+     **/
+    idempotent ObjectProxySeq addProxies(ObjectProxySeq proxies);
+}
+
+/**
+ *
+ * This interface should be implemented by services implementing the
+ * Ice::Router interface. It should be advertised through an Ice
+ * object with the identity `Ice/RouterFinder'. This allows clients to
+ * retrieve the router proxy with just the endpoint information of the
+ * service.
+ *
+ **/
+interface RouterFinder
+{
+    /**
+     *
+     * Get the router proxy implemented by the process hosting this
+     * finder object. The proxy might point to several replicas.
+     *
+     * @return The router proxy.
+     *
+     **/
+    Router* getRouter();
+}
+
+}

data/dist/ice/slice/IceGrid/PluginFacade.ice

@@ -0,0 +1,329 @@
+//
+// Copyright (c) ZeroC, Inc. All rights reserved.
+//
+
+#pragma once
+
+[["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"]]
+
+#include <Ice/BuiltinSequences.ice>
+#include <Ice/Current.ice>
+
+#include <IceGrid/Admin.ice>
+
+#ifndef __SLICE2JAVA_COMPAT__
+[["java:package:com.zeroc"]]
+#endif
+
+["objc:prefix:ICEGRID"]
+module IceGrid
+{
+
+/**
+ *
+ * The ReplicaGroupFilter is used by IceGrid to filter adapters
+ * returned to the client when it resolves a filtered replica group.
+ *
+ * IceGrid provides the list of available adapters. The implementation
+ * of this method can use the provided context and connection to
+ * filter and return the filtered set of adapters.
+ *
+ **/
+local interface ReplicaGroupFilter
+{
+    /**
+     *
+     * Filter the given set of adapters.
+     *
+     * @param replicaGroupId The replica group ID.
+     *
+     * @param adapterIds The adpater IDs to filter.
+     *
+     * @param con The connection from the Ice client which is
+     * resolving the replica group endpoints.
+     *
+     * @param ctx The context from the Ice client which is resolving
+     * the replica group endpoints.
+     *
+     * @return The filtered adapter IDs.
+     *
+     **/
+    Ice::StringSeq filter(string replicaGroupId, Ice::StringSeq adapterIds, Ice::Connection con, Ice::Context ctx);
+}
+
+/**
+ *
+ * The TypeFilter is used by IceGrid to filter well-known proxies
+ * returned to the client when it searches a well-known object by
+ * type.
+ *
+ * IceGrid provides the list of available proxies. The implementation
+ * of this method can use the provided context and connection to
+ * filter and return the filtered set of proxies.
+ *
+ **/
+local interface TypeFilter
+{
+    /**
+     *
+     * Filter the given set of proxies.
+     *
+     * @param type The type.
+     *
+     * @param proxies The proxies to filter.
+     *
+     * @param con The connection from the Ice client which is
+     * looking up well-known objects by type.
+     *
+     * @param ctx The context from the Ice client which is looking up
+     * well-known objects by type.
+     *
+     * @return The filtered proxies.
+     *
+     **/
+    Ice::ObjectProxySeq filter(string type, Ice::ObjectProxySeq proxies, Ice::Connection con, Ice::Context ctx);
+}
+
+/**
+ *
+ * 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. It's also used to
+ * register/unregister replica group and type filters.
+ *
+ **/
+local interface RegistryPluginFacade
+{
+    /**
+     *
+     * Get an application descriptor.
+     *
+     * @param name The application name.
+     *
+     * @return The application descriptor.
+     *
+     * @throws ApplicationNotExistException Raised if the application
+     * doesn't exist.
+     *
+     **/
+    ["nonmutating", "cpp:const"] idempotent ApplicationInfo getApplicationInfo(string name)
+        throws ApplicationNotExistException;
+
+    /**
+     *
+     * Get the server information for the server with the given id.
+     *
+     * @param id The server id.
+     *
+     * @throws ServerNotExistException Raised if the server doesn't exist.
+     *
+     * @return The server information.
+     *
+     **/
+    ["nonmutating", "cpp:const"] idempotent ServerInfo getServerInfo(string id)
+        throws ServerNotExistException;
+
+    /**
+     *
+     * Get the ID of the server to which the given adapter belongs.
+     *
+     * @param adapterId The adapter ID.
+     *
+     * @return The server ID or the empty string if the given
+     * identifier is not associated to an object adapter defined with
+     * an application descriptor.
+     *
+     * @throws AdapterNotExistException Raised if the adapter doesn't
+     * exist.
+     *
+     **/
+    ["nonmutating", "cpp:const"] idempotent string getAdapterServer(string adapterId)
+        throws AdapterNotExistException;
+
+    /**
+     *
+     * Get the name of the application to which the given adapter belongs.
+     *
+     * @param adapterId The adapter ID.
+     *
+     * @return The application name or the empty string if the given
+     * identifier is not associated to a replica group or object
+     * adapter defined with an application descriptor.
+     *
+     * @throws AdapterNotExistException Raised if the adapter doesn't
+     * exist.
+     *
+     **/
+    ["nonmutating", "cpp:const"] idempotent string getAdapterApplication(string adapterId)
+        throws AdapterNotExistException;
+
+    /**
+     *
+     * Get the name of the node to which the given adapter belongs.
+     *
+     * @param adapterId The adapter ID.
+     *
+     * @return The node name or the empty string if the given
+     * identifier is not associated to an object adapter defined with
+     * an application descriptor.
+     *
+     * @throws AdapterNotExistException Raised if the adapter doesn't
+     * exist.
+     *
+     **/
+    ["nonmutating", "cpp:const"] idempotent string getAdapterNode(string adapterId)
+        throws AdapterNotExistException;
+
+    /**
+     *
+     * Get the adapter information for the replica group or adapter
+     * with the given id.
+     *
+     * @param id The adapter id.
+     *
+     * @return A sequence of adapter information structures. If the
+     * given id refers to an adapter, this sequence will contain only
+     * one element. If the given id refers to a replica group, the
+     * sequence will contain the adapter information of each member of
+     * the replica group.
+     *
+     * @throws AdapterNotExistException Raised if the adapter or
+     * replica group doesn't exist.
+     *
+     **/
+    ["nonmutating", "cpp:const"] idempotent AdapterInfoSeq getAdapterInfo(string id)
+        throws AdapterNotExistException;
+
+    /**
+     *
+     * Get the object info for the object with the given identity.
+     *
+     * @param id The identity of the object.
+     *
+     * @return The object info.
+     *
+     * @throws ObjectNotRegisteredException Raised if the object isn't
+     * registered with the registry.
+     *
+     **/
+    ["nonmutating", "cpp:const"] idempotent ObjectInfo getObjectInfo(Ice::Identity id)
+        throws ObjectNotRegisteredException;
+
+    /**
+     *
+     * Get the node information for the node with the given name.
+     *
+     * @param name The node name.
+     *
+     * @return The node information.
+     *
+     * @throws NodeNotExistException Raised if the node doesn't exist.
+     *
+     * @throws NodeUnreachableException Raised if the node could not be
+     * reached.
+     *
+     **/
+    ["nonmutating", "cpp:const"] idempotent NodeInfo getNodeInfo(string name)
+        throws NodeNotExistException, NodeUnreachableException;
+
+    /**
+     *
+     * Get the load averages of the node.
+     *
+     * @param name The node name.
+     *
+     * @return The node load information.
+     *
+     * @throws NodeNotExistException Raised if the node doesn't exist.
+     *
+     * @throws NodeUnreachableException Raised if the node could not be
+     * reached.
+     *
+     **/
+    ["nonmutating", "cpp:const"] idempotent LoadInfo getNodeLoad(string name)
+        throws NodeNotExistException, NodeUnreachableException;
+
+    /**
+     *
+     * Get the property value for the given property and adapter. The
+     * property is looked up in the server or service descriptor where
+     * the adapter is defined.
+     *
+     * @param adapterId The adapter ID
+     *
+     * @param name The name of the property.
+     *
+     * @return The property value.
+     *
+     * @throws AdapterNotExistException Raised if the adapter doesn't exist.
+     *
+     **/
+    ["nonmutating", "cpp:const"] idempotent string getPropertyForAdapter(string adapterId, string name)
+        throws AdapterNotExistException;
+
+    /**
+     *
+     * Add a replica group filter.
+     *
+     * @param id The identifier of the filter. This identifier must
+     * match the value of the "filter" attribute specified in the
+     * replica group descriptor. To filter dynamically registered
+     * replica groups, you should use the empty filter id.
+     *
+     * @param filter The filter implementation.
+     *
+     **/
+    ["cpp:noexcept", "swift:noexcept"] void addReplicaGroupFilter(string id, ReplicaGroupFilter filter);
+
+    /**
+     *
+     * Remove a replica group filter.
+     *
+     * @param id The identifier of the filter.
+     *
+     * @param filter The filter implementation.
+     *
+     * @return True of the filter was removed, false otherwise.
+     *
+     **/
+    ["cpp:noexcept", "swift:noexcept"] bool removeReplicaGroupFilter(string id, ReplicaGroupFilter filter);
+
+    /**
+     *
+     * Add a type filter.
+     *
+     * @param type The type to register this filter with.
+     *
+     * @param filter The filter implementation.
+     *
+     **/
+    ["cpp:noexcept", "swift:noexcept"] void addTypeFilter(string type, TypeFilter filter);
+
+    /**
+     *
+     * Remove a type filter.
+     *
+     * @param type The type to register this filter with.
+     *
+     * @param filter The filter implementation.
+     *
+     * @return True of the filter was removed, false otherwise.
+     *
+     **/
+    ["cpp:noexcept", "swift:noexcept"] bool removeTypeFilter(string type, TypeFilter filter);
+}
+
+}