zeroc-ice 3.7.11__cp313-cp313-macosx_10_13_universal2.whl

slice/Ice/ObjectAdapterF.ice

@@ -0,0 +1,31 @@
+//
+// 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"]]
+
+#ifndef __SLICE2JAVA_COMPAT__
+[["java:package:com.zeroc"]]
+#endif
+
+["objc:prefix:ICE"]
+module Ice
+{
+
+local interface ObjectAdapter;
+
+}

slice/Ice/ObjectFactory.ice

@@ -0,0 +1,71 @@
+//
+// 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"]]
+
+#ifndef __SLICE2JAVA_COMPAT__
+[["java:package:com.zeroc"]]
+#endif
+
+["objc:prefix:ICE"]
+module Ice
+{
+
+#if !defined(__SLICE2PHP__) && !defined(__SLICE2SWIFT__)
+/**
+ *
+ * A factory for objects. Object factories are used when receiving "objects by value".
+ * An object factory must be implemented by the application writer and registered
+ * with the communicator.
+ *
+ **/
+["deprecate:ObjectFactory has been deprecated, use ValueFactory instead."]
+local interface ObjectFactory
+{
+    /**
+     *
+     * Create a new object for a given object type. The type is the
+     * absolute Slice type id, i.e., the id relative to the
+     * unnamed top-level Slice module. For example, the absolute
+     * Slice type id for interfaces of type <code>Bar</code> in the module
+     * <code>Foo</code> is <code>"::Foo::Bar"</code>.
+     *
+     * <p class="Note">The leading "<code>::</code>" is required.
+     *
+     * @param type The object type.
+     *
+     * @return The object created for the given type, or nil if the
+     * factory is unable to create the object.
+     *
+     **/
+    Value create(string type);
+
+    /**
+     *
+     * Called when the factory is removed from the communicator, or if
+     * the communicator is destroyed.
+     *
+     * @see Communicator#destroy
+     *
+     **/
+    void destroy();
+}
+
+#endif
+
+}

slice/Ice/Plugin.ice

@@ -0,0 +1,131 @@
+
+//
+// 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/LoggerF.ice>
+#include <Ice/BuiltinSequences.ice>
+
+#ifndef __SLICE2JAVA_COMPAT__
+[["java:package:com.zeroc"]]
+#endif
+
+["objc:prefix:ICE"]
+module Ice
+{
+
+#if !defined(__SLICE2PHP__)
+/**
+ *
+ * A communicator plug-in. A plug-in generally adds a feature to a
+ * communicator, such as support for a protocol.
+ *
+ * The communicator loads its plug-ins in two stages: the first stage
+ * creates the plug-ins, and the second stage invokes {@link Plugin#initialize} on
+ * each one.
+ *
+ **/
+local interface Plugin
+{
+    /**
+     *
+     * Perform any necessary initialization steps.
+     *
+     **/
+    void initialize();
+
+    /**
+     *
+     * Called when the communicator is being destroyed.
+     *
+     **/
+    void destroy();
+}
+
+/**
+ *
+ * Each communicator has a plug-in manager to administer the set of
+ * plug-ins.
+ *
+ **/
+local interface PluginManager
+{
+    /**
+     *
+     * Initialize the configured plug-ins. The communicator automatically initializes
+     * the plug-ins by default, but an application may need to interact directly with
+     * a plug-in prior to initialization. In this case, the application must set
+     * <code>Ice.InitPlugins=0</code> and then invoke {@link #initializePlugins}
+     * manually. The plug-ins are initialized in the order in which they are loaded.
+     * If a plug-in raises an exception during initialization, the communicator
+     * invokes destroy on the plug-ins that have already been initialized.
+     *
+     * @throws InitializationException Raised if the plug-ins have already been initialized.
+     *
+     **/
+    void initializePlugins();
+
+    /**
+     *
+     * Get a list of plugins installed.
+     *
+     * @return The names of the plugins installed.
+     *
+     * @see #getPlugin
+     *
+     **/
+    ["cpp:noexcept", "swift:noexcept"] StringSeq getPlugins();
+
+    /**
+     *
+     * Obtain a plug-in by name.
+     *
+     * @param name The plug-in's name.
+     *
+     * @return The plug-in.
+     *
+     * @throws NotRegisteredException Raised if no plug-in is found with the given name.
+     *
+     **/
+    Plugin getPlugin(string name);
+
+    /**
+     *
+     * Install a new plug-in.
+     *
+     * @param name The plug-in's name.
+     *
+     * @param pi The plug-in.
+     *
+     * @throws AlreadyRegisteredException Raised if a plug-in already exists with the given name.
+     *
+     **/
+    void addPlugin(string name, Plugin pi);
+
+    /**
+     *
+     * Called when the communicator is being destroyed.
+     *
+     **/
+    ["cpp:noexcept", "swift:noexcept"] void destroy();
+}
+
+#endif
+
+}

slice/Ice/PluginF.ice

@@ -0,0 +1,36 @@
+//
+// 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"]]
+
+#ifndef __SLICE2JAVA_COMPAT__
+[["java:package:com.zeroc"]]
+#endif
+
+["objc:prefix:ICE"]
+module Ice
+{
+
+#if !defined(__SLICE2PHP__)
+
+local interface Plugin;
+local interface PluginManager;
+
+#endif
+
+}

slice/Ice/Process.ice

@@ -0,0 +1,64 @@
+//
+// 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"]]
+
+#ifndef __SLICE2JAVA_COMPAT__
+[["java:package:com.zeroc"]]
+#endif
+
+["objc:prefix: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);
+}
+
+}

slice/Ice/ProcessF.ice

@@ -0,0 +1,31 @@
+//
+// 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"]]
+
+#ifndef __SLICE2JAVA_COMPAT__
+[["java:package:com.zeroc"]]
+#endif
+
+["objc:prefix:ICE"]
+module Ice
+{
+
+interface Process;
+
+}

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
+
+}

slice/Ice/PropertiesAdmin.ice

@@ -0,0 +1,87 @@
+//
+// 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
+{
+
+/**
+ *
+ * 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);
+}
+
+}