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

slice/Ice/Process.ice

@@ -1,6 +1,4 @@
-//
-// Copyright (c) ZeroC, Inc. All rights reserved.
-//
+// Copyright (c) ZeroC, Inc.
 
 #pragma once
 
@@ -8,57 +6,23 @@
 [["cpp:doxygen:include:Ice/Ice.h"]]
 [["cpp:header-ext:h"]]
 
-[["ice-prefix"]]
+[["js:module:@zeroc/ice"]]
 
-[["js:module:ice"]]
-[["js:cjs-module"]]
+#include "LocatorRegistry.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
 {
-
-/**
- *
- * An administrative interface for process management. Managed servers must
- * implement this interface.
- *
- * <p class="Note">A servant implementing this interface is a potential target
- * for denial-of-service attacks, therefore proper security precautions
- * should be taken. For example, the servant can use a UUID to make its
- * identity harder to guess, and be registered in an object adapter with
- * a secured endpoint.
- *
- **/
-interface Process
-{
-    /**
-     *
-     * Initiate a graceful shut-down.
-     *
-     * @see Communicator#shutdown
-     *
-     **/
-    void shutdown();
-
-    /**
-     *
-     * Write a message on the process' stdout or stderr.
-     *
-     * @param message The message.
-     *
-     * @param fd 1 for stdout, 2 for stderr.
-     *
-     **/
-    void writeMessage(string message, int fd);
-}
-
+    /// A server application managed by a locator implementation such as IceGrid hosts a Process object and registers a
+    /// proxy to this object with the locator registry. See {@link LocatorRegistry::setServerProcessProxy}.
+    interface Process
+    {
+        /// Initiates a graceful shutdown of the server application.
+        void shutdown();
+
+        /// Writes a message on the server application's stdout or stderr.
+        /// @param message The message to write.
+        /// @param fd 1 for stdout, 2 for stderr.
+        void writeMessage(string message, int fd);
+    }
 }

slice/Ice/PropertiesAdmin.ice

@@ -1,6 +1,4 @@
-//
-// Copyright (c) ZeroC, Inc. All rights reserved.
-//
+// Copyright (c) ZeroC, Inc.
 
 #pragma once
 
@@ -8,80 +6,32 @@
 [["cpp:doxygen:include:Ice/Ice.h"]]
 [["cpp:header-ext:h"]]
 
-[["ice-prefix"]]
+[["js:module:@zeroc/ice"]]
 
-[["js:module:ice"]]
-[["js:cjs-module"]]
+#include "PropertyDict.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
 {
-
-/**
- *
- * A simple collection of properties, represented as a dictionary of
- * key/value pairs. Both key and value are strings.
- *
- * @see Properties#getPropertiesForPrefix
- *
- **/
-dictionary<string, string> PropertyDict;
-
-/**
- *
- * The PropertiesAdmin interface provides remote access to the properties
- * of a communicator.
- *
- **/
-interface PropertiesAdmin
-{
-    /**
-     *
-     * 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.
-     *
-     **/
-    string getProperty(string key);
-
-    /**
-     *
-     * Get all properties whose keys begin 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.
-     *
-     **/
-    ["java:type:java.util.TreeMap<String, String>"] PropertyDict getPropertiesForPrefix(string prefix);
-
-    /**
-     *
-     * Update the communicator's properties with the given property set.
-     *
-     * @param newProperties Properties to be added, changed, or removed.
-     * If an entry in <em>newProperties</em> matches the name of an existing property,
-     * that property's value is replaced with the new value. If the new value
-     * is an empty string, the property is removed. Any existing properties
-     * that are not modified or removed by the entries in newProperties are
-     * retained with their original values.
-     *
-     **/
-    void setProperties(PropertyDict newProperties);
-}
-
+    /// Provides remote access to the properties of a communicator.
+    interface PropertiesAdmin
+    {
+        /// Gets a property by key.
+        /// @param key The property key.
+        /// @return The property value. This value is empty if the property is not set.
+        string getProperty(string key);
+
+        /// Gets all properties whose keys begin with @p prefix. If @p prefix is the empty string then all properties
+        /// are returned.
+        /// @param prefix The prefix to search for. May be empty.
+        /// @return The matching property set.
+        ["java:type:java.util.TreeMap<String, String>"] PropertyDict getPropertiesForPrefix(string prefix);
+
+        /// Updates the communicator's properties with the given property set. If an entry in @p newProperties matches
+        /// the name of an existing property, that property's value is replaced with the new value. If the new value is
+        /// the empty string, the property is removed. Existing properties that are not modified or removed by the
+        /// entries in @p newProperties are not affected by this update.
+        /// @param newProperties Properties to add, change, or remove.
+        void setProperties(PropertyDict newProperties);
+    }
 }

slice/Ice/PropertyDict.ice

@@ -0,0 +1,23 @@
+// Copyright (c) ZeroC, Inc.
+
+#pragma once
+
+[["cpp:dll-export:ICE_API"]]
+[["cpp:doxygen:include:Ice/Ice.h"]]
+[["cpp:header-ext:h"]]
+
+[["cpp:no-default-include"]]
+[["cpp:include:Ice/Config.h"]]
+[["cpp:include:map"]]
+[["cpp:include:string"]]
+
+[["js:module:@zeroc/ice"]]
+
+["java:identifier:com.zeroc.Ice"]
+module Ice
+{
+    /// A simple collection of properties, represented as a dictionary of key/value pairs. Both key and value are
+    /// strings.
+    ["cpp:type:std::map<std::string, std::string, std::less<>>"]
+    dictionary<string, string> PropertyDict;
+}

slice/Ice/RemoteLogger.ice

@@ -1,226 +1,126 @@
-//
-// Copyright (c) ZeroC, Inc. All rights reserved.
-//
+// Copyright (c) ZeroC, Inc.
 
 #pragma once
 
-#include <Ice/BuiltinSequences.ice>
-
 [["cpp:dll-export:ICE_API"]]
 [["cpp:doxygen:include:Ice/Ice.h"]]
 [["cpp:header-ext:h"]]
-[["cpp:include:list"]]
-
-[["ice-prefix"]]
 
-[["js:module:ice"]]
-[["js:cjs-module"]]
-
-[["objc:dll-export:ICE_API"]]
-[["objc:header-dir:objc"]]
+[["cpp:include:list"]]
 
-[["python:pkgdir:Ice"]]
+[["js:module:@zeroc/ice"]]
 
-#ifndef __SLICE2JAVA_COMPAT__
-[["java:package:com.zeroc"]]
-#endif
+#include "BuiltinSequences.ice"
 
-["objc:prefix:ICE"]
+["java:identifier:com.zeroc.Ice"]
 module Ice
 {
-
-/**
- *
- * An enumeration representing the different types of log messages.
- *
- **/
-enum LogMessageType
-{
-    /**
-     *
-     * The {@link Logger} received a print message.
-     *
-     **/
-    PrintMessage,
-
-    /**
-     *
-     * The {@link Logger} received a trace message.
-     *
-     **/
-    TraceMessage,
-
-    /**
-     *
-     * The {@link Logger} received a warning message.
-     *
-     **/
-    WarningMessage,
-
-    /**
-     *
-     * The {@link Logger} received an error message.
-     *
-     **/
-    ErrorMessage
-}
-
-/**
- *
- * A sequence of {@link LogMessageType}
- *
- **/
-sequence<LogMessageType> LogMessageTypeSeq;
-
-/**
- *
- * A complete log message.
- *
- **/
-struct LogMessage
-{
-    /**
-     *
-     * The type of message sent to the {@link Logger}.
-     *
-     **/
-    LogMessageType type;
-
-    /**
-     *
-     * The date and time when the {@link Logger} received this message, expressed
-     * as the number of microseconds since the Unix Epoch (00:00:00 UTC on 1 January 1970)
-     *
-     **/
-    long timestamp;
-
-    /**
-     *
-     * For a message of type trace, the trace category of this log message;
-     * otherwise, the empty string.
-     *
-     **/
-    string traceCategory;
-
-     /**
-     *
-     * The log message itself.
-     *
-     **/
-    string message;
-}
-
-/**
- *
- * A sequence of {@link LogMessage}.
- *
- **/
-["cpp:type:std::list<LogMessage>"]
-sequence<LogMessage> LogMessageSeq;
-
-/**
- *
- * The Ice remote logger interface. An application can implement a
- * RemoteLogger to receive the log messages sent to the local {@link Logger}
- * of another Ice application.
- *
- **/
-interface RemoteLogger
-{
-    /**
-     *
-     * init is called by attachRemoteLogger when a RemoteLogger proxy is attached.
-     *
-     * @param prefix The prefix of the associated local Logger.
-     *
-     * @param logMessages Old log messages generated before "now".
-     *
-     **/
-    void init(string prefix, LogMessageSeq logMessages);
-
-    /**
-     *
-     * Log a LogMessage. Note that log may be called by LoggerAdmin before init.
-     *
-     * @param message The message to log.
-     *
-     **/
-    void log(LogMessage message);
-}
-
-/**
- *
- * Thrown when the provided RemoteLogger was previously attached to a LoggerAdmin.
- *
- **/
-exception RemoteLoggerAlreadyAttachedException
-{
-}
-
-/**
- *
- * The interface of the admin object that allows an Ice application the attach its
- * {@link RemoteLogger} to the {@link Logger} of this admin object's Ice communicator.
- *
- **/
-interface LoggerAdmin
-{
-    /**
-     *
-     * Attaches a RemoteLogger object to the local logger.
-     * attachRemoteLogger calls init on the provided RemoteLogger proxy.
-     *
-     * @param prx A proxy to the remote logger.
-     *
-     * @param messageTypes The list of message types that the remote logger wishes to receive.
-     * An empty list means no filtering (send all message types).
-     *
-     * @param traceCategories The categories of traces that the remote logger wishes to receive.
-     * This parameter is ignored if messageTypes is not empty and does not include trace.
-     * An empty list means no filtering (send all trace categories).
-     *
-     * @param messageMax The maximum number of log messages (of all types) to be provided
-     * to init. A negative value requests all messages available.
-     *
-     * @throws RemoteLoggerAlreadyAttachedException Raised if this remote logger is already
-     * attached to this admin object.
-     *
-     **/
-    void attachRemoteLogger(RemoteLogger* prx, LogMessageTypeSeq messageTypes, StringSeq traceCategories,
-                            int messageMax)
-        throws RemoteLoggerAlreadyAttachedException;
-
-    /**
-     *
-     * Detaches a RemoteLogger object from the local logger.
-     *
-     * @param prx A proxy to the remote logger.
-     *
-     * @return True if the provided remote logger proxy was detached, and false otherwise.
-     *
-     **/
-    bool detachRemoteLogger(RemoteLogger* prx);
-
-    /**
-     *
-     * Retrieves log messages recently logged.
-     *
-     * @param messageTypes The list of message types that the caller wishes to receive.
-     * An empty list means no filtering (send all message types).
-     *
-     * @param traceCategories The categories of traces that caller wish to receive.
-     * This parameter is ignored if messageTypes is not empty and does not include trace.
-     * An empty list means no filtering (send all trace categories).
-     *
-     * @param messageMax The maximum number of log messages (of all types) to be returned.
-     * A negative value requests all messages available.
-     *
-     * @param prefix The prefix of the associated local logger.
-     *
-     * @return The Log messages.
-     *
-     **/
-    LogMessageSeq getLog(LogMessageTypeSeq messageTypes, StringSeq traceCategories, int messageMax, out string prefix);
-}
-
+    /// Represents the different types of log messages.
+    enum LogMessageType
+    {
+        /// The {@link RemoteLogger} received a print message.
+        ["swift:identifier:printMessage"]
+        PrintMessage,
+
+        /// The {@link RemoteLogger} received a trace message.
+        ["swift:identifier:traceMessage"]
+        TraceMessage,
+
+        /// The {@link RemoteLogger} received a warning message.
+        ["swift:identifier:warningMessage"]
+        WarningMessage,
+
+        /// The {@link RemoteLogger} received an error message.
+        ["swift:identifier:errorMessage"]
+        ErrorMessage
+    }
+
+    /// A sequence of {@link LogMessageType}.
+    sequence<LogMessageType> LogMessageTypeSeq;
+
+    /// Represents a full log message.
+    struct LogMessage
+    {
+        /// The type of message sent to the {@link RemoteLogger}.
+        LogMessageType type;
+
+        /// The date and time when the {@link RemoteLogger} received this message, expressed as the number of
+        /// microseconds since the Unix Epoch (00:00:00 UTC on 1 January 1970).
+        long timestamp;
+
+        /// For a message of type 'trace', the trace category of this log message; otherwise, the empty string.
+        string traceCategory;
+
+        /// The log message itself.
+        string message;
+    }
+
+    /// A sequence of {@link LogMessage}.
+    ["cpp:type:std::list<LogMessage>"]
+    sequence<LogMessage> LogMessageSeq;
+
+    /// Represents an Ice object that accepts log messages. It's called by the implementation of {@link LoggerAdmin}.
+    interface RemoteLogger
+    {
+        /// Attaches a remote logger to the local logger.
+        /// @param prefix The prefix of the associated local Logger.
+        /// @param logMessages Old log messages generated before "now".
+        ["swift:identifier:initialize"]
+        void init(string prefix, LogMessageSeq logMessages);
+
+        /// Logs a LogMessage.
+        /// @param message The message to log.
+        /// @remark {@link log} may be called by {@link LoggerAdmin} before {@link init}.
+        void log(LogMessage message);
+    }
+
+    /// Thrown when the provided {@link RemoteLogger} was previously attached to a {@link LoggerAdmin}.
+    exception RemoteLoggerAlreadyAttachedException
+    {
+    }
+
+    /// Represents the admin facet that allows an Ice application to attach its {@link RemoteLogger} to the local
+    /// logger of an Ice communicator.
+    interface LoggerAdmin
+    {
+        /// Attaches a {@link RemoteLogger} object to the local logger. This operation calls {@link RemoteLogger::init}
+        /// on @p prx.
+        /// @param prx A proxy to the remote logger.
+        /// @param messageTypes The list of message types that the remote logger wishes to receive. An empty list means
+        /// no filtering (send all message types).
+        /// @param traceCategories The categories of traces that the remote logger wishes to receive. This parameter is
+        /// ignored if @p messageTypes is not empty and does not include trace. An empty list means no filtering
+        /// (send all trace categories).
+        /// @param messageMax The maximum number of log messages (of all types) to be provided to
+        /// {@link RemoteLogger::init}. A negative value requests all messages available.
+        /// @throws RemoteLoggerAlreadyAttachedException Thrown if this remote logger is already attached to this admin
+        /// object.
+        void attachRemoteLogger(
+            RemoteLogger* prx,
+            LogMessageTypeSeq messageTypes,
+            StringSeq traceCategories,
+            int messageMax)
+            throws RemoteLoggerAlreadyAttachedException;
+
+        /// Detaches a {@link RemoteLogger} object from the local logger.
+        /// @param prx A proxy to the remote logger.
+        /// @return `true` if the provided remote logger proxy was detached, and `false` otherwise.
+        bool detachRemoteLogger(RemoteLogger* prx);
+
+        /// Retrieves recently logged log messages.
+        /// @param messageTypes The list of message types that the caller wishes to receive. An empty list means no
+        /// filtering (send all message types).
+        /// @param traceCategories The categories of traces that caller wish to receive. This parameter is ignored if
+        /// @p messageTypes is not empty and does not include trace. An empty list means no filtering (send all trace
+        /// categories).
+        /// @param messageMax The maximum number of log messages (of all types) to be returned. A negative value
+        /// requests all messages available.
+        /// @param prefix The prefix of the associated local logger.
+        /// @return The Log messages.
+        LogMessageSeq getLog(
+            LogMessageTypeSeq messageTypes,
+            StringSeq traceCategories,
+            int messageMax,
+            out string prefix);
+    }
 }

slice/Ice/ReplyStatus.ice

@@ -0,0 +1,65 @@
+// Copyright (c) ZeroC, Inc.
+
+#pragma once
+
+[["cpp:dll-export:ICE_API"]]
+[["cpp:doxygen:include:Ice/Ice.h"]]
+[["cpp:header-ext:h"]]
+
+[["cpp:no-default-include"]]
+[["cpp:include:Ice/Config.h"]]
+[["cpp:include:Ice/StreamHelpers.h"]]
+
+[["js:module:@zeroc/ice"]]
+
+["java:identifier:com.zeroc.Ice"]
+module Ice
+{
+    /// Represents the status of a reply.
+    /// A reply status can have any value in the range 0..255. Do not use this enum to marshal or unmarshal a reply
+    /// status unless you know its value corresponds to one of the enumerators defined below.
+    enum ReplyStatus
+    {
+        /// The dispatch completed successfully.
+        ["swift:identifier:ok"]
+        Ok = 0,
+
+        /// The dispatch completed with a Slice user exception.
+        ["swift:identifier:userException"]
+        UserException,
+
+        /// The dispatch could not find an implementation for the target object.
+        ["swift:identifier:objectNotExist"]
+        ObjectNotExist,
+
+        /// The dispatch found an implementation for the target object but could not find the requested facet.
+        ["swift:identifier:facetNotExist"]
+        FacetNotExist,
+
+        /// The dispatch found an implementation for the target object but could not find the requested operation.
+        ["swift:identifier:operationNotExist"]
+        OperationNotExist,
+
+        /// The dispatch failed with an Ice local exception.
+        ["swift:identifier:unknownLocalException"]
+        UnknownLocalException,
+
+        /// The dispatch failed with a Slice user exception that does not conform to the exception specification of
+        /// the operation.
+        ["swift:identifier:unknownUserException"]
+        UnknownUserException,
+
+        /// The dispatch failed with some other exception (neither an Ice local exception nor a Slice user exception).
+        ["swift:identifier:unknownException"]
+        UnknownException,
+
+        /// The dispatch failed because the request payload could not be unmarshaled. It is typically due to a mismatch
+        /// in the Slice definitions used by the client and the server.
+        ["swift:identifier:invalidData"]
+        InvalidData,
+
+        /// The caller is not authorized to access the requested resource.
+        ["swift:identifier:unauthorized"]
+        Unauthorized,
+    }
+}