zeroc-ice 3.7.11__cp314-cp314-macosx_10_15_universal2.whl

slice/Ice/ValueFactory.ice

@@ -0,0 +1,133 @@
+//
+// 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__)
+/**
+ *
+ * A factory for values. Value factories are used in several
+ * places, such as when Ice receives a class instance and
+ * when Freeze restores a persistent value. Value factories
+ * must be implemented by the application writer and registered
+ * with the communicator.
+ *
+ **/
+["delegate"]
+local interface ValueFactory
+{
+    /**
+     *
+     * Create a new value for a given value 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 an interface <code>Bar</code> in the module
+     * <code>Foo</code> is <code>"::Foo::Bar"</code>.
+     *
+     * Note that the leading "<code>::</code>" is required.
+     *
+     * @param type The value type.
+     *
+     * @return The value created for the given type, or nil if the
+     * factory is unable to create the value.
+     *
+     **/
+    ["swift:noexcept"] Value create(string type);
+}
+
+/**
+ *
+ * A value factory manager maintains a collection of value factories.
+ * An application can supply a custom implementation during communicator
+ * initialization, otherwise Ice provides a default implementation.
+ *
+ * @see ValueFactory
+ *
+ **/
+local interface ValueFactoryManager
+{
+    /**
+     *
+     * Add a value factory. Attempting to add a factory with an id for
+     * which a factory is already registered throws AlreadyRegisteredException.
+     *
+     * When unmarshaling an Ice value, the Ice run time reads the
+     * most-derived type id off the wire and attempts to create an
+     * instance of the type using a factory. If no instance is created,
+     * either because no factory was found, or because all factories
+     * returned nil, the behavior of the Ice run time depends on the
+     * format with which the value was marshaled:
+     *
+     * If the value uses the "sliced" format, Ice ascends the class
+     * hierarchy until it finds a type that is recognized by a factory,
+     * or it reaches the least-derived type. If no factory is found that
+     * can create an instance, the run time throws NoValueFactoryException.
+     *
+     * If the value uses the "compact" format, Ice immediately raises
+     * NoValueFactoryException.
+     *
+     * The following order is used to locate a factory for a type:
+     *
+     * <ol>
+     *
+     * <li>The Ice run-time looks for a factory registered
+     * specifically for the type.</li>
+     *
+     * <li>If no instance has been created, the Ice run-time looks
+     * for the default factory, which is registered with an empty type id.
+     * </li>
+     *
+     * <li>If no instance has been created by any of the preceding
+     * steps, the Ice run-time looks for a factory that may have been
+     * statically generated by the language mapping for non-abstract classes.
+     * </li>
+     *
+     * </ol>
+     *
+     * @param factory The factory to add.
+     *
+     * @param id The type id for which the factory can create instances, or
+     * an empty string for the default factory.
+     *
+     **/
+    void add(["swift:nonnull"] ValueFactory factory, ["objc:param:sliceId"] string id);
+
+    /**
+     *
+     * Find an value factory registered with this communicator.
+     *
+     * @param id The type id for which the factory can create instances,
+     * or an empty string for the default factory.
+     *
+     * @return The value factory, or null if no value factory was
+     * found for the given id.
+     *
+     **/
+    ["cpp:const", "cpp:noexcept", "swift:noexcept"] ValueFactory find(string id);
+}
+#endif
+
+}

slice/Ice/Version.ice

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

slice/IceBT/ConnectionInfo.ice

@@ -0,0 +1,59 @@
+//
+// Copyright (c) ZeroC, Inc. All rights reserved.
+//
+
+#pragma once
+
+[["cpp:dll-export:ICEBT_API"]]
+[["cpp:doxygen:include:IceBT/IceBT.h"]]
+[["cpp:header-ext:h"]]
+
+[["ice-prefix"]]
+
+[["js:module:ice"]]
+[["js:cjs-module"]]
+
+[["objc:header-dir:objc"]]
+
+[["python:pkgdir:IceBT"]]
+
+#include <Ice/Connection.ice>
+
+#ifndef __SLICE2JAVA_COMPAT__
+[["java:package:com.zeroc"]]
+#endif
+
+["objc:prefix:ICEBT"]
+module IceBT
+{
+
+/**
+ *
+ * Provides access to the details of a Bluetooth connection.
+ *
+ **/
+local class ConnectionInfo extends Ice::ConnectionInfo
+{
+    /** The local Bluetooth address. */
+    string localAddress = "";
+
+    /** The local RFCOMM channel. */
+    int localChannel = -1;
+
+    /** The remote Bluetooth address. */
+    string remoteAddress = "";
+
+    /** The remote RFCOMM channel. */
+    int remoteChannel = -1;
+
+    /** The UUID of the service being offered (in a server) or targeted (in a client). */
+    string uuid = "";
+
+    /** The connection buffer receive size. **/
+    int rcvSize = 0;
+
+    /** The connection buffer send size. **/
+    int sndSize = 0;
+}
+
+}

slice/IceBT/EndpointInfo.ice

@@ -0,0 +1,57 @@
+//
+// Copyright (c) ZeroC, Inc. All rights reserved.
+//
+
+#pragma once
+
+[["cpp:dll-export:ICEBT_API"]]
+[["cpp:doxygen:include:IceBT/IceBT.h"]]
+[["cpp:header-ext:h"]]
+
+[["ice-prefix"]]
+
+[["js:module:ice"]]
+[["js:cjs-module"]]
+
+[["objc:header-dir:objc"]]
+
+[["python:pkgdir:IceBT"]]
+
+#include <Ice/Endpoint.ice>
+
+#ifndef __SLICE2JAVA_COMPAT__
+[["java:package:com.zeroc"]]
+#endif
+
+/**
+ *
+ * IceBT provides a Bluetooth transport for Ice.
+ *
+ **/
+["objc:prefix:ICEBT", "swift:module:Ice:SSL"]
+module IceBT
+{
+
+/**
+ *
+ * Provides access to Bluetooth endpoint information.
+ *
+ **/
+local class EndpointInfo extends Ice::EndpointInfo
+{
+    /**
+     *
+     * The address configured with the endpoint.
+     *
+     **/
+    string addr;
+
+    /**
+     *
+     * The UUID configured with the endpoint.
+     *
+     **/
+    string uuid;
+}
+
+}

slice/IceBT/Types.ice

@@ -0,0 +1,45 @@
+//
+// Copyright (c) ZeroC, Inc. All rights reserved.
+//
+
+#pragma once
+
+[["cpp:dll-export:ICEBT_API"]]
+[["cpp:doxygen:include:IceBT/IceBT.h"]]
+[["cpp:header-ext:h"]]
+
+[["ice-prefix"]]
+
+[["js:module:ice"]]
+[["js:cjs-module"]]
+
+[["objc:header-dir:objc"]]
+
+[["python:pkgdir:IceBT"]]
+
+#ifndef __SLICE2JAVA_COMPAT__
+[["java:package:com.zeroc"]]
+#endif
+
+/**
+ *
+ * IceBT provides a Bluetooth transport for Ice.
+ *
+ **/
+["objc:prefix:ICEBT"]
+module IceBT
+{
+
+/**
+ *
+ * Indicates a failure in the Bluetooth plug-in.
+ *
+ **/
+["cpp:ice_print"]
+local exception BluetoothException
+{
+    /** Provides more information about the failure. */
+    string reason;
+}
+
+}

slice/IceBox/IceBox.ice

@@ -0,0 +1,216 @@
+//
+// Copyright (c) ZeroC, Inc. All rights reserved.
+//
+
+#pragma once
+
+[["cpp:dll-export:ICEBOX_API"]]
+[["cpp:doxygen:include:IceBox/IceBox.h"]]
+[["cpp:header-ext:h"]]
+[["cpp:include:IceBox/Config.h"]]
+
+[["ice-prefix"]]
+
+[["js:module:ice"]]
+[["js:cjs-module"]]
+
+[["objc:header-dir:objc"]]
+
+[["python:pkgdir:IceBox"]]
+
+#include <Ice/BuiltinSequences.ice>
+#include <Ice/CommunicatorF.ice>
+#include <Ice/PropertiesF.ice>
+#include <Ice/SliceChecksumDict.ice>
+
+#ifndef __SLICE2JAVA_COMPAT__
+[["java:package:com.zeroc"]]
+#endif
+
+/**
+ *
+ * IceBox is an application server specifically for Ice
+ * applications. IceBox can easily run and administer Ice services
+ * that are dynamically loaded as a DLL, shared library, or Java
+ * class.
+ *
+ **/
+module IceBox
+{
+
+/**
+ *
+ * This exception is a general failure notification. It is thrown
+ * for errors such as a service encountering an error during
+ * initialization, or the service manager being unable
+ * to load a service executable.
+ *
+ **/
+["cpp:ice_print"]
+local exception FailureException
+{
+    /**
+     *
+     * The reason for the failure.
+     *
+     **/
+    string reason;
+}
+
+/**
+ *
+ * This exception is thrown if an attempt is made to start an
+ * already-started service.
+ *
+ **/
+exception AlreadyStartedException
+{
+}
+
+/**
+ *
+ * This exception is thrown if an attempt is made to stop an
+ * already-stopped service.
+ *
+ **/
+exception AlreadyStoppedException
+{
+}
+
+/**
+ *
+ * This exception is thrown if a service name does not refer
+ * to an existing service.
+ *
+ **/
+exception NoSuchServiceException
+{
+}
+
+/**
+ *
+ * An application service managed by a {@link ServiceManager}.
+ *
+ **/
+local interface Service
+{
+    /**
+     *
+     * Start the service. The given communicator is created by the
+     * {@link ServiceManager} for use by the service. This communicator may
+     * also be used by other services, depending on the service
+     * configuration.
+     *
+     * <p class="Note">The {@link ServiceManager} owns this communicator, and is
+     * responsible for destroying it.
+     *
+     * @param name The service's name, as determined by the
+     * configuration.
+     *
+     * @param communicator A communicator for use by the service.
+     *
+     * @param args The service arguments that were not converted into
+     * properties.
+     *
+     * @throws FailureException Raised if {@link #start} failed.
+     *
+     **/
+    void start(string name, Ice::Communicator communicator, Ice::StringSeq args);
+
+    /**
+     *
+     * Stop the service.
+     *
+     **/
+    void stop();
+}
+
+/**
+ *
+ * An Observer interface implemented by admin clients interested in the status
+ * of services.
+ *
+ * @see ServiceManager
+ *
+ **/
+interface ServiceObserver
+{
+    /**
+     *
+     * Receives the names of the services that were started.
+     *
+     * @param services The names of the services.
+     *
+     **/
+    void servicesStarted(Ice::StringSeq services);
+
+    /**
+     *
+     * Receives the names of the services that were stopped.
+     *
+     * @param services The names of the services.
+     *
+     **/
+    void servicesStopped(Ice::StringSeq services);
+}
+
+/**
+ *
+ * Administers a set of {@link Service} instances.
+ *
+ * @see Service
+ *
+ **/
+interface ServiceManager
+{
+    /**
+     *
+     * Returns the checksums for the IceBox Slice definitions.
+     *
+     * @return A dictionary mapping Slice type ids to their checksums.
+     *
+     **/
+    ["nonmutating", "cpp:const"] idempotent Ice::SliceChecksumDict getSliceChecksums();
+
+    /**
+     *
+     * Start an individual service.
+     *
+     * @param service The service name.
+     *
+     * @throws AlreadyStartedException If the service is already running.
+     * @throws NoSuchServiceException If no service could be found with the given name.
+     **/
+    void startService(string service)
+        throws AlreadyStartedException, NoSuchServiceException;
+
+    /**
+     *
+     * Stop an individual service.
+     *
+     * @param service The service name.
+     *
+     * @throws AlreadyStoppedException If the service is already stopped.
+     * @throws NoSuchServiceException If no service could be found with the given name.
+     **/
+    void stopService(string service)
+        throws AlreadyStoppedException, NoSuchServiceException;
+
+    /**
+     *
+     * Registers a new observer with the ServiceManager.
+     *
+     * @param observer The new observer
+     *
+     **/
+    void addObserver(ServiceObserver* observer);
+
+    /**
+     *
+     * Shut down all services. This causes stop to be invoked on all configured services.
+     *
+     **/
+    void shutdown();
+}
+
+}