zeroc-ice 3.7.11__cp313-cp313-macosx_10_13_universal2.whl

IceStorm/Metrics_ice.py

@@ -0,0 +1,106 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (c) ZeroC, Inc. All rights reserved.
+#
+#
+# Ice version 3.7.11
+#
+# <auto-generated>
+#
+# Generated from file `Metrics.ice'
+#
+# Warning: do not edit this file.
+#
+# </auto-generated>
+#
+
+from sys import version_info as _version_info_
+import Ice, IcePy
+import Ice.Metrics_ice
+
+# Included module Ice
+_M_Ice = Ice.openModule('Ice')
+
+# Included module IceMX
+_M_IceMX = Ice.openModule('IceMX')
+
+# Start of module IceMX
+__name__ = 'IceMX'
+
+if 'TopicMetrics' not in _M_IceMX.__dict__:
+    _M_IceMX.TopicMetrics = Ice.createTempClass()
+    class TopicMetrics(_M_IceMX.Metrics):
+        """
+        Provides information on IceStorm topics.
+        Members:
+        published -- Number of events published on the topic by publishers.
+        forwarded -- Number of events forwarded on the topic by IceStorm topic links.
+        """
+        def __init__(self, id='', total=0, current=0, totalLifetime=0, failures=0, published=0, forwarded=0):
+            _M_IceMX.Metrics.__init__(self, id, total, current, totalLifetime, failures)
+            self.published = published
+            self.forwarded = forwarded
+
+        def ice_id(self):
+            return '::IceMX::TopicMetrics'
+
+        @staticmethod
+        def ice_staticId():
+            return '::IceMX::TopicMetrics'
+
+        def __str__(self):
+            return IcePy.stringify(self, _M_IceMX._t_TopicMetrics)
+
+        __repr__ = __str__
+
+    _M_IceMX._t_TopicMetrics = IcePy.defineValue('::IceMX::TopicMetrics', TopicMetrics, -1, (), False, False, _M_IceMX._t_Metrics, (
+        ('published', (), IcePy._t_long, False, 0),
+        ('forwarded', (), IcePy._t_long, False, 0)
+    ))
+    TopicMetrics._ice_type = _M_IceMX._t_TopicMetrics
+
+    _M_IceMX.TopicMetrics = TopicMetrics
+    del TopicMetrics
+
+if 'SubscriberMetrics' not in _M_IceMX.__dict__:
+    _M_IceMX.SubscriberMetrics = Ice.createTempClass()
+    class SubscriberMetrics(_M_IceMX.Metrics):
+        """
+        Provides information on IceStorm subscribers.
+        Members:
+        queued -- Number of queued events.
+        outstanding -- Number of outstanding events.
+        delivered -- Number of forwarded events.
+        """
+        def __init__(self, id='', total=0, current=0, totalLifetime=0, failures=0, queued=0, outstanding=0, delivered=0):
+            _M_IceMX.Metrics.__init__(self, id, total, current, totalLifetime, failures)
+            self.queued = queued
+            self.outstanding = outstanding
+            self.delivered = delivered
+
+        def ice_id(self):
+            return '::IceMX::SubscriberMetrics'
+
+        @staticmethod
+        def ice_staticId():
+            return '::IceMX::SubscriberMetrics'
+
+        def __str__(self):
+            return IcePy.stringify(self, _M_IceMX._t_SubscriberMetrics)
+
+        __repr__ = __str__
+
+    _M_IceMX._t_SubscriberMetrics = IcePy.defineValue('::IceMX::SubscriberMetrics', SubscriberMetrics, -1, (), False, False, _M_IceMX._t_Metrics, (
+        ('queued', (), IcePy._t_int, False, 0),
+        ('outstanding', (), IcePy._t_int, False, 0),
+        ('delivered', (), IcePy._t_long, False, 0)
+    ))
+    SubscriberMetrics._ice_type = _M_IceMX._t_SubscriberMetrics
+
+    _M_IceMX.SubscriberMetrics = SubscriberMetrics
+    del SubscriberMetrics
+
+# End of module IceMX
+
+Ice.sliceChecksums["::IceMX::SubscriberMetrics"] = "ab5eddbb2d0449f94b4808b6cf92552"
+Ice.sliceChecksums["::IceMX::TopicMetrics"] = "afc516f773371c41f4f612d9e9629c"

IceStorm/__init__.py

@@ -0,0 +1,10 @@
+# Generated by slice2py - DO NOT EDIT!
+#
+
+import Ice
+Ice.updateModule("IceStorm")
+
+# Modules:
+import IceStorm.IceStorm_ice
+
+# Submodules:

slice/Glacier2/Metrics.ice

@@ -0,0 +1,88 @@
+//
+// 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"]]
+
+[["ice-prefix"]]
+
+[["js:module:ice"]]
+
+[["objc:dll-export:GLACIER2_API"]]
+[["objc:header-dir:objc"]]
+
+[["python:pkgdir:Glacier2"]]
+
+#include <Ice/Metrics.ice>
+
+#ifndef __SLICE2JAVA_COMPAT__
+[["java:package:com.zeroc"]]
+#endif
+
+["objc:prefix:ICEMX", "swift:module:Glacier2:MX"]
+module IceMX
+{
+
+/**
+ *
+ * Provides information on Glacier2 sessions.
+ *
+ **/
+class SessionMetrics extends Metrics
+{
+    /**
+     *
+     * Number of client requests forwared.
+     *
+     **/
+    int forwardedClient = 0;
+
+    /**
+     *
+     * Number of server requests forwared.
+     *
+     **/
+    int forwardedServer = 0;
+
+    /**
+     *
+     * The size of the routing table.
+     *
+     **/
+    int routingTableSize = 0;
+
+    /**
+     *
+     * Number of client requests queued.
+     *
+     **/
+    int queuedClient = 0;
+
+    /**
+     *
+     * Number of server requests queued.
+     *
+     **/
+    int queuedServer = 0;
+
+    /**
+     *
+     * Number of client requests overridden.
+     *
+     **/
+    int overriddenClient = 0;
+
+    /**
+     *
+     * Number of server requests overridden.
+     *
+     **/
+    int overriddenServer = 0;
+}
+
+}

slice/Glacier2/PermissionsVerifier.ice

@@ -0,0 +1,111 @@
+//
+// 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 <Glacier2/SSLInfo.ice>
+
+#ifndef __SLICE2JAVA_COMPAT__
+[["java:package:com.zeroc"]]
+#endif
+
+["objc:prefix:GLACIER2"]
+module Glacier2
+{
+
+/**
+ *
+ * This exception is raised if a client is denied the ability to create
+ * a session with the router.
+ *
+ **/
+["preserve-slice"]
+exception PermissionDeniedException
+{
+    /**
+     *
+     * The reason why permission was denied.
+     *
+     **/
+    string reason;
+}
+
+/**
+ *
+ * The Glacier2 permissions verifier. This is called through the
+ * process of establishing a session.
+ *
+ * @see Router
+ *
+ **/
+interface PermissionsVerifier
+{
+    /**
+     *
+     * Check whether a user has permission to access the router.
+     *
+     * @param userId The user id for which to check permission.
+     *
+     * @param password The user's password.
+     *
+     * @param reason The reason why access was denied.
+     *
+     * @return True if access is granted, or false otherwise.
+     *
+     * @throws PermissionDeniedException Raised if the user access is
+     * denied. This can be raised in place of returning false with a
+     * reason set in the reason out parameter.
+     *
+     **/
+    ["nonmutating", "cpp:const", "format:sliced"]
+    idempotent bool checkPermissions(string userId, string password, out string reason)
+        throws PermissionDeniedException;
+}
+
+/**
+ *
+ * The SSL Glacier2 permissions verifier. This is called through the
+ * process of establishing a session.
+ *
+ * @see Router
+ *
+ **/
+interface SSLPermissionsVerifier
+{
+    /**
+     *
+     * Check whether a user has permission to access the router.
+     *
+     * @param info The SSL information.
+     *
+     * @param reason The reason why access was denied.
+     *
+     * @return True if access is granted, or false otherwise.
+     *
+     * @throws PermissionDeniedException Raised if the user access is
+     * denied. This can be raised in place of returning false with a
+     * reason set in the reason out parameter.
+     *
+     * @see SSLInfo
+     *
+     **/
+    ["nonmutating", "cpp:const", "format:sliced"]
+    idempotent bool authorize(SSLInfo info, out string reason)
+        throws PermissionDeniedException;
+}
+
+}

slice/Glacier2/PermissionsVerifierF.ice

@@ -0,0 +1,30 @@
+//
+// Copyright (c) ZeroC, Inc. All rights reserved.
+//
+
+#pragma once
+
+[["cpp:dll-export:GLACIER2_API"]]
+[["cpp:doxygen:include:Glacier2/Glacier2.h"]]
+[["cpp:header-ext:h"]]
+
+[["js:module:ice"]]
+[["js:cjs-module"]]
+
+[["objc:dll-export:GLACIER2_API"]]
+[["objc:header-dir:objc"]]
+
+[["python:pkgdir:Glacier2"]]
+
+#ifndef __SLICE2JAVA_COMPAT__
+[["java:package:com.zeroc"]]
+#endif
+
+["objc:prefix:GLACIER2"]
+module Glacier2
+{
+
+interface PermissionsVerifier;
+interface SSLPermissionsVerifier;
+
+}

slice/Glacier2/Router.ice

@@ -0,0 +1,186 @@
+//
+// 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/Router.ice>
+#include <Glacier2/Session.ice>
+#include <Glacier2/PermissionsVerifier.ice>
+
+#ifndef __SLICE2JAVA_COMPAT__
+[["java:package:com.zeroc"]]
+#endif
+
+/**
+ *
+ * Glacier2 is a firewall solution for Ice. Glacier2 authenticates
+ * and filters client requests and allows callbacks to the client in a
+ * secure fashion. In combination with IceSSL, Glacier2 provides a
+ * security solution that is both non-intrusive and easy to configure.
+ *
+ **/
+["objc:prefix:GLACIER2"]
+module Glacier2
+{
+
+/**
+ *
+ * This exception is raised if a client tries to destroy a session
+ * with a router, but no session exists for the client.
+ *
+ * @see Router#destroySession
+ *
+ **/
+exception SessionNotExistException
+{
+}
+
+/**
+ *
+ * The Glacier2 specialization of the <code>Ice::Router</code> interface.
+ *
+ **/
+interface Router extends Ice::Router
+{
+    /**
+     *
+     * This category must be used in the identities of all of the client's
+     * callback objects. This is necessary in order for the router to
+     * forward callback requests to the intended client. If the Glacier2
+     * server endpoints are not set, the returned category is an empty
+     * string.
+     *
+     * @return The category.
+     *
+     **/
+    ["nonmutating", "cpp:const"] idempotent string getCategoryForClient();
+
+    /**
+     *
+     * Create a per-client session with the router. If a
+     * {@link SessionManager} has been installed, a proxy to a {@link Session}
+     * object is returned to the client. Otherwise, null is returned
+     * and only an internal session (i.e., not visible to the client)
+     * is created.
+     *
+     * If a session proxy is returned, it must be configured to route
+     * through the router that created it. This will happen automatically
+     * if the router is configured as the client's default router at the
+     * time the session proxy is created in the client process, otherwise
+     * the client must configure the session proxy explicitly.
+     *
+     * @see Session
+     * @see SessionManager
+     * @see PermissionsVerifier
+     *
+     * @return A proxy for the newly created session, or null if no
+     * {@link SessionManager} has been installed.
+     *
+     * @param userId The user id for which to check the password.
+     *
+     * @param password The password for the given user id.
+     *
+     * @throws PermissionDeniedException Raised if the password for
+     * the given user id is not correct, or if the user is not allowed
+     * access.
+     *
+     * @throws CannotCreateSessionException Raised if the session
+     * cannot be created.
+     *
+     **/
+    ["amd", "format:sliced"] Session* createSession(string userId, string password)
+        throws PermissionDeniedException, CannotCreateSessionException;
+
+    /**
+     *
+     * Create a per-client session with the router. The user is
+     * authenticated through the SSL certificates that have been
+     * associated with the connection. If a {@link SessionManager} has been
+     * installed, a proxy to a {@link Session} object is returned to the
+     * client. Otherwise, null is returned and only an internal
+     * session (i.e., not visible to the client) is created.
+     *
+     * If a session proxy is returned, it must be configured to route
+     * through the router that created it. This will happen automatically
+     * if the router is configured as the client's default router at the
+     * time the session proxy is created in the client process, otherwise
+     * the client must configure the session proxy explicitly.
+     *
+     * @see Session
+     * @see SessionManager
+     * @see PermissionsVerifier
+     *
+     * @return A proxy for the newly created session, or null if no
+     * {@link SessionManager} has been installed.
+     *
+     * @throws PermissionDeniedException Raised if the user cannot be
+     * authenticated or if the user is not allowed access.
+     *
+     * @throws CannotCreateSessionException Raised if the session
+     * cannot be created.
+     *
+     **/
+    ["amd", "format:sliced"] Session* createSessionFromSecureConnection()
+        throws PermissionDeniedException, CannotCreateSessionException;
+
+    /**
+     *
+     * Keep the calling client's session with this router alive.
+     *
+     * @throws SessionNotExistException Raised if no session exists
+     * for the calling client.
+     *
+     **/
+    ["amd"] void refreshSession()
+        throws SessionNotExistException;
+
+    /**
+     *
+     * Destroy the calling client's session with this router.
+     *
+     * @throws SessionNotExistException Raised if no session exists
+     * for the calling client.
+     *
+     **/
+    void destroySession()
+        throws SessionNotExistException;
+
+    /**
+     *
+     * Get the value of the session timeout. Sessions are destroyed
+     * if they see no activity for this period of time.
+     *
+     * @return The timeout (in seconds).
+     *
+     **/
+    ["nonmutating", "cpp:const"] idempotent long getSessionTimeout();
+
+    /**
+     *
+     * Get the value of the ACM timeout. Clients supporting connection
+     * heartbeats can enable them instead of explicitly sending keep
+     * alives requests.
+     *
+     * NOTE: This method is only available since Ice 3.6.
+     *
+     * @return The timeout (in seconds).
+     *
+     **/
+    ["nonmutating", "cpp:const"] idempotent int getACMTimeout();
+}
+
+}

slice/Glacier2/RouterF.ice

@@ -0,0 +1,29 @@
+//
+// Copyright (c) ZeroC, Inc. All rights reserved.
+//
+
+#pragma once
+
+[["cpp:dll-export:GLACIER2_API"]]
+[["cpp:doxygen:include:Glacier2/Glacier2.h"]]
+[["cpp:header-ext:h"]]
+
+[["js:module:ice"]]
+[["js:cjs-module"]]
+
+[["objc:dll-export:GLACIER2_API"]]
+[["objc:header-dir:objc"]]
+
+[["python:pkgdir:Glacier2"]]
+
+#ifndef __SLICE2JAVA_COMPAT__
+[["java:package:com.zeroc"]]
+#endif
+
+["objc:prefix:GLACIER2"]
+module Glacier2
+{
+
+interface Router;
+
+}

slice/Glacier2/SSLInfo.ice

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