zeroc-ice 3.6.5 → 3.7.4

data/slice/Glacier2/Session.ice

@@ -1,21 +1,29 @@
-// **********************************************************************
 //
-// 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", "js:ice-build"]]
+[["cpp:dll-export:GLACIER2_API"]]
+[["cpp:doxygen:include:Glacier2/Glacier2.h"]]
+[["cpp:header-ext:h"]]
 [["cpp:include:Glacier2/Config.h"]]
 
+[["js:module:ice"]]
+
+[["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
 {
@@ -34,12 +42,11 @@ exception CannotCreateSessionException
      *
      **/
     string reason;
-};
+}
 
 /**
  *
- * A client-visible session object, which is tied to the lifecycle of
- * a {@link Router}.
+ * A client-visible session object, which is tied to the lifecycle of a {@link Router}.
  *
  * @see Router
  * @see SessionManager
@@ -53,7 +60,7 @@ interface Session
      *
      **/
     void destroy();
-};
+}
 
 /**
  *
@@ -96,7 +103,7 @@ interface StringSet
      *
      **/
     idempotent Ice::StringSeq get();
-};
+}
 
 /**
  *
@@ -138,7 +145,7 @@ interface IdentitySet
      *
      **/
     idempotent Ice::IdentitySeq get();
-};
+}
 
 /**
  *
@@ -195,7 +202,7 @@ interface SessionControl
      *
      **/
     void destroy();
-};
+}
 
 /**
  *
@@ -228,7 +235,7 @@ interface SessionManager
     ["format:sliced"]
     Session* create(string userId, SessionControl* control)
         throws CannotCreateSessionException;
-};
+}
 
 /**
  *
@@ -261,7 +268,6 @@ interface SSLSessionManager
     ["format:sliced"]
     Session* create(SSLInfo info, SessionControl* control)
         throws CannotCreateSessionException;
-};
-
-};
+}
 
+}

data/slice/Ice/BuiltinSequences.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", "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"]]
+
+#ifndef __SLICE2JAVA_COMPAT__
+[["java:package:com.zeroc"]]
+#endif
 
 ["objc:prefix:ICE"]
 module Ice
@@ -45,5 +55,4 @@ sequence ObjectSeq;
 /** A sequence of object proxies. **/
 sequence<Object*> ObjectProxySeq;
 
-};
-
+}

data/slice/Ice/Communicator.ice

@@ -1,27 +1,35 @@
-// **********************************************************************
 //
-// 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"]]
 
 #include <Ice/LoggerF.ice>
 #include <Ice/InstrumentationF.ice>
 #include <Ice/ObjectAdapterF.ice>
-#include <Ice/ObjectFactoryF.ice>
-#include <Ice/RouterF.ice>
-#include <Ice/LocatorF.ice>
+#include <Ice/ObjectFactory.ice>
+#include <Ice/ValueFactory.ice>
+#include <Ice/Router.ice>
+#include <Ice/Locator.ice>
 #include <Ice/PluginF.ice>
 #include <Ice/ImplicitContextF.ice>
 #include <Ice/Current.ice>
 #include <Ice/Properties.ice>
 #include <Ice/FacetMap.ice>
+#include <Ice/Connection.ice>
 
 /**
  *
@@ -32,6 +40,10 @@
  * additional functionality that supports high scalability.
  *
  **/
+#ifndef __SLICE2JAVA_COMPAT__
+[["java:package:com.zeroc"]]
+#endif
+
 ["objc:prefix:ICE"]
 module Ice
 {
@@ -45,12 +57,27 @@ module Ice
  * @see Logger
  * @see ObjectAdapter
  * @see Properties
- * @see ObjectFactory
+ * @see ValueFactory
  *
  **/
-["clr:implements:_System.IDisposable"]
+["clr:implements:global::System.IDisposable", "java:implements:java.lang.AutoCloseable"]
+
+#if !defined(__SLICE2PHP__) && !defined(__SLICE2MATLAB__)
 local interface Communicator
 {
+
+#ifdef __SLICE2JAVA__
+    /**
+     *
+     * Destroy the communicator. This Java-only method overrides close in
+     * java.lang.AutoCloseable and does not throw any exception.
+     *
+     * @see #destroy
+     *
+     **/
+    void close();
+#endif
+
     /**
      *
      * Destroy the communicator. This operation calls {@link #shutdown}
@@ -62,13 +89,13 @@ local interface Communicator
      * @see ObjectAdapter#destroy
      *
      **/
-    void destroy();
+    ["cpp:noexcept", "swift:noexcept", "js:async"] void destroy();
 
     /**
      *
      * Shuts down this communicator's server functionality, which
-     * includes the deactivation of all object adapters. Attempts to use
-     * a deactivated object adapter raise ObjectAdapterDeactivatedException.
+     * includes the deactivation of all object adapters. Attempts to use a
+     * deactivated object adapter raise ObjectAdapterDeactivatedException.
      * Subsequent calls to shutdown are ignored.
      *
      * After shutdown returns, no new requests are processed. However, requests
@@ -81,14 +108,14 @@ local interface Communicator
      * @see ObjectAdapter#deactivate
      *
      **/
-    void shutdown();
+    ["cpp:noexcept", "swift:noexcept", "js:async"] void shutdown();
 
     /**
      *
      * Wait until the application has called {@link #shutdown} (or {@link #destroy}).
      * On the server side, this operation blocks the calling thread
      * until all currently-executing operations have completed.
-     * On the client side, the operation simply block until another
+     * On the client side, the operation simply blocks until another
      * thread has called {@link #shutdown} or {@link #destroy}.
      *
      * A typical use of this operation is to call it from the main thread,
@@ -102,7 +129,7 @@ local interface Communicator
      * @see ObjectAdapter#waitForDeactivate
      *
      **/
-    void waitForShutdown();
+    ["cpp:noexcept", "swift:noexcept", "js:async"] void waitForShutdown();
 
     /**
      *
@@ -113,13 +140,13 @@ local interface Communicator
      * @see #shutdown
      *
      **/
-    ["cpp:const"] bool isShutdown();
+    ["cpp:const", "cpp:noexcept", "swift:noexcept"] bool isShutdown();
 
     /**
      *
      * Convert a stringified proxy into a proxy. For example,
-     * <tt>MyCategory/MyObject:tcp -h some_host -p
-     * 10000</tt> creates a proxy that refers to the Ice object
+     * <code>MyCategory/MyObject:tcp -h some_host -p
+     * 10000</code> creates a proxy that refers to the Ice object
      * having an identity with a name "MyObject" and a category
      * "MyCategory", with the server running on host "some_host", port
      * 10000. If the stringified proxy does not parse correctly, the
@@ -129,7 +156,7 @@ local interface Communicator
      *
      * @param str The stringified proxy to convert into a proxy.
      *
-     * @return The proxy, or nil if <tt>str</tt> is an empty string.
+     * @return The proxy, or nil if <code>str</code> is an empty string.
      *
      * @see #proxyToString
      *
@@ -143,22 +170,22 @@ local interface Communicator
      * @param obj The proxy to convert into a stringified proxy.
      *
      * @return The stringified proxy, or an empty string if
-     * <tt>obj</tt> is nil.
+     * <code>obj</code> is nil.
      *
      * @see #stringToProxy
      *
      **/
-    ["cpp:const"] string proxyToString(Object* obj);
+    ["cpp:const", "swift:noexcept"] string proxyToString(Object* obj);
 
     /**
      *
      * Convert a set of proxy properties into a proxy. The "base"
-     * name supplied in the <tt>property</tt> argument refers to a
+     * name supplied in the <code>property</code> argument refers to a
      * property containing a stringified proxy, such as
-     * <tt>MyProxy=id:tcp -h localhost -p 10000</tt>. Additional
+     * <code>MyProxy=id:tcp -h localhost -p 10000</code>. Additional
      * properties configure local settings for the proxy, such as
-     * <tt>MyProxy.PreferSecure=1</tt>. The "Properties"
-     * section in the Ice manual describes each of the supported
+     * <code>MyProxy.PreferSecure=1</code>. The "Properties"
+     * appendix in the Ice manual describes each of the supported
      * proxy properties.
      *
      * @param property The base property name.
@@ -179,8 +206,9 @@ local interface Communicator
      * @return The property set.
      *
      **/
-    ["cpp:const"] PropertyDict proxyToProperty(Object* proxy, string property);
+    ["cpp:const", "swift:noexcept"] PropertyDict proxyToProperty(["swift:nonnull"] Object* proxy, string property);
 
+#ifndef __SLICE2SWIFT__
     /**
      *
      * Convert a string into an identity. If the string does not parse
@@ -193,7 +221,9 @@ local interface Communicator
      * @see #identityToString
      *
      **/
-    ["cpp:const"] Identity stringToIdentity(string str);
+    ["cpp:const", "deprecate:stringToIdentity() is deprecated, use the static stringToIdentity() method instead."]
+    Identity stringToIdentity(string str);
+#endif
 
     /**
      *
@@ -206,12 +236,12 @@ local interface Communicator
      * @see #stringToIdentity
      *
      **/
-    ["cpp:const"] string identityToString(Identity ident);
+    ["cpp:const", "swift:noexcept"] string identityToString(Identity ident);
 
     /**
      *
      * Create a new object adapter. The endpoints for the object
-     * adapter are taken from the property <tt><em>name</em>.Endpoints</tt>.
+     * adapter are taken from the property <code><em>name</em>.Endpoints</code>.
      *
      * It is legal to create an object adapter with the empty string as
      * its name. Such an object adapter is accessible via bidirectional
@@ -230,14 +260,14 @@ local interface Communicator
      * @see Properties
      *
      **/
-    ObjectAdapter createObjectAdapter(string name);
+    ["js:async", "swift:nonnull"] ObjectAdapter createObjectAdapter(string name);
 
     /**
      *
      * Create a new object adapter with endpoints. This operation sets
-     * the property <tt><em>name</em>.Endpoints</tt>,
-     * and then calls {@link #createObjectAdapter}. It is provided as a
-     * convenience function.
+     * the property <code><em>name</em>.Endpoints</code>, and then calls
+     * {@link #createObjectAdapter}. It is provided as a convenience
+     * function.
      *
      * Calling this operation with an empty name will result in a
      * UUID being generated for the name.
@@ -253,7 +283,7 @@ local interface Communicator
      * @see Properties
      *
      **/
-    ObjectAdapter createObjectAdapterWithEndpoints(string name, string endpoints);
+    ["js:async", "swift:nonnull"] ObjectAdapter createObjectAdapterWithEndpoints(string name, string endpoints);
 
     /**
      *
@@ -274,8 +304,10 @@ local interface Communicator
      * @see Properties
      *
      **/
-    ObjectAdapter createObjectAdapterWithRouter(string name, ["objc:param:router"] Router* rtr);
+    ["js:async", "swift:nonnull"] ObjectAdapter
+    createObjectAdapterWithRouter(string name, ["objc:param:router", "swift:nonnull"] Router* rtr);
 
+#if !defined(__SLICE2SWIFT__)
     /**
      *
      * Add an object factory to this communicator. Installing a
@@ -292,10 +324,10 @@ local interface Communicator
      * If the object 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 NoObjectFactoryException.
+     * can create an instance, the run time throws NoValueFactoryException.
      *
      * If the object uses the "compact" format, Ice immediately raises
-     * NoObjectFactoryException.
+     * NoValueFactoryException.
      *
      * The following order is used to locate a factory for a type:
      *
@@ -322,8 +354,10 @@ local interface Communicator
      *
      * @see #findObjectFactory
      * @see ObjectFactory
+     * @see ValueFactoryManager#add
      *
      **/
+    ["deprecate:addObjectFactory() is deprecated, use ValueFactoryManager::add() instead."]
     void addObjectFactory(ObjectFactory factory, ["objc:param:sliceId"] string id);
 
     /**
@@ -338,9 +372,13 @@ local interface Communicator
      *
      * @see #addObjectFactory
      * @see ObjectFactory
+     * @see ValueFactoryManager#find
      *
      **/
-    ["cpp:const"] ObjectFactory findObjectFactory(string id);
+    ["cpp:const", "cpp:noexcept", "deprecate:findObjectFactory() is deprecated, use ValueFactoryManager::find() instead."]
+    ObjectFactory findObjectFactory(string id);
+
+#endif
 
     /**
      * Get the implicit context associated with this communicator.
@@ -350,7 +388,8 @@ local interface Communicator
      * or is set to None.
      *
      **/
-    ["cpp:const"] ImplicitContext getImplicitContext();
+    ["cpp:const", "cpp:noexcept", "swift:noexcept", "swift:nonnull"]
+    ImplicitContext getImplicitContext();
 
     /**
      *
@@ -361,7 +400,7 @@ local interface Communicator
      * @see Properties
      *
      **/
-    ["cpp:const"] Properties getProperties();
+    ["cpp:const", "cpp:noexcept", "swift:noexcept", "swift:nonnull"] Properties getProperties();
 
     /**
      *
@@ -372,8 +411,9 @@ local interface Communicator
      * @see Logger
      *
      **/
-    ["cpp:const"] Logger getLogger();
+    ["cpp:const", "cpp:noexcept", "swift:noexcept", "swift:nonnull"] Logger getLogger();
 
+#if !defined(__SLICE2SWIFT__) && !defined(__SLICE2JS__)
     /**
      *
      * Get the observer resolver object for this communicator.
@@ -381,7 +421,8 @@ local interface Communicator
      * @return This communicator's observer resolver object.
      *
      **/
-    ["cpp:const"] Ice::Instrumentation::CommunicatorObserver getObserver();
+    ["cpp:const", "cpp:noexcept"] Instrumentation::CommunicatorObserver getObserver();
+#endif
 
     /**
      *
@@ -393,7 +434,7 @@ local interface Communicator
      * @see Router
      *
      **/
-    ["cpp:const"] Router* getDefaultRouter();
+    ["cpp:const", "swift:noexcept"] Router* getDefaultRouter();
 
     /**
      *
@@ -403,7 +444,7 @@ local interface Communicator
      * operation has no effect on existing proxies.
      *
      * You can also set a router for an individual proxy
-     * by calling the operation <tt>ice_router</tt> on the proxy.
+     * by calling the operation <code>ice_router</code> on the proxy.
      *
      * @param rtr The default router to use for this communicator.
      *
@@ -412,7 +453,7 @@ local interface Communicator
      * @see Router
      *
      **/
-    void setDefaultRouter(Router* rtr);
+    ["swift:noexcept"] void setDefaultRouter(Router* rtr);
 
     /**
      *
@@ -424,7 +465,7 @@ local interface Communicator
      * @see Locator
      *
      **/
-    ["cpp:const"] Locator* getDefaultLocator();
+    ["cpp:const", "swift:noexcept"] Locator* getDefaultLocator();
 
     /**
      *
@@ -435,7 +476,7 @@ local interface Communicator
      * object adapters.
      *
      * You can also set a locator for an individual proxy by calling the
-     * operation <tt>ice_locator</tt> on the proxy, or for an object adapter
+     * operation <code>ice_locator</code> on the proxy, or for an object adapter
      * by calling {@link ObjectAdapter#setLocator} on the object adapter.
      *
      * @param loc The default locator to use for this communicator.
@@ -445,8 +486,9 @@ local interface Communicator
      * @see ObjectAdapter#setLocator
      *
      **/
-    void setDefaultLocator(Locator* loc);
+    ["swift:noexcept"] void setDefaultLocator(Locator* loc);
 
+#if !defined(__SLICE2SWIFT__) && !defined(__SLICE2JS__)
     /**
      *
      * Get the plug-in manager for this communicator.
@@ -457,6 +499,19 @@ local interface Communicator
      *
      **/
     ["cpp:const"] PluginManager getPluginManager();
+#endif
+
+    /**
+     *
+     * Get the value factory manager for this communicator.
+     *
+     * @return This communicator's value factory manager.
+     *
+     * @see ValueFactoryManager
+     *
+     **/
+    ["cpp:const", "cpp:noexcept", "swift:noexcept", "swift:nonnull"]
+    ValueFactoryManager getValueFactoryManager();
 
     /**
      *
@@ -465,16 +520,20 @@ local interface Communicator
      * for all connections associated with the communicator.
      * Any errors that occur while flushing a connection are ignored.
      *
+     * @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);
 
+#ifndef __SLICE2JS__
     /**
      *
      * Add the Admin object with all its facets to the provided object adapter.
      * If Ice.Admin.ServerId is set and the provided object adapter has a {@link Locator},
      * createAdmin registers the Admin's Process facet with the {@link Locator}'s {@link LocatorRegistry}.
      *
-     * createAdmin call only be called once; subsequent calls raise InitializationException.
+     * createAdmin must only be called once; subsequent calls raise InitializationException.
      *
      * @param adminAdapter The object adapter used to host the Admin object; if null and
      * Ice.Admin.Endpoints is set, create, activate and use the Ice.Admin object adapter.
@@ -484,10 +543,9 @@ local interface Communicator
      * @return A proxy to the main ("") facet of the Admin object. Never returns a null proxy.
      *
      * @see #getAdmin
-     * @see LocatorRegistry
      *
      **/
-    Object* createAdmin(ObjectAdapter adminAdapter, Identity adminId);
+    ["swift:nonnull"] Object* createAdmin(ObjectAdapter adminAdapter, Identity adminId);
 
     /**
      *
@@ -500,7 +558,7 @@ local interface Communicator
      *
      * If Ice.Admin.DelayCreation is 0 or not set, getAdmin is called by the communicator
      * initialization, after initialization of all plugins.
-
+     *
      * @return A proxy to the main ("") facet of the Admin object, or a null proxy if no
      * Admin object is configured.
      *
@@ -518,19 +576,19 @@ local interface Communicator
      * @param facet The name of the new Admin facet.
      *
      **/
-    void addAdminFacet(Object servant, string facet);
+    void addAdminFacet(["swift:nonnull"] Object servant, string facet);
 
     /**
      *
      * Remove the following facet to the Admin object.
-     * Removing a facet that was not previously registered
-     * throws NotRegisteredException.
+     * Removing a facet that was not previously registered throws
+     * NotRegisteredException.
      *
      * @param facet The name of the Admin facet.
      * @return The servant associated with this Admin facet.
      *
      **/
-    Object removeAdminFacet(string facet);
+    ["swift:nonnull", "swift:attribute:@discardableResult"] Object removeAdminFacet(string facet);
 
     /**
      *
@@ -541,7 +599,7 @@ local interface Communicator
      * null if no facet is registered with the given name.
      *
      **/
-    Object findAdminFacet(string facet);
+    ["swift:noexcept"] Object findAdminFacet(string facet);
 
     /**
      *
@@ -553,7 +611,65 @@ local interface Communicator
      * @see #findAdminFacet
      *
      **/
-    FacetMap findAllAdminFacets();
-};
+    ["swift:noexcept"] FacetMap findAllAdminFacets();
+#endif
+
+#if defined(__SLICE2SWIFT__) || defined(ICE_SWIFT)
+    /**
+     *
+     * Returns the client dispatch queue.
+     *
+     * @return The dispatch queue associated wih this Communicator's
+     * client thread pool.
+     *
+     **/
+    ["cpp:const", "swift:nonnull", "cpp:type:dispatch_queue_t", "swift:type:Dispatch.DispatchQueue"]
+    LocalObject getClientDispatchQueue();
+
+    /**
+     *
+     * Returns the server dispatch queue.
+     *
+     * @return The dispatch queue associated wih the Communicator's
+     * server thread pool.
+     *
+     **/
+    ["cpp:const", "swift:nonnull", "cpp:type:dispatch_queue_t", "swift:type:Dispatch.DispatchQueue"]
+    LocalObject getServerDispatchQueue();
+#endif
+}
+
+#endif
+
+/**
+ * The output mode for xxxToString method such as identityToString and proxyToString.
+ * The actual encoding format for the string is the same for all modes: you
+ * don't need to specify an encoding format or mode when reading such a string.
+ *
+ **/
+local enum ToStringMode
+{
+    /**
+     * Characters with ordinal values greater than 127 are kept as-is in the resulting string.
+     * Non-printable ASCII characters with ordinal values 127 and below are encoded as \\t, \\n (etc.)
+     * or \\unnnn.
+     **/
+    Unicode,
+
+    /**
+     * Characters with ordinal values greater than 127 are encoded as universal character names in
+     * the resulting string: \\unnnn for BMP characters and \\Unnnnnnnn for non-BMP characters.
+     * Non-printable ASCII characters with ordinal values 127 and below are encoded as \\t, \\n (etc.)
+     * or \\unnnn.
+     **/
+    ASCII,
+
+    /**
+     * Characters with ordinal values greater than 127 are encoded as a sequence of UTF-8 bytes using
+     * octal escapes. Characters with ordinal values 127 and below are encoded as \\t, \\n (etc.) or
+     * an octal escape. Use this mode to generate strings compatible with Ice 3.6 and earlier.
+     **/
+    Compat
+}
 
-};
+}