zeroc-ice 3.7.10__cp312-cp312-win_amd64.whl → 3.8.0__cp312-cp312-win_amd64.whl

slice/Glacier2/SSLInfo.ice

@@ -1,59 +1,42 @@
-//
-// Copyright (c) ZeroC, Inc. All rights reserved.
-//
-
-#pragma once
-
-[["cpp:dll-export:GLACIER2_API"]]
-[["cpp:doxygen:include:Glacier2/Glacier2.h"]]
-[["cpp:header-ext:h"]]
-[["cpp:include:Glacier2/Config.h"]]
-
-[["js:module:ice"]]
-[["js:cjs-module"]]
-
-[["objc:dll-export:GLACIER2_API"]]
-[["objc:header-dir:objc"]]
-
-[["python:pkgdir:Glacier2"]]
-
-#include <Ice/BuiltinSequences.ice>
-
-#ifndef __SLICE2JAVA_COMPAT__
-[["java:package:com.zeroc"]]
-#endif
-
-["objc:prefix:GLACIER2"]
-module Glacier2
-{
-
-/**
- *
- * Information taken from an SSL connection used for permissions
- * verification.
- *
- * @see PermissionsVerifier
- *
- */
-struct SSLInfo
-{
-    /** The remote host. */
-    string remoteHost;
-
-    /** The remote port. */
-    int remotePort;
-
-    /** The router's host. */
-    string localHost;
-
-    /** The router's port. */
-    int localPort;
-
-    /** The negotiated cipher suite. */
-    string cipher;
-
-    /** The certificate chain. */
-    Ice::StringSeq certs;
-}
-
-}
+// Copyright (c) ZeroC, Inc.
+
+#pragma once
+
+[["cpp:dll-export:GLACIER2_API"]]
+[["cpp:doxygen:include:Glacier2/Glacier2.h"]]
+[["cpp:header-ext:h"]]
+
+[["cpp:include:Glacier2/Config.h"]]
+
+[["js:module:@zeroc/ice"]]
+
+#include "Ice/BuiltinSequences.ice"
+
+["java:identifier:com.zeroc.Glacier2"]
+module Glacier2
+{
+    interface SSLPermissionsVerifier; // So that doc-comments can link to `SSLPermissionsVerifier`.
+
+    /// Represents information gathered from an incoming SSL connection and used for authentication and authorization.
+    /// @see SSLPermissionsVerifier
+    struct SSLInfo
+    {
+        /// The remote host.
+        string remoteHost;
+
+        /// The remote port.
+        int remotePort;
+
+        /// The router's host.
+        string localHost;
+
+        /// The router's port.
+        int localPort;
+
+        /// The negotiated cipher suite.
+        string cipher;
+
+        /// The certificate chain.
+        Ice::StringSeq certs;
+    }
+}

slice/Glacier2/Session.ice

@@ -1,274 +1,133 @@
-//
-// Copyright (c) ZeroC, Inc. All rights reserved.
-//
-
-#pragma once
-
-[["cpp:dll-export:GLACIER2_API"]]
-[["cpp:doxygen:include:Glacier2/Glacier2.h"]]
-[["cpp:header-ext:h"]]
-[["cpp:include:Glacier2/Config.h"]]
-
-[["js:module:ice"]]
-[["js:cjs-module"]]
-
-[["objc:dll-export:GLACIER2_API"]]
-[["objc:header-dir:objc"]]
-
-[["python:pkgdir:Glacier2"]]
-
-#include <Ice/BuiltinSequences.ice>
-#include <Ice/Identity.ice>
-#include <Glacier2/SSLInfo.ice>
-
-#ifndef __SLICE2JAVA_COMPAT__
-[["java:package:com.zeroc"]]
-#endif
-
-["objc:prefix:GLACIER2"]
-module Glacier2
-{
-
-/**
- *
- * This exception is raised if an attempt to create a new session failed.
- *
- **/
-["preserve-slice"]
-exception CannotCreateSessionException
-{
-    /**
-     *
-     * The reason why session creation has failed.
-     *
-     **/
-    string reason;
-}
-
-/**
- *
- * A client-visible session object, which is tied to the lifecycle of a {@link Router}.
- *
- * @see Router
- * @see SessionManager
- *
- **/
-interface Session
-{
-    /**
-     *
-     * Destroy the session. This is called automatically when the router is destroyed.
-     *
-     **/
-    void destroy();
-}
-
-/**
- *
- * An object for managing the set of identity constraints for specific
- * parts of object identity on a
- * {@link Session}.
- *
- * @see Session
- * @see SessionControl
- *
- **/
-interface StringSet
-{
-    /**
-     *
-     * Add a sequence of strings to this set of constraints. Order is
-     * not preserved and duplicates are implicitly removed.
-     *
-     * @param additions The sequence of strings to be added.
-     *
-     **/
-    idempotent void add(Ice::StringSeq additions);
-
-    /**
-     *
-     * Remove a sequence of strings from this set of constraints. No
-     * errors are returned if an entry is not found.
-     *
-     * @param deletions The sequence of strings to be removed.
-     *
-     **/
-    idempotent void remove(Ice::StringSeq deletions);
-
-    /**
-     *
-     * Returns a sequence of strings describing the constraints in this
-     * set.
-     *
-     * @return The sequence of strings for this set.
-     *
-     **/
-    idempotent Ice::StringSeq get();
-}
-
-/**
- *
- * An object for managing the set of object identity constraints on a
- * {@link Session}.
- *
- * @see Session
- * @see SessionControl
- *
- **/
-interface IdentitySet
-{
-    /**
-     *
-     * Add a sequence of Ice identities to this set of constraints. Order is
-     * not preserved and duplicates are implicitly removed.
-     *
-     * @param additions The sequence of Ice identities to be added.
-     *
-     **/
-    idempotent void add(Ice::IdentitySeq additions);
-
-    /**
-     *
-     * Remove a sequence of identities from this set of constraints. No
-     * errors are returned if an entry is not found.
-     *
-     * @param deletions The sequence of Ice identities to be removed.
-     *
-     **/
-    idempotent void remove(Ice::IdentitySeq deletions);
-
-    /**
-     *
-     * Returns a sequence of identities describing the constraints in this
-     * set.
-     *
-     * @return The sequence of Ice identities for this set.
-     *
-     **/
-    idempotent Ice::IdentitySeq get();
-}
-
-/**
- *
- * An administrative session control object, which is tied to the
- * lifecycle of a {@link Session}.
- *
- * @see Session
- *
- **/
-interface SessionControl
-{
-    /**
-     *
-     * Access the object that manages the allowable categories
-     * for object identities for this session.
-     *
-     * @return A StringSet object.
-     *
-     **/
-    StringSet* categories();
-
-    /**
-     *
-     * Access the object that manages the allowable adapter identities
-     * for objects for this session.
-     *
-     * @return A StringSet object.
-     *
-     **/
-    StringSet* adapterIds();
-
-    /**
-     *
-     * Access the object that manages the allowable object identities
-     * for this session.
-     *
-     * @return An IdentitySet object.
-     *
-     **/
-    IdentitySet* identities();
-
-    /**
-     *
-     * Get the session timeout.
-     *
-     * @return The timeout.
-     *
-     **/
-    idempotent int getSessionTimeout();
-
-    /**
-     *
-     * Destroy the associated session.
-     *
-     **/
-    void destroy();
-}
-
-/**
- *
- * The session manager for username/password authenticated users that
- * is responsible for managing {@link Session} objects. New session objects
- * are created by the {@link Router} object calling on an application-provided
- * session manager. If no session manager is provided by the application,
- * no client-visible sessions are passed to the client.
- *
- * @see Router
- * @see Session
- *
- **/
-interface SessionManager
-{
-    /**
-     *
-     * Create a new session.
-     *
-     * @param userId The user id for the session.
-     *
-     * @param control A proxy to the session control object.
-     *
-     * @return A proxy to the newly created session.
-     *
-     * @throws CannotCreateSessionException Raised if the session
-     * cannot be created.
-     *
-     **/
-    ["format:sliced"]
-    Session* create(string userId, SessionControl* control)
-        throws CannotCreateSessionException;
-}
-
-/**
- *
- * The session manager for SSL authenticated users that is
- * responsible for managing {@link Session} objects. New session objects are
- * created by the {@link Router} object calling on an application-provided
- * session manager. If no session manager is provided by the
- * application, no client-visible sessions are passed to the client.
- *
- * @see Router
- * @see Session
- *
- **/
-interface SSLSessionManager
-{
-    /**
-     *
-     * Create a new session.
-     *
-     * @param info The SSL info.
-     *
-     * @param control A proxy to the session control object.
-     *
-     * @return A proxy to the newly created session.
-     *
-     * @throws CannotCreateSessionException Raised if the session
-     * cannot be created.
-     *
-     **/
-    ["format:sliced"]
-    Session* create(SSLInfo info, SessionControl* control)
-        throws CannotCreateSessionException;
-}
-
-}
+// Copyright (c) ZeroC, Inc.
+
+#pragma once
+
+[["cpp:dll-export:GLACIER2_API"]]
+[["cpp:doxygen:include:Glacier2/Glacier2.h"]]
+[["cpp:header-ext:h"]]
+
+[["cpp:include:Glacier2/Config.h"]]
+
+[["js:module:@zeroc/ice"]]
+
+#include "Ice/BuiltinSequences.ice"
+#include "Ice/Identity.ice"
+#include "SSLInfo.ice"
+
+["java:identifier:com.zeroc.Glacier2"]
+module Glacier2
+{
+    interface Router; // So that doc-comments can link to `Glacier2::Router`.
+
+    /// The exception that is thrown when an attempt to create a new session fails.
+    exception CannotCreateSessionException
+    {
+        /// The reason why the session creation failed.
+        string reason;
+    }
+
+    /// Represents a session between a client application and the Glacier2 router. With Glacier2, the lifetime of a
+    /// session is tied to the Ice connection between the client and the router: the session is destroyed when the
+    /// connection is closed.
+    /// @see Router
+    /// @see SessionManager
+    interface Session
+    {
+        /// Destroys this session.
+        void destroy();
+    }
+
+    /// Manages a set of constraints on a {@link Session}.
+    /// @see SessionControl
+    interface StringSet
+    {
+        /// Adds a sequence of strings to this set of constraints. Order is not preserved and duplicates are implicitly
+        /// removed.
+        /// @param additions The sequence of strings to add.
+        idempotent void add(Ice::StringSeq additions);
+
+        /// Removes a sequence of strings from this set of constraints. No errors are returned if an entry is not found.
+        /// @param deletions The sequence of strings to remove.
+        idempotent void remove(Ice::StringSeq deletions);
+
+        /// Gets a sequence of strings describing the constraints in this set.
+        /// @return The sequence of strings for this set.
+        ["swift:identifier:`get`"]
+        idempotent Ice::StringSeq get();
+    }
+
+    /// Manages a set of object identity constraints on a {@link Session}.
+    /// @see SessionControl
+    interface IdentitySet
+    {
+        /// Adds a sequence of Ice identities to this set of constraints. Order is not preserved and duplicates are
+        /// implicitly removed.
+        /// @param additions The sequence of Ice identities to add.
+        idempotent void add(Ice::IdentitySeq additions);
+
+        /// Removes a sequence of identities from this set of constraints. No errors are returned if an entry is not
+        /// found.
+        /// @param deletions The sequence of Ice identities to remove.
+        idempotent void remove(Ice::IdentitySeq deletions);
+
+        /// Gets a sequence of identities describing the constraints in this set.
+        /// @return The sequence of Ice identities for this set.
+        ["swift:identifier:`get`"]
+        idempotent Ice::IdentitySeq get();
+    }
+
+    /// Represents a router-provided object that allows an application-provided session manager to configure the
+    /// routing constraints for a session.
+    /// @see SessionManager
+    interface SessionControl
+    {
+        /// Gets a proxy to the object that manages the allowable categories for object identities for this session.
+        /// @return A proxy to a {@link StringSet} object. This proxy is never null.
+        StringSet* categories();
+
+        /// Gets a proxy to the object that manages the allowable adapter identities for objects for this session.
+        /// @return A proxy to a {@link StringSet} object. This proxy is never null.
+        StringSet* adapterIds();
+
+        /// Gets a proxy to the object that manages the allowable object identities for this session.
+        /// @return A proxy to an {@link IdentitySet} object. This proxy is never null.
+        IdentitySet* identities();
+
+        /// Gets the session timeout.
+        /// @return The timeout.
+        idempotent int getSessionTimeout();
+
+        /// Destroys the associated session.
+        void destroy();
+    }
+
+    /// Represents an application-provided factory for session objects. You can configure a Glacier2 router with your
+    /// own SessionManager implementation; this router will then return the sessions created by this session manager to
+    /// its clients.
+    interface SessionManager
+    {
+        /// Creates a new session object.
+        /// @param userId The user ID for the session.
+        /// @param control A proxy to the session control object. This proxy is null when `Glacier2.Server.Endpoints`
+        /// is not configured.
+        /// @return A proxy to the newly created session. This proxy is never null.
+        /// @throws CannotCreateSessionException Thrown when the session cannot be created.
+        Session* create(string userId, SessionControl* control)
+            throws CannotCreateSessionException;
+    }
+
+    /// Represents an application-provided factory for session objects. You can configure a Glacier2 router with your
+    /// own SSLSessionManager implementation; this router will then return the sessions created by this session manager
+    /// to its clients.
+    interface SSLSessionManager
+    {
+        /// Creates a new session object.
+        /// @param info The SSL info.
+        /// @param control A proxy to the session control object. This proxy is null when `Glacier2.Server.Endpoints`
+        /// is not configured.
+        /// @return A proxy to the newly created session. This proxy is never null.
+        /// @throws CannotCreateSessionException Thrown when the session cannot be created.
+        Session* create(SSLInfo info, SessionControl* control)
+            throws CannotCreateSessionException;
+    }
+}

slice/Ice/BuiltinSequences.ice

@@ -1,59 +1,54 @@
-//
-// 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 sequence of bools. **/
-sequence<bool> BoolSeq;
-
-/** A sequence of bytes. **/
-sequence<byte> ByteSeq;
-
-/** A sequence of shorts. **/
-sequence<short> ShortSeq;
-
-/** A sequence of ints. **/
-sequence<int> IntSeq;
-
-/** A sequence of longs. **/
-sequence<long> LongSeq;
-
-/** A sequence of floats. **/
-sequence<float> FloatSeq;
-
-/** A sequence of doubles. **/
-sequence<double> DoubleSeq;
-
-/** A sequence of strings. **/
-sequence<string> StringSeq;
-
-/** A sequence of objects. **/
-sequence<Object> ObjectSeq;
-
-/** A sequence of object proxies. **/
-sequence<Object*> ObjectProxySeq;
-
-}
+// 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/ObjectF.h"]]
+[["cpp:include:Ice/ProxyF.h"]]
+[["cpp:include:Ice/ValueF.h"]]
+[["cpp:include:cstdint"]]
+[["cpp:include:optional"]]
+[["cpp:include:string"]]
+[["cpp:include:vector"]]
+
+[["js:module:@zeroc/ice"]]
+
+["java:identifier:com.zeroc.Ice"]
+module Ice
+{
+    /// A sequence of bools.
+    sequence<bool> BoolSeq;
+
+    /// A sequence of bytes.
+    sequence<byte> ByteSeq;
+
+    /// A sequence of shorts.
+    sequence<short> ShortSeq;
+
+    /// A sequence of ints.
+    sequence<int> IntSeq;
+
+    /// A sequence of longs.
+    sequence<long> LongSeq;
+
+    /// A sequence of floats.
+    sequence<float> FloatSeq;
+
+    /// A sequence of doubles.
+    sequence<double> DoubleSeq;
+
+    /// A sequence of strings.
+    sequence<string> StringSeq;
+
+    /// A sequence of class instances.
+    ["deprecated:Define your own sequence instead and avoid using the term `object` to designate a class instance."]
+    sequence<Value> ObjectSeq;
+
+    /// A sequence of object proxies.
+    sequence<Object*> ObjectProxySeq;
+}

slice/Ice/Context.ice

@@ -0,0 +1,24 @@
+// 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
+{
+    /// Represents additional information carried by an Ice request. This information is filled in by the application
+    /// and transmitted by Ice as-is, from the client to the server.
+    /// @remark The Ice protocol provides request contexts but does not provide response contexts.
+    ["cpp:type:std::map<std::string, std::string, std::less<>>"]
+    dictionary<string, string> Context;
+}