zeroc-ice 3.6.5 → 3.7.4

data/slice/Ice/CommunicatorF.ice

@@ -1,15 +1,25 @@
-// **********************************************************************
 //
-// Copyright (c) 2003-2018 ZeroC, Inc. All rights reserved.
+// Copyright (c) ZeroC, Inc. All rights reserved.
 //
-// This copy of Ice is licensed to you under the terms described in the
-// ICE_LICENSE file included in this distribution.
-//
-// **********************************************************************
 
 #pragma once
 
-[["cpp:header-ext:h", "objc:header-dir:objc"]]
+[["cpp:dll-export:ICE_API"]]
+[["cpp:doxygen:include:Ice/Ice.h"]]
+[["cpp:header-ext:h"]]
+
+[["ice-prefix"]]
+
+[["js:module:ice"]]
+
+[["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
@@ -17,5 +27,4 @@ module Ice
 
 local interface Communicator;
 
-};
-
+}

data/slice/Ice/Connection.ice

@@ -1,31 +1,74 @@
-
-// **********************************************************************
-//
-// Copyright (c) 2003-2018 ZeroC, Inc. All rights reserved.
 //
-// This copy of Ice is licensed to you under the terms described in the
-// ICE_LICENSE file included in this distribution.
+// Copyright (c) ZeroC, Inc. All rights reserved.
 //
-// **********************************************************************
 
 #pragma once
 
-[["cpp:header-ext:h", "objc:header-dir:objc", "js:ice-build"]]
+[["cpp:dll-export:ICE_API"]]
+[["cpp:doxygen:include:Ice/Ice.h"]]
+[["cpp:header-ext:h"]]
+
+[["ice-prefix"]]
+
+[["js:module:ice"]]
+
+[["objc:dll-export:ICE_API"]]
+[["objc:header-dir:objc"]]
+
+[["python:pkgdir:Ice"]]
 
 #include <Ice/ObjectAdapterF.ice>
 #include <Ice/Identity.ice>
 #include <Ice/Endpoint.ice>
 
+#ifndef __SLICE2JAVA_COMPAT__
+[["java:package:com.zeroc"]]
+#endif
+
 ["objc:prefix:ICE"]
 module Ice
 {
 
 /**
+ * The batch compression option when flushing queued batch requests.
+ *
+ **/
+["cpp:scoped", "objc:scoped"]
+local enum CompressBatch
+{
+    /**
+     * Compress the batch requests.
+     **/
+    Yes,
+
+    /**
+     * Don't compress the batch requests.
+     **/
+    No,
+
+    /**
+     * Compress the batch requests if at least one request was
+     * made on a compressed proxy.
+     **/
+    BasedOnProxy
+}
+
+#if !defined(__SLICE2PHP__) && !defined(__SLICE2MATLAB__)
+/**
+ *
+ * Base class providing access to the connection details.
  *
- * Base class providing access to the connection details. *
  **/
 local class ConnectionInfo
 {
+    /**
+     *
+     * The information of the underyling transport or null if there's
+     * no underlying transport.
+     *
+     **/
+    ConnectionInfo underlying;
+
     /**
      *
      * Whether or not the connection is an incoming or outgoing
@@ -47,33 +90,43 @@ local class ConnectionInfo
      *
      **/
     string connectionId;
+}
+#endif
 
-    /**
-     *
-     * The connection buffer receive size.
-     *
-     **/
-    int rcvSize;
+local interface Connection;
 
+/**
+ *
+ * An application can implement this interface to receive notifications when
+ * a connection closes.
+ *
+ * @see Connection#setCloseCallback
+ *
+ **/
+["delegate"]
+local interface CloseCallback
+{
     /**
      *
-     * The connection buffer send size.
+     * This method is called by the the connection when the connection
+     * is closed. If the callback needs more information about the closure,
+     * it can call {@link Connection#throwException}.
      *
+     * @param con The connection that closed.
      **/
-    int sndSize;
-};
-
-local interface Connection;
+    ["swift:noexcept"] void closed(Connection con);
+}
 
 /**
  *
  * An application can implement this interface to receive notifications when
- * a connection closes or receives a heartbeat message.
+ * a connection receives a heartbeat message.
  *
- * @see Connection#setCallback
+ * @see Connection#setHeartbeatCallback
  *
  **/
-local interface ConnectionCallback
+["delegate"]
+local interface HeartbeatCallback
 {
     /**
      *
@@ -81,20 +134,9 @@ local interface ConnectionCallback
      * received from the peer.
      *
      * @param con The connection on which a heartbeat was received.
-     *
-     **/
-    void heartbeat(Connection con);
-
-    /**
-     *
-     * This method is called by the the connection when the connection
-     * is closed.
-     *
-     * @param con The connection that closed.
-     *
      **/
-    void closed(Connection con);
-};
+    ["swift:noexcept"] void heartbeat(Connection con);
+}
 
 /**
  * Specifies the close semantics for Active Connection Management.
@@ -117,7 +159,7 @@ local enum ACMClose
      * regardless of whether the connection has pending invocations or dispatch.
      */
     CloseOnIdleForceful
-};
+}
 
 /**
  * Specifies the heartbeat semantics for Active Connection Management.
@@ -127,12 +169,12 @@ local enum ACMHeartbeat
     /** Disables heartbeats. */
     HeartbeatOff,
     /** Send a heartbeat at regular intervals if the connection is idle and only if there are pending dispatch. */
-    HeartbeatOnInvocation,
+    HeartbeatOnDispatch,
     /** Send a heartbeat at regular intervals when the connection is idle. */
     HeartbeatOnIdle,
     /** Send a heartbeat at regular intervals until the connection is closed. */
     HeartbeatAlways
-};
+}
 
 /**
  * A collection of Active Connection Management configuration settings.
@@ -145,28 +187,48 @@ local struct ACM
     ACMClose close;
     /** The heartbeat semantics. */
     ACMHeartbeat heartbeat;
-};
+}
 
+/**
+ * Determines the behavior when manually closing a connection.
+ **/
+["cpp:scoped", "objc:scoped"]
+local enum ConnectionClose
+{
+    /**
+     * Close the connection immediately without sending a close connection protocol message to the peer
+     * and waiting for the peer to acknowledge it.
+     **/
+    Forcefully,
+    /**
+     * Close the connection by notifying the peer but do not wait for pending outgoing invocations to complete.
+     * On the server side, the connection will not be closed until all incoming invocations have completed.
+     **/
+    Gracefully,
+    /**
+     * Wait for all pending invocations to complete before closing the connection.
+     **/
+    GracefullyWithWait
+}
+
+#if !defined(__SLICE2PHP__) && !defined(__SLICE2MATLAB__)
 /**
  *
  * The user-level interface to a connection.
  *
  **/
+["swift:inherits:Swift.CustomStringConvertible"]
 local interface Connection
 {
     /**
      *
-     * Close a connection, either gracefully or forcefully. If a
-     * connection is closed forcefully, it closes immediately, without
-     * sending the relevant close connection protocol messages to the
-     * peer and waiting for the peer to acknowledge these protocol
-     * messages.
+     * Manually close the connection using the specified closure mode.
      *
-     * @param force If true, close forcefully. Otherwise the
-     * connection is closed gracefully.
+     * @param mode Determines how the connection will be closed.
      *
+     * @see ConnectionClose
      **/
-    void close(bool force);
+    ["cpp:noexcept", "js:async"] void close(ConnectionClose mode);
 
     /**
      *
@@ -184,7 +246,7 @@ local interface Connection
      *
      * @see #setAdapter
      **/
-    ["cpp:const"] Object* createProxy(Identity id);
+    ["cpp:const", "swift:nonnull"] Object* createProxy(Identity id);
 
     /**
      *
@@ -199,10 +261,11 @@ local interface Connection
      * @param adapter The object adapter that should be used by this
      * connection to dispatch requests. The object adapter must be
      * activated. When the object adapter is deactivated, it is
-     * automatically removed from the connection.
+     * automatically removed from the connection. Attempts to use a
+     * deactivated object adapter raise {@link ObjectAdapterDeactivatedException}
      *
      * @see #createProxy
-     * @see #setAdapter
+     * @see #getAdapter
      *
      **/
     void setAdapter(ObjectAdapter adapter);
@@ -218,7 +281,7 @@ local interface Connection
      * @see #setAdapter
      *
      **/
-    ["cpp:const"] ObjectAdapter getAdapter();
+    ["cpp:const", "cpp:noexcept", "swift:noexcept"] ObjectAdapter getAdapter();
 
     /**
      *
@@ -227,7 +290,7 @@ local interface Connection
      * @return The endpoint from which the connection was created.
      *
      **/
-    ["cpp:const"] Endpoint getEndpoint();
+    ["cpp:const", "cpp:noexcept", "swift:noexcept", "swift:nonnull"] Endpoint getEndpoint();
 
     /**
      *
@@ -235,32 +298,54 @@ local interface Connection
      * This means all batch requests invoked on fixed proxies
      * associated with the connection.
      *
+     * @param compress Specifies whether or not the queued batch requests
+     * should be compressed before being sent over the wire.
+     *
      **/
-    ["async"] void flushBatchRequests();
+    ["async-oneway"] void flushBatchRequests(CompressBatch compress);
 
     /**
      *
-     * Set callback on the connection. The callback is called by the
+     * Set 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.
+     * Ice thread pool associated with the connection. If the callback needs
+     * more information about the closure, it can call {@link Connection#throwException}.
+     *
+     * @param callback The close callback object.
+     *
+     **/
+    void setCloseCallback(CloseCallback callback);
+
+    /**
+     *
+     * Set a heartbeat callback on the connection. The callback is called by the
+     * connection when a heartbeat is received. The callback is called
+     * from the Ice thread pool associated with the connection.
      *
-     * @param callback The connection callback object.
+     * @param callback The heartbeat callback object.
      *
      **/
-    void setCallback(ConnectionCallback callback);
+    ["swift:noexcept"] void setHeartbeatCallback(HeartbeatCallback callback);
+
+    /**
+     *
+     * Send a heartbeat message.
+     *
+     **/
+    ["async-oneway"] void heartbeat();
 
     /**
      *
      * Set the active connection management parameters.
      *
-     * @param timeout The timeout value in seconds.
+     * @param timeout The timeout value in seconds, must be &gt;= 0.
      *
      * @param close The close condition
      *
      * @param heartbeat The hertbeat condition
      *
      **/
-    ["java:optional"]
+    ["swift:noexcept", "java:optional"]
     void setACM(optional(1) int timeout, optional(2) ACMClose close, optional(3) ACMHeartbeat heartbeat);
 
     /**
@@ -270,7 +355,7 @@ local interface Connection
      * @return The ACM parameters.
      *
      **/
-    ACM getACM();
+    ["cpp:noexcept", "swift:noexcept"] ACM getACM();
 
     /**
      *
@@ -280,7 +365,7 @@ local interface Connection
      * @return The type of the connection.
      *
      **/
-    ["cpp:const"] string type();
+    ["cpp:const", "cpp:noexcept", "swift:noexcept"] string type();
 
     /**
      *
@@ -289,7 +374,7 @@ local interface Connection
      * @return The connection's timeout.
      *
      **/
-    ["cpp:const"] int timeout();
+    ["cpp:const", "cpp:noexcept", "swift:noexcept"] int timeout();
 
     /**
      *
@@ -300,7 +385,7 @@ local interface Connection
      * text.
      *
      **/
-    ["cpp:const"] string toString();
+    ["cpp:const", "cpp:noexcept", "swift:noexcept"] string toString();
 
     /**
      *
@@ -309,18 +394,29 @@ local interface Connection
      * @return The connection information.
      *
      **/
-    ["cpp:const"] ConnectionInfo getInfo();
+    ["cpp:const", "swift:nonnull"] ConnectionInfo getInfo();
 
     /**
      *
-     * Set the connectiion buffer receive/send size.
+     * Set the connection buffer receive/send size.
      *
      * @param rcvSize The connection receive buffer size.
      * @param sndSize The connection send buffer size.
      *
      **/
     void setBufferSize(int rcvSize, int sndSize);
-};
+
+    /**
+     *
+     * Throw an exception indicating the reason for connection closure. For example,
+     * {@link CloseConnectionException} is raised if the connection was closed gracefully,
+     * whereas {@link ConnectionManuallyClosedException} is raised if the connection was
+     * manually closed by the application. This operation does nothing if the connection is
+     * not yet closed.
+     *
+     **/
+    ["cpp:const"] void throwException();
+}
 
 /**
  *
@@ -340,7 +436,7 @@ local class IPConnectionInfo extends ConnectionInfo
 
     /** The remote port. */
     int remotePort = -1;
-};
+}
 
 /**
  *
@@ -349,7 +445,20 @@ local class IPConnectionInfo extends ConnectionInfo
  **/
 local class TCPConnectionInfo extends IPConnectionInfo
 {
-};
+    /**
+     *
+     * The connection buffer receive size.
+     *
+     **/
+    int rcvSize = 0;
+
+    /**
+     *
+     * The connection buffer send size.
+     *
+     **/
+    int sndSize = 0;
+}
 
 /**
  *
@@ -358,12 +467,34 @@ local class TCPConnectionInfo extends IPConnectionInfo
  **/
 local class UDPConnectionInfo extends IPConnectionInfo
 {
-    /** The multicast address. */
+    /**
+     *
+     * The multicast address.
+     *
+     **/
     string mcastAddress;
 
-    /** The multicast port. */
+    /**
+     *
+     * The multicast port.
+     *
+     **/
     int mcastPort = -1;
-};
+
+    /**
+     *
+     * The connection buffer receive size.
+     *
+     **/
+    int rcvSize = 0;
+
+    /**
+     *
+     * The connection buffer send size.
+     *
+     **/
+    int sndSize = 0;
+}
 
 /** A collection of HTTP headers. */
 dictionary<string, string> HeaderDict;
@@ -373,10 +504,12 @@ dictionary HeaderDict;
  * Provides access to the connection details of a WebSocket connection
  *
  **/
-local class WSConnectionInfo extends TCPConnectionInfo
+local class WSConnectionInfo extends ConnectionInfo
 {
     /** The headers from the HTTP upgrade request. */
     HeaderDict headers;
-};
+}
+
+#endif
 
-};
+}