zeroc-ice 3.7.11__cp314-cp314-macosx_10_15_universal2.whl → 3.8.0__cp314-cp314-macosx_10_15_universal2.whl

slice/Ice/Identity.ice

@@ -1,6 +1,4 @@
-//
-// Copyright (c) ZeroC, Inc. All rights reserved.
-//
+// Copyright (c) ZeroC, Inc.
 
 #pragma once
 
@@ -8,68 +6,31 @@
 [["cpp:doxygen:include:Ice/Ice.h"]]
 [["cpp:header-ext:h"]]
 
-[["ice-prefix"]]
+[["cpp:no-default-include"]]
+[["cpp:include:Ice/Config.h"]]
+[["cpp:include:Ice/StreamHelpers.h"]]
+[["cpp:include:Ice/TupleCompare.h"]]
+[["cpp:include:string"]]
+[["cpp:include:vector"]]
 
-[["js:module:ice"]]
-[["js:cjs-module"]]
+[["js:module:@zeroc/ice"]]
 
-[["objc:dll-export:ICE_API"]]
-[["objc:header-dir:objc"]]
-
-[["python:pkgdir:Ice"]]
-
-#ifndef __SLICE2JAVA_COMPAT__
-[["java:package:com.zeroc"]]
-#endif
-
-["objc:prefix:ICE"]
+/// The Ice RPC framework.
+["java:identifier:com.zeroc.Ice"]
 module Ice
 {
-
-/**
- *
- * The identity of an Ice object. In a proxy, an empty {@link Identity#name} denotes a nil
- * proxy. An identity with an empty {@link Identity#name} and a non-empty {@link Identity#category}
- * is illegal. You cannot add a servant with an empty name to the Active Servant Map.
- *
- * @see ServantLocator
- * @see ObjectAdapter#addServantLocator
- *
- **/
-struct Identity
-{
-    /**
-     *
-     * The name of the Ice object.
-     *
-     **/
-    string name;
-
-    /**
-     *
-     * The Ice object category.
-     *
-     **/
-    string category;
-}
-
-/**
- *
- * A mapping between identities and Ice objects.
- *
- **/
-#ifndef __SLICE2PHP__
-//
-// dictionary key type not supported in PHP
-//
-local dictionary<Identity, Object> ObjectDict;
-#endif
-
-/**
- *
- * A sequence of identities.
- *
- **/
-sequence<Identity> IdentitySeq;
-
+    /// Represents the identity of an Ice object. It is comparable to the path of a URI. Its string representation is
+    /// `name` when the category is empty, and `category/name` when the category is not empty.
+    ["cpp:custom-print"]
+    struct Identity
+    {
+        /// The name of the Ice object. An empty name is not valid.
+        string name;
+
+        /// The category of the object.
+        string category = "";
+    }
+
+    /// A sequence of identities.
+    sequence<Identity> IdentitySeq;
 }

slice/Ice/Locator.ice

@@ -1,6 +1,4 @@
-//
-// Copyright (c) ZeroC, Inc. All rights reserved.
-//
+// Copyright (c) ZeroC, Inc.
 
 #pragma once
 
@@ -8,232 +6,69 @@
 [["cpp:doxygen:include:Ice/Ice.h"]]
 [["cpp:header-ext:h"]]
 
-[["ice-prefix"]]
+[["cpp:source-include:Ice/LocatorRegistry.h"]]
 
-[["js:module:ice"]]
-[["js:cjs-module"]]
+[["js:module:@zeroc/ice"]]
 
-[["objc:dll-export:ICE_API"]]
-[["objc:header-dir:objc"]]
+#include "Identity.ice"
 
-[["python:pkgdir:Ice"]]
-
-#include <Ice/Identity.ice>
-#include <Ice/Process.ice>
-
-#ifndef __SLICE2JAVA_COMPAT__
-[["java:package:com.zeroc"]]
-#endif
-
-["objc:prefix:ICE"]
+["java:identifier:com.zeroc.Ice"]
 module Ice
 {
-
-/**
- *
- * This exception is raised if an adapter cannot be found.
- *
- **/
-exception AdapterNotFoundException
-{
-}
-
-/**
- *
- * This exception is raised if the replica group provided by the
- * server is invalid.
- *
- **/
-exception InvalidReplicaGroupIdException
-{
-}
-
-/**
- *
- * This exception is raised if a server tries to set endpoints for
- * an adapter that is already active.
- *
- **/
-exception AdapterAlreadyActiveException
-{
-}
-
-/**
- *
- * This exception is raised if an object cannot be found.
- *
- **/
-exception ObjectNotFoundException
-{
-}
-
-/**
- *
- * This exception is raised if a server cannot be found.
- *
- **/
-exception ServerNotFoundException
-{
-}
-
-interface LocatorRegistry;
-
-/**
- *
- * The Ice locator interface. This interface is used by clients to
- * lookup adapters and objects. It is also used by servers to get the
- * locator registry proxy.
- *
- * <p class="Note">The {@link Locator} interface is intended to be used by
- * Ice internals and by locator implementations. Regular user code
- * should not attempt to use any functionality of this interface
- * directly.
- *
- **/
-interface Locator
-{
-    /**
-     *
-     * Find an object by identity and return a proxy that contains
-     * the adapter ID or endpoints which can be used to access the
-     * object.
-     *
-     * @param id The identity.
-     *
-     * @return The proxy, or null if the object is not active.
-     *
-     * @throws ObjectNotFoundException Raised if the object cannot
-     * be found.
-     *
-     **/
-    ["amd", "nonmutating", "cpp:const"] idempotent Object* findObjectById(Identity id)
-        throws ObjectNotFoundException;
-
-    /**
-     *
-     * Find an adapter by id and return a proxy that contains
-     * its endpoints.
-     *
-     * @param id The adapter id.
-     *
-     * @return The adapter proxy, or null if the adapter is not active.
-     *
-     * @throws AdapterNotFoundException Raised if the adapter cannot be
-     * found.
-     *
-     **/
-    ["amd", "nonmutating", "cpp:const"] idempotent Object* findAdapterById(string id)
-        throws AdapterNotFoundException;
-
-    /**
-     *
-     * Get the locator registry.
-     *
-     * @return The locator registry.
-     *
-     **/
-    ["nonmutating", "cpp:const"] idempotent LocatorRegistry* getRegistry();
-}
-
-/**
- *
- * The Ice locator registry interface. This interface is used by
- * servers to register adapter endpoints with the locator.
- *
- * <p class="Note"> The {@link LocatorRegistry} interface is intended to be used
- * by Ice internals and by locator implementations. Regular user
- * code should not attempt to use any functionality of this interface
- * directly.
- *
- **/
-interface LocatorRegistry
-{
-    /**
-     *
-     * Set the adapter endpoints with the locator registry.
-     *
-     * @param id The adapter id.
-     *
-     * @param proxy The adapter proxy (a dummy direct proxy created
-     * by the adapter). The direct proxy contains the adapter
-     * endpoints.
-     *
-     * @throws AdapterNotFoundException Raised if the adapter cannot
-     * be found, or if the locator only allows
-     * registered adapters to set their active proxy and the
-     * adapter is not registered with the locator.
-     *
-     * @throws AdapterAlreadyActiveException Raised if an adapter with the same
-     * id is already active.
-     *
-     **/
-    ["amd"] idempotent void setAdapterDirectProxy(string id, Object* proxy)
-        throws AdapterNotFoundException, AdapterAlreadyActiveException;
-
-    /**
-     *
-     * Set the adapter endpoints with the locator registry.
-     *
-     * @param adapterId The adapter id.
-     *
-     * @param replicaGroupId The replica group id.
-     *
-     * @param p The adapter proxy (a dummy direct proxy created
-     * by the adapter). The direct proxy contains the adapter
-     * endpoints.
-     *
-     * @throws AdapterNotFoundException Raised if the adapter cannot
-     * be found, or if the locator only allows registered adapters to
-     * set their active proxy and the adapter is not registered with
-     * the locator.
-     *
-     * @throws AdapterAlreadyActiveException Raised if an adapter with the same
-     * id is already active.
-     *
-     * @throws InvalidReplicaGroupIdException Raised if the given
-     * replica group doesn't match the one registered with the
-     * locator registry for this object adapter.
-     *
-     **/
-    ["amd"] idempotent void setReplicatedAdapterDirectProxy(string adapterId, string replicaGroupId, Object* p)
-        throws AdapterNotFoundException, AdapterAlreadyActiveException, InvalidReplicaGroupIdException;
-
-    /**
-     *
-     * Set the process proxy for a server.
-     *
-     * @param id The server id.
-     *
-     * @param proxy The process proxy.
-     *
-     * @throws ServerNotFoundException Raised if the server cannot
-     * be found.
-     *
-     **/
-    ["amd"] idempotent void setServerProcessProxy(string id, Process* proxy)
-        throws ServerNotFoundException;
-}
-
-/**
- *
- * This interface should be implemented by services implementing the
- * Ice::Locator interface. It should be advertised through an Ice
- * object with the identity `Ice/LocatorFinder'. This allows clients
- * to retrieve the locator proxy with just the endpoint information of
- * the service.
- *
- **/
-interface LocatorFinder
-{
-    /**
-     *
-     * Get the locator proxy implemented by the process hosting this
-     * finder object. The proxy might point to several replicas.
-     *
-     * @return The locator proxy.
-     *
-     **/
-    Locator* getLocator();
-}
-
+    /// The exception that is thrown by a {@link Locator} implementation when it cannot find an object adapter with the
+    /// provided adapter ID.
+    exception AdapterNotFoundException
+    {
+    }
+
+    /// The exception that is thrown by a {@link Locator} implementation when it cannot find an object with the provided
+    /// identity.
+    exception ObjectNotFoundException
+    {
+    }
+
+    interface LocatorRegistry;
+
+    /// Client applications use the Locator object to resolve Ice indirect proxies. This object also allows
+    /// server applications to retrieve a proxy to the associated {@link LocatorRegistry} object where they can register
+    /// their object adapters.
+    interface Locator
+    {
+        /// Finds an object by identity and returns a dummy proxy with the endpoint(s) that can be used to reach this
+        /// object. This dummy proxy may be an indirect proxy that requires further resolution using
+        /// {@link findAdapterById}.
+        /// @param id The identity.
+        /// @return A dummy proxy, or null if an object with the requested identity was not found.
+        /// @throws ObjectNotFoundException Thrown when an object with the requested identity was not found. The caller
+        /// should treat this exception like a null return value.
+        ["cpp:const"]
+        idempotent Object* findObjectById(Identity id)
+            throws ObjectNotFoundException;
+
+        /// Finds an object adapter by adapter ID and returns a dummy proxy with the object adapter's endpoint(s).
+        /// @param id The adapter ID.
+        /// @return A dummy proxy with the adapter's endpoints, or null if an object adapter with @p id was not found.
+        /// @throws AdapterNotFoundException Thrown when an object adapter with this adapter ID was not found. The
+        /// caller should treat this exception like a null return value.
+        ["cpp:const"]
+        idempotent Object* findAdapterById(string id)
+            throws AdapterNotFoundException;
+
+        /// Gets a proxy to the locator registry.
+        /// @return A proxy to the locator registry, or null if this locator has no associated registry.
+        ["cpp:const"]
+        idempotent LocatorRegistry* getRegistry();
+    }
+
+    /// Provides access to a {@link Locator} object via a fixed identity.
+    /// A LocatorFinder is always registered with identity `Ice/LocatorFinder`. This allows clients to obtain the
+    /// associated Locator proxy with just the endpoint information of the object. For example, you can use the
+    /// LocatorFinder proxy `Ice/LocatorFinder:tcp -h somehost -p 4061` to get the Locator proxy
+    /// `MyIceGrid/Locator:tcp -h somehost -p 4061`.
+    interface LocatorFinder
+    {
+        /// Gets a proxy to the associated {@link Locator}. The proxy might point to several replicas.
+        /// @return The locator proxy. This proxy is never null.
+        Locator* getLocator();
+    }
 }

slice/Ice/LocatorRegistry.ice

@@ -0,0 +1,77 @@
+// Copyright (c) ZeroC, Inc.
+
+#pragma once
+
+[["cpp:dll-export:ICE_API"]]
+[["cpp:doxygen:include:Ice/Ice.h"]]
+[["cpp:header-ext:h"]]
+
+[["cpp:source-include:Ice/Process.h"]]
+
+[["js:module:@zeroc/ice"]]
+
+#include "Locator.ice"
+
+["java:identifier:com.zeroc.Ice"]
+module Ice
+{
+    interface Process;
+
+    /// The exception that is thrown when a server application tries to register endpoints for an object adapter that is
+    /// already active.
+    exception AdapterAlreadyActiveException
+    {
+    }
+
+    /// The exception that is thrown when the provided replica group is invalid.
+    exception InvalidReplicaGroupIdException
+    {
+    }
+
+    /// The exception that is thrown when a server was not found.
+    exception ServerNotFoundException
+    {
+    }
+
+    /// A server application registers the endpoints of its indirect object adapters with the LocatorRegistry object.
+    interface LocatorRegistry
+    {
+        /// Registers or unregisters the endpoints of an object adapter.
+        /// @param id The adapter ID.
+        /// @param proxy A dummy proxy created by the object adapter. @p proxy carries the object adapter's endpoints.
+        /// The locator considers an object adapter to be active after it has registered its endpoints.
+        /// When @p proxy is null, the endpoints are unregistered and the locator considers the object adapter inactive.
+        /// @throws AdapterNotFoundException Thrown when the locator only allows registered object adapters to register
+        /// their endpoints and no object adapter with this adapter ID was registered with the locator.
+        /// @throws AdapterAlreadyActiveException Thrown when an object adapter with the same adapter ID has already
+        /// registered its endpoints. Since this operation is marked idempotent, this exception may be thrown when the
+        /// Ice client runtime retries an invocation with a non-null @p proxy.
+        idempotent void setAdapterDirectProxy(string id, Object* proxy)
+            throws AdapterNotFoundException, AdapterAlreadyActiveException;
+
+        /// Registers or unregisters the endpoints of an object adapter. This object adapter is a member of a replica
+        /// group.
+        /// @param adapterId The adapter ID.
+        /// @param replicaGroupId The replica group ID.
+        /// @param proxy A dummy proxy created by the object adapter. @p proxy carries the object adapter's endpoints.
+        /// The locator considers an object adapter to be active after it has registered its endpoints. When @p proxy is
+        /// null, the endpoints are unregistered and the locator considers the object adapter inactive.
+        /// @throws AdapterNotFoundException Thrown when the locator only allows registered object adapters to register
+        /// their endpoints and no object adapter with this adapter ID was registered with the locator.
+        /// @throws AdapterAlreadyActiveException Thrown when an object adapter with the same adapter ID has already
+        /// registered its endpoints. Since this operation is marked idempotent, this exception may be thrown when the
+        /// Ice client runtime retries an invocation with a non-null @p proxy.
+        /// @throws InvalidReplicaGroupIdException Thrown when the given replica group does not match the replica group
+        /// associated with the adapter ID in the locator's database.
+        idempotent void setReplicatedAdapterDirectProxy(string adapterId, string replicaGroupId, Object* proxy)
+            throws AdapterNotFoundException, AdapterAlreadyActiveException, InvalidReplicaGroupIdException;
+
+        /// Registers a proxy to the {@link Process} object of a server application.
+        /// @param id The server ID.
+        /// @param proxy A proxy to the {@link Process} object of the server. This proxy is never null.
+        /// @throws ServerNotFoundException Thrown when the locator does not know a server application with a server ID
+        /// of @p id.
+        idempotent void setServerProcessProxy(string id, Process* proxy)
+            throws ServerNotFoundException;
+    }
+}