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

slice/Ice/Router.ice

@@ -1,6 +1,4 @@
-//
-// Copyright (c) ZeroC, Inc. All rights reserved.
-//
+// Copyright (c) ZeroC, Inc.
 
 #pragma once
 
@@ -8,96 +6,49 @@
 [["cpp:doxygen:include:Ice/Ice.h"]]
 [["cpp:header-ext:h"]]
 
-[["ice-prefix"]]
+[["js:module:@zeroc/ice"]]
 
-[["js:module:ice"]]
-[["js:cjs-module"]]
+#include "BuiltinSequences.ice"
 
-[["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"]
+["java:identifier:com.zeroc.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();
-}
-
+    /// Represents an intermediary object that routes requests and replies between clients and Ice objects that are not
+    /// directly reachable from these clients.
+    interface Router
+    {
+        /// Gets 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 `true`, the Ice
+        /// runtime will call {@link addProxies} to populate the routing table. The Ice runtime assumes the router has
+        /// a routing table when @p hasRoutingTable is not set.
+        /// @return The router's client proxy.
+        /// @remark Introduced in Ice 3.7.
+        ["cpp:const"]
+        idempotent Object* getClientProxy(out optional(1) bool hasRoutingTable);
+
+        /// Gets the router's server proxy, i.e. the proxy to use for forwarding requests from the server to the
+        /// router. The Ice runtime uses the endpoints of this proxy as the published endpoints of bi-dir object
+        /// adapters.
+        /// @return The router's server proxy.
+        ["cpp:const"]
+        idempotent Object* getServerProxy();
+
+        /// Adds new proxy information to the router's routing table.
+        /// @param proxies The proxies to add. Adding a null proxy is an error.
+        /// @return Proxies discarded by the router. These proxies are all non-null.
+        idempotent ObjectProxySeq addProxies(ObjectProxySeq proxies);
+    }
+
+    /// Provides access to a {@link Router} object via a fixed identity.
+    /// A RouterFinder is always registered with identity `Ice/RouterFinder`. This allows clients to obtain the
+    /// associated Router proxy with just the endpoint information of the object. For example, you can use the
+    /// RouterFinder proxy `Ice/RouterFinder:tcp -h somehost -p 4061` to get the Router proxy
+    /// `MyGlacier2/Router:tcp -h somehost -p 4061`.
+    interface RouterFinder
+    {
+        /// Gets a proxy to the associated {@link Router}. The proxy might point to several replicas.
+        /// @return The router proxy. This proxy is never null.
+        Router* getRouter();
+    }
 }

slice/Ice/SliceChecksumDict.ice

@@ -1,6 +1,4 @@
-//
-// Copyright (c) ZeroC, Inc. All rights reserved.
-//
+// Copyright (c) ZeroC, Inc.
 
 #pragma once
 
@@ -8,29 +6,13 @@
 [["cpp:doxygen:include:Ice/Ice.h"]]
 [["cpp:header-ext:h"]]
 
-[["ice-prefix"]]
+[["js:module:@zeroc/ice"]]
 
-[["js:module:ice"]]
-[["js:cjs-module"]]
-
-[["objc:dll-export:ICE_API"]]
-[["objc:header-dir:objc"]]
-
-[["python:pkgdir:Ice"]]
-
-#ifndef __SLICE2JAVA_COMPAT__
-[["java:package:com.zeroc"]]
-#endif
-
-["objc:prefix:ICE"]
+["java:identifier:com.zeroc.Ice"]
 module Ice
 {
-
-/**
- * A mapping from type IDs to Slice checksums. The dictionary
- * allows verification at run time that client and server
- * use matching Slice definitions.
- **/
-dictionary<string, string> SliceChecksumDict;
-
+    /// Mapping from type IDs to Slice checksums. This dictionary allows verification at runtime that a client and a
+    /// server use essentially the same Slice definitions.
+    ["deprecated:As of Ice 3.8, the Slice compilers no longer generate Slice checksums."]
+    dictionary<string, string> SliceChecksumDict;
 }

slice/Ice/Version.ice

@@ -1,6 +1,4 @@
-//
-// Copyright (c) ZeroC, Inc. All rights reserved.
-//
+// Copyright (c) ZeroC, Inc.
 
 #pragma once
 
@@ -8,44 +6,38 @@
 [["cpp:doxygen:include:Ice/Ice.h"]]
 [["cpp:header-ext:h"]]
 
-[["ice-prefix"]]
+[["cpp:no-default-include"]]
+[["cpp:no-stream"]]
+[["cpp:include:Ice/Config.h"]]
+[["cpp:include:Ice/TupleCompare.h"]]
+[["cpp:include:cstdint"]]
+[["cpp:include:ostream"]]
 
-[["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"]
+["java:identifier:com.zeroc.Ice"]
 module Ice
 {
-
-/**
- *
- * A version structure for the protocol version.
- *
- **/
-struct ProtocolVersion
-{
-    byte major;
-    byte minor;
-}
-
-/**
- *
- * A version structure for the encoding version.
- *
- **/
-struct EncodingVersion
-{
-    byte major;
-    byte minor;
-}
-
+    /// Represents a version of the Ice protocol. The only version implemented and supported by Ice is version 1.0.
+    ["cpp:custom-print"]
+    struct ProtocolVersion
+    {
+        /// The major version of the Ice protocol.
+        byte major;
+
+        /// The minor version of the Ice protocol.
+        byte minor;
+    }
+
+    /// Represents a version of the Slice encoding. Ice supports version 1.0 and 1.1 of this encoding.
+    /// @remark The Slice encoding is also known as the Ice encoding.
+    ["cpp:custom-print"]
+    struct EncodingVersion
+    {
+        /// The major version of the Slice encoding.
+        byte major;
+
+        /// The minor version of the Slice encoding.
+        byte minor;
+    }
 }

slice/IceBox/ServiceManager.ice

@@ -0,0 +1,79 @@
+// Copyright (c) ZeroC, Inc.
+
+#pragma once
+
+[["cpp:dll-export:ICEBOX_API"]]
+[["cpp:doxygen:include:IceBox/IceBox.h"]]
+[["cpp:header-ext:h"]]
+
+[["cpp:include:IceBox/Config.h"]]
+
+[["js:module:@zeroc/ice"]]
+
+#include "Ice/BuiltinSequences.ice"
+
+/// Host multiple independent services in the same Ice server.
+["java:identifier:com.zeroc.IceBox"]
+module IceBox
+{
+    /// The exception that is thrown when attempting to start a service that is already running.
+    exception AlreadyStartedException
+    {
+    }
+
+    /// The exception that is thrown when attempting to stop a service that is already stopped.
+    exception AlreadyStoppedException
+    {
+    }
+
+    /// The exception that is thrown when a service name does not refer to a known service.
+    exception NoSuchServiceException
+    {
+    }
+
+    /// Observes the status of services in an IceBox server.
+    /// @remark This interface is implemented by admin tools that monitor the IceBox server.
+    /// @see ServiceManager#addObserver
+    interface ServiceObserver
+    {
+        /// Receives the names of the services that were started.
+        /// @param services The names of the services that were started.
+        void servicesStarted(Ice::StringSeq services);
+
+        /// Receives the names of the services that were stopped.
+        /// @param services The names of the services that were stopped.
+        void servicesStopped(Ice::StringSeq services);
+    }
+
+    /// Administers the services of an IceBox server.
+    interface ServiceManager
+    {
+        /// Starts a service.
+        /// @param service The service name.
+        /// @throws AlreadyStartedException Thrown when the service is already running.
+        /// @throws NoSuchServiceException Thrown when IceBox does not know a service named @p service.
+        void startService(string service)
+            throws AlreadyStartedException, NoSuchServiceException;
+
+        /// Stops a service.
+        /// @param service The service name.
+        /// @throws AlreadyStoppedException Thrown when the service is already stopped.
+        /// @throws NoSuchServiceException Thrown when IceBox does not know a service named @p service.
+        void stopService(string service)
+            throws AlreadyStoppedException, NoSuchServiceException;
+
+        /// Returns whether a service is running.
+        /// @param service The name of the service to check.
+        /// @return `true` if the service was started and not stopped; otherwise `false`.
+        /// @throws NoSuchServiceException Thrown when IceBox does not know a service named @p service.
+        bool isServiceRunning(string service)
+            throws NoSuchServiceException;
+
+        /// Registers a new observer with this service manager.
+        /// @param observer The new observer.
+        void addObserver(ServiceObserver* observer);
+
+        /// Shuts down all services.
+        void shutdown();
+    }
+}