zeroc-ice 3.8.0__cp313-cp313-macosx_10_13_universal2.whl → 3.8.0.post1__cp313-cp313-macosx_10_13_universal2.whl

IcePy-stubs/__init__.pyi

@@ -22,8 +22,8 @@ class AsyncInvocationContext:
 
 class BatchRequest:
     """
-    Represents a batch request. A batch request is created by invoking an operation on a batch-oneway or
-    batch-datagram proxy.
+    Represents a batch request.
+    A batch request is created by invoking an operation on a batch-oneway or batch-datagram proxy.
     """
 
     def enqueue(self) -> None:
@@ -140,8 +140,37 @@ class Connection:
         """
         Disables the inactivity check on this connection.
 
-        By default, Ice will close connections that remain idle for a
-        certain period. This method disables that behavior for this connection.
+        By default, Ice will close connections that remain inactive for a certain period.
+        This function disables that behavior for this connection.
+        """
+        ...
+
+    def setAdapter(self, adapter: Ice.ObjectAdapter | None) -> None:
+        """
+        Associates an object adapter with this connection.
+
+        When a connection receives a request, it dispatches this request using its associated object adapter.
+        If the associated object adapter is ``None``, the connection rejects any incoming request with an
+        :class:`ObjectNotExistException`.
+
+        The default object adapter of an incoming connection is the object adapter that created this connection;
+        the default object adapter of an outgoing connection is the communicator's default object adapter.
+
+        Parameters
+        ----------
+        adapter : Ice.ObjectAdapter | None
+            The object adapter to associate with this connection.
+        """
+        ...
+
+    def getAdapter(self) -> Ice.ObjectAdapter | None:
+        """
+        Gets the object adapter associated with this connection.
+
+        Returns
+        -------
+        Ice.ObjectAdapter | None
+            The object adapter associated with this connection.
         """
         ...
 
@@ -149,14 +178,12 @@ class Connection:
         """
         Flushes any pending batch requests for this connection.
 
-        This corresponds to all batch requests invoked on fixed proxies
-        associated with the connection.
+        This corresponds to all batch requests invoked on fixed proxies associated with the connection.
 
         Parameters
         ----------
         compress : Ice.CompressBatch
-            Specifies whether or not the queued batch requests should be
-            compressed before being sent over the wire.
+            Specifies whether or not the queued batch requests should be compressed before being sent over the wire.
         """
         ...
 
@@ -167,14 +194,12 @@ class Connection:
         """
         Flushes any pending batch requests for this connection asynchronously.
 
-        This corresponds to all batch requests invoked on fixed proxies
-        associated with the connection.
+        This corresponds to all batch requests invoked on fixed proxies associated with the connection.
 
         Parameters
         ----------
         compress : Ice.CompressBatch
-            Specifies whether or not the queued batch requests should be
-            compressed before being sent over the wire.
+            Specifies whether or not the queued batch requests should be compressed before being sent over the wire.
 
         Returns
         -------
@@ -183,25 +208,41 @@ class Connection:
         """
         ...
 
-    def getAdapter(self) -> Ice.ObjectAdapter | None:
+    def setCloseCallback(self, callback: Callable[[Connection], None]) -> None:
         """
-        Gets the object adapter associated with this connection.
+        Sets a close callback on the connection. The callback is called by the connection when it's closed.
+        The callback is called from the Ice thread pool associated with the connection.
+
+        Parameters
+        ----------
+        callback : Callable[[Connection], None]
+            The close callback callable.
+        """
+        ...
+
+    def type(self) -> str:
+        """
+        Returns the connection type. This corresponds to the endpoint type, such as 'tcp', 'udp', etc.
 
         Returns
         -------
-        Ice.ObjectAdapter or None
-            The object adapter associated with this connection.
+        str
+            The type of the connection.
         """
         ...
 
-    def getEndpoint(self) -> Endpoint:
+    def toString(self) -> str:
         """
-        Gets the endpoint from which the connection was created.
+        Returns a description of the connection as human readable text, suitable for logging or error messages.
+
+        Notes
+        -----
+        This function remains usable after the connection is closed or aborted.
 
         Returns
         -------
-        Ice.Endpoint
-            The endpoint from which the connection was created.
+        str
+            The description of the connection as human readable text.
         """
         ...
 
@@ -216,18 +257,14 @@ class Connection:
         """
         ...
 
-    def setAdapter(self, adapter: Ice.ObjectAdapter | None) -> None:
+    def getEndpoint(self) -> Endpoint:
         """
-        Associates an object adapter with this connection.
-
-        When a connection receives a request, it dispatches this request using
-        its associated object adapter. If the associated object adapter is None,
-        the connection rejects any incoming request with an ObjectNotExistException.
+        Gets the endpoint from which the connection was created.
 
-        Parameters
-        ----------
-        adapter : Ice.ObjectAdapter or None
-            The object adapter to associate with this connection.
+        Returns
+        -------
+        Ice.Endpoint
+            The endpoint from which the connection was created.
         """
         ...
 
@@ -244,55 +281,12 @@ class Connection:
         """
         ...
 
-    def setCloseCallback(self, callback: Callable[[Connection], None]) -> None:
-        """
-        Sets a close callback on the connection.
-
-        The callback is called by the connection when it's closed. The callback
-        is called from the Ice thread pool associated with the connection.
-
-        Parameters
-        ----------
-        callback : Callable
-            The close callback function.
-        """
-        ...
-
     def throwException(self) -> None:
         """
-        Throws an exception that provides the reason for the closure of this connection.
-
-        For example, this function throws CloseConnectionException when the connection
-        was closed gracefully by the peer; it throws ConnectionAbortedException when
-        the connection is aborted. This function does nothing if the connection is
-        not yet closed.
-        """
-        ...
-
-    def toString(self) -> str:
-        """
-        Returns a description of the connection as human readable text.
-
-        This function is suitable for logging or error messages and remains
-        usable after the connection is closed or aborted.
-
-        Returns
-        -------
-        str
-            The description of the connection as human readable text.
-        """
-        ...
-
-    def type(self) -> str:
-        """
-        Returns the connection type.
-
-        This corresponds to the endpoint type, such as 'tcp', 'udp', etc.
-
-        Returns
-        -------
-        str
-            The type of the connection.
+        Raises an exception that provides the reason for the closure of this connection. For example,
+        this function raises :class:`CloseConnectionException` when the connection was closed gracefully by the peer;
+        it raises :class:`ConnectionAbortedException` when the connection is aborted with :func:`abort`.
+        This function does nothing if the connection is not yet closed.
         """
         ...
 
@@ -307,49 +301,51 @@ class Connection:
 class ConnectionInfo:
     """
     Base class for all connection info classes.
-
-    Connection info classes provide access to the connection details.
-    They are used to get information about the connection, such as
-    whether it's incoming or outgoing, the adapter name, and connection ID.
     """
 
     underlying: ConnectionInfo | None
-    """Ice.ConnectionInfo | None: underlying connection information"""
-
-    adapterName: str
-    """str: adapter associated with the connection"""
+    """
+    ConnectionInfo | None: The information of the underlying transport or ``None`` if there's no underlying transport.
+    """
 
     incoming: bool
-    """bool: whether connection is incoming"""
+    """bool: ``True`` if this is an incoming connection, ``False`` otherwise."""
+
+    adapterName: str
+    """str: The name of the adapter associated with the connection."""
 
 class DispatchCallback:
     def response(self, *args: tuple) -> None: ...
     def exception(self, exception: BaseException) -> None: ...
 
 class Endpoint:
-    """IcePy.Endpoint"""
+    """
+    An endpoint specifies the address of the server-end of an Ice connection.
+    An object adapter listens on one or more endpoints and a client establishes a connection to an endpoint.
+    """
 
-    def getInfo(self) -> EndpointInfo:
+    def toString(self) -> str:
         """
-        Returns the endpoint information.
+        Returns a string representation of this endpoint.
 
         Returns
         -------
-        Ice.EndpointInfo
-            The endpoint information class.
+        str
+            The string representation of this endpoint.
         """
         ...
 
-    def toString(self) -> str:
+    def getInfo(self) -> EndpointInfo:
         """
-        Returns a string representation of this endpoint.
+        Returns this endpoint's information.
 
         Returns
         -------
-        str
-            The string representation of this endpoint.
+        Ice.EndpointInfo
+            This endpoint's information class.
         """
         ...
+
     def __eq__(self, other: object) -> bool: ...
     def __ge__(self, other: object) -> bool: ...
     def __gt__(self, other: object) -> bool: ...
@@ -359,48 +355,45 @@ class Endpoint:
 
 class EndpointInfo:
     """
-    Base class for all endpoint info classes.
-
-    Provides access to the endpoint details. Endpoint info classes are used to get information about the endpoints
-    that a connection or proxy uses.
+    Base class for the endpoint info classes.
     """
 
     underlying: EndpointInfo | None
-    """Ice.EndpointInfo | None: underlying endpoint information"""
+    """The information of the underlying endpoint or ``None`` if there's no underlying endpoint."""
 
     compress: bool
-    """bool: compression status"""
+    """Specifies whether or not compression should be used if available when using this endpoint."""
 
-    def datagram(self) -> bool:
+    def type(self) -> int:
         """
-        Returns True if this endpoint's transport is a datagram transport (namely, UDP), False otherwise.
+        Returns the type of the endpoint.
 
         Returns
         -------
-        bool
-            True for a UDP endpoint, False otherwise.
+        int
+            The endpoint type.
         """
         ...
 
-    def secure(self) -> bool:
+    def datagram(self) -> bool:
         """
-        Returns True if this endpoint's transport uses SSL, False otherwise.
+        Returns whether this endpoint is a datagram endpoint (namely, UDP).
 
         Returns
         -------
         bool
-            True for SSL and SSL-based transports, False otherwise.
+            ``True`` for a UDP endpoint, ``False`` otherwise.
         """
         ...
 
-    def type(self) -> int:
+    def secure(self) -> bool:
         """
-        Returns the type of the endpoint.
+        Returns whether this endpoint uses SSL.
 
         Returns
         -------
-        int
-            The endpoint type.
+        bool
+            ``True`` for SSL and SSL-based transports, ``False`` otherwise.
         """
         ...
 
@@ -411,28 +404,28 @@ class IPConnectionInfo(ConnectionInfo):
     """Provides access to the connection details of an IP connection."""
 
     localAddress: str
-    """str: local address"""
+    """str: The local address."""
 
     localPort: int
-    """int: local port"""
+    """int: The local port."""
 
     remoteAddress: str
-    """str: remote address"""
+    """str: The remote address."""
 
     remotePort: int
-    """int: remote port"""
+    """int: The remote port."""
 
 class IPEndpointInfo(EndpointInfo):
     """Provides access to the address details of an IP endpoint."""
 
     host: str
-    """str: host name or IP address"""
+    """str: The host or address configured with the endpoint."""
 
     port: int
-    """int: TCP port number"""
+    """int: The port number."""
 
     sourceAddress: str
-    """str: source IP address"""
+    """str: The source IP address."""
 
 class ImplicitContext:
     def containsKey(self, key: str) -> bool: ...
@@ -457,7 +450,9 @@ class Logger:
     def warning(self, message: str) -> None: ...
 
 class NativePropertiesAdmin:
-    """The default implementation for the 'Properties' admin facet."""
+    """
+    The default implementation of the 'Properties' admin facet.
+    """
 
     def addUpdateCallback(self, callback: Callable[[dict[str, str]], None]) -> None:
         """
@@ -465,8 +460,8 @@ class NativePropertiesAdmin:
 
         Parameters
         ----------
-        callback : Callable
-            The callback function.
+        callback : Callable[[dict[str, str]], None]
+            The callback.
         """
         ...
 
@@ -476,8 +471,8 @@ class NativePropertiesAdmin:
 
         Parameters
         ----------
-        callback : Callable
-            The callback function to remove.
+        callback : Callable[[dict[str, str]], None]
+            The callback to remove.
         """
         ...
 
@@ -588,10 +583,10 @@ class OpaqueEndpointInfo(EndpointInfo):
     """Provides access to the details of an opaque endpoint."""
 
     rawBytes: bytes
-    """bytes: raw encoding"""
+    """bytes: The raw encoding of the opaque endpoint."""
 
     rawEncoding: Ice.EncodingVersion
-    """Ice.EncodingVersion: raw encoding version"""
+    """Ice.EncodingVersion: The encoding version of the opaque endpoint (to decode or encode the ``rawBytes``)."""
 
 class Operation:
     def __init__(
@@ -606,33 +601,33 @@ class Operation:
         return_type: Any,
         exceptions: tuple,
     ) -> None: ...
-    def deprecate(self, reason: str): ...
     def invoke(self, proxy: ObjectPrx, args: tuple) -> Any: ...
     def invokeAsync(self, proxy: ObjectPrx, args: tuple) -> Awaitable[Any]: ...
+    def deprecate(self, reason: str): ...
 
 class Properties:
-    def clone(self) -> Properties: ...
-    def getCommandLineOptions(self) -> list[str]: ...
+    def getProperty(self, key: str) -> str: ...
     def getIceProperty(self, key: str) -> str: ...
+    def getPropertyWithDefault(self, key: str, value: str) -> str: ...
+    def getPropertyAsInt(self, key: str) -> int: ...
     def getIcePropertyAsInt(self, key: str) -> int: ...
+    def getPropertyAsIntWithDefault(self, key: str, value: int) -> int: ...
+    def getPropertyAsList(self, key: str) -> list[str]: ...
     def getIcePropertyAsList(self, key: str) -> list[str]: ...
+    def getPropertyAsListWithDefault(self, key: str, value: list[str]) -> list[str]: ...
     def getPropertiesForPrefix(self, prefix: str) -> dict[str, str]: ...
-    def getProperty(self, key: str) -> str: ...
-    def getPropertyAsInt(self, key: str) -> int: ...
-    def getPropertyAsIntWithDefault(self, key: str, default: int) -> int: ...
-    def getPropertyAsList(self, key: str) -> list[str]: ...
-    def getPropertyAsListWithDefault(self, key: str, default: list[str]) -> list[str]: ...
-    def getPropertyWithDefault(self, key: str, default: str) -> str: ...
-    def load(self, file: str) -> None: ...
+    def setProperty(self, key: str, value: str) -> None: ...
+    def getCommandLineOptions(self) -> list[str]: ...
     def parseCommandLineOptions(self, prefix: str, options: list[str]) -> list[str]: ...
     def parseIceCommandLineOptions(self, options: list[str]) -> list[str]: ...
-    def setProperty(self, key: str, value: str) -> None: ...
+    def load(self, file: str) -> None: ...
+    def clone(self) -> Properties: ...
 
 class SSLConnectionInfo(ConnectionInfo):
     """Provides access to the connection details of an SSL connection."""
 
     peerCertificate: str
-    """str: peer certificate"""
+    """str: The certificate chain."""
 
 class SSLEndpointInfo(EndpointInfo):
     """Provides access to an SSL endpoint information."""
@@ -643,10 +638,10 @@ class TCPConnectionInfo(IPConnectionInfo):
     """Provides access to the connection details of a TCP connection."""
 
     rcvSize: int
-    """int: receive buffer size"""
+    """int: The size of the receive buffer."""
 
     sndSize: int
-    """int: send buffer size"""
+    """int: The size of the send buffer."""
 
 class TCPEndpointInfo(IPEndpointInfo):
     """Provides access to a TCP endpoint information."""
@@ -657,47 +652,51 @@ class UDPConnectionInfo(IPConnectionInfo):
     """Provides access to the connection details of a UDP connection."""
 
     mcastAddress: str
-    """str: multicast address"""
+    """str: The multicast address."""
 
     mcastPort: int
-    """int: multicast port"""
+    """int: The multicast port."""
 
     rcvSize: int
-    """int: receive buffer size"""
+    """int: The size of the receive buffer."""
 
     sndSize: int
-    """int: send buffer size"""
+    """int: The size of the send buffer."""
 
 class UDPEndpointInfo(IPEndpointInfo):
-    """Provides access to an UDP endpoint information."""
+    """Provides access to a UDP endpoint information."""
 
     mcastInterface: str
-    """str: multicast interface"""
+    """str: The multicast interface."""
 
     mcastTtl: int
-    """int: multicast time-to-live"""
+    """int: The multicast time-to-live (or hops)."""
 
 class WSConnectionInfo(ConnectionInfo):
     """Provides access to the connection details of a WebSocket connection."""
 
     headers: dict[str, str]
-    """dict[str, str]: request headers"""
+    """dict[str, str]: The headers from the HTTP upgrade request."""
 
 class WSEndpointInfo(EndpointInfo):
     """Provides access to a WebSocket endpoint information."""
 
     resource: str
-    """str: resource"""
+    """str: The URI configured with the endpoint."""
 
-def compileSlice(args: list[str]) -> int: ...
-def createProperties(args: list[str] | None, defaults: Ice.Properties | None): ...
 def stringVersion() -> str: ...
 def intVersion() -> int: ...
+def createProperties(args: list[str] | None = None, defaults: Ice.Properties | None = None) -> Properties: ...
+def stringToIdentity(str: str) -> Ice.Identity: ...
 def identityToString(identity: Ice.Identity, toStringMode: Ice.ToStringMode | None = None) -> str: ...
 def getProcessLogger() -> Ice.Logger: ...
 def setProcessLogger(logger: Ice.Logger) -> None: ...
+
+#
+# Functions to load/compile Slice definitions with 'slice2py'.
+#
 def loadSlice(args: list[str]) -> None: ...
-def stringToIdentity(str: str) -> Ice.Identity: ...
+def compileSlice(args: list[str]) -> int: ...
 
 #
 # Internal API for IcePy

{zeroc_ice-3.8.0.dist-info → zeroc_ice-3.8.0.post1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: zeroc-ice
-Version: 3.8.0
+Version: 3.8.0.post1
 Summary: Ice is a comprehensive RPC framework with support for Python, C++, .NET, Java, JavaScript and more.
 Author-email: "ZeroC, Inc." <info@zeroc.com>
 License-Expression: GPL-2.0-only