zeroc-ice 3.6.5 → 3.7.0

data/slice/Ice/BuiltinSequences.ice

@@ -1,6 +1,6 @@
 // **********************************************************************
 //
-// Copyright (c) 2003-2018 ZeroC, Inc. All rights reserved.
+// Copyright (c) 2003-2017 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.
@@ -9,7 +9,11 @@
 
 #pragma once
 
-[["cpp:header-ext:h", "objc:header-dir:objc", "js:ice-build"]]
+[["ice-prefix", "cpp:header-ext:h", "cpp:dll-export:ICE_API", "objc:header-dir:objc", "objc:dll-export:ICE_API", "js:ice-build", "python:pkgdir:Ice"]]
+
+#ifndef __SLICE2JAVA_COMPAT__
+[["java:package:com.zeroc"]]
+#endif
 
 ["objc:prefix:ICE"]
 module Ice
@@ -45,5 +49,4 @@ sequence<Object> ObjectSeq;
 /** A sequence of object proxies. **/
 sequence<Object*> ObjectProxySeq;
 
-};
-
+}

data/slice/Ice/Communicator.ice

@@ -1,6 +1,6 @@
 // **********************************************************************
 //
-// Copyright (c) 2003-2018 ZeroC, Inc. All rights reserved.
+// Copyright (c) 2003-2017 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.
@@ -9,19 +9,21 @@
 
 #pragma once
 
-[["cpp:header-ext:h", "objc:header-dir:objc"]]
+[["ice-prefix", "cpp:header-ext:h", "cpp:dll-export:ICE_API", "objc:header-dir:objc", "objc:dll-export:ICE_API", "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 +34,10 @@
  * additional functionality that supports high scalability.
  *
  **/
+#ifndef __SLICE2JAVA_COMPAT__
+[["java:package:com.zeroc"]]
+#endif
+
 ["objc:prefix:ICE"]
 module Ice
 {
@@ -46,11 +52,25 @@ module Ice
  * @see ObjectAdapter
  * @see Properties
  * @see ObjectFactory
+ * @see ValueFactory
  *
  **/
-["clr:implements:_System.IDisposable"]
+["clr:implements:_System.IDisposable", "java:implements:java.lang.AutoCloseable", "php:internal"]
 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,18 +82,19 @@ local interface Communicator
      * @see ObjectAdapter#destroy
      *
      **/
-    void destroy();
+    ["cpp:noexcept"] 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.
-     * Subsequent calls to shutdown are ignored.
+     * <p>Shuts down this communicator's server functionality, which
+     * includes the deactivation of all object adapters. (Attempts to use
+     * a deactivated object adapter raise {@link ObjectAdapterDeactivatedException}.)
+     * Subsequent calls to {@link #shutdown} are ignored.</p>
      *
-     * After shutdown returns, no new requests are processed. However, requests
-     * that have been started before shutdown was called might still be active.
-     * You can use {@link #waitForShutdown} to wait for the completion of all
+     * <p class="Note"> After {@link #shutdown} returns, no new requests are
+     * processed. However, requests that have been started before
+     * {@link #shutdown} was called might still be active. You can use
+     * {@link #waitForShutdown} to wait for the completion of all
      * requests.
      *
      * @see #destroy
@@ -91,11 +112,12 @@ local interface Communicator
      * On the client side, the operation simply block until another
      * thread has called {@link #shutdown} or {@link #destroy}.
      *
-     * A typical use of this operation is to call it from the main thread,
-     * which then waits until some other thread calls {@link #shutdown}.
-     * After shut-down is complete, the main thread returns and can do some
-     * cleanup work before it finally calls {@link #destroy} to shut down
-     * the client functionality, and then exits the application.
+     * <p>A typical use of this operation is to call it
+     * from the main thread, which then waits until some other thread
+     * calls {@link #shutdown}. After shut-down is complete, the main thread
+     * returns and can do some cleanup work before it finally calls
+     * {@link #destroy} to shut down the client functionality, and then
+     * exits the application.
      *
      * @see #shutdown
      * @see #destroy
@@ -123,9 +145,10 @@ local interface Communicator
      * 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
-     * operation throws one of ProxyParseException, EndpointParseException,
-     * or IdentityParseException. Refer to the Ice manual for a detailed
-     * description of the syntax supported by stringified proxies.
+     * operation throws one of {@link ProxyParseException},
+     * {@link EndpointParseException}, or {@link IdentityParseException}.
+     * An appendix in the Ice manual provides a detailed description
+     * of the syntax supported by stringified proxies.
      *
      * @param str The stringified proxy to convert into a proxy.
      *
@@ -158,7 +181,7 @@ local interface Communicator
      * <tt>MyProxy=id:tcp -h localhost -p 10000</tt>. 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
+     * appendix in the Ice manual describes each of the supported
      * proxy properties.
      *
      * @param property The base property name.
@@ -184,7 +207,7 @@ local interface Communicator
     /**
      *
      * Convert a string into an identity. If the string does not parse
-     * correctly, the operation throws IdentityParseException.
+     * correctly, the operation throws {@link IdentityParseException}.
      *
      * @param str The string to convert into an identity.
      *
@@ -193,7 +216,8 @@ 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);
 
     /**
      *
@@ -206,20 +230,21 @@ local interface Communicator
      * @see #stringToIdentity
      *
      **/
-    ["cpp:const"] string identityToString(Identity ident);
+    ["cpp:const"]
+    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>.
+     * <p>Create a new object adapter. The endpoints for the object
+     * adapter are taken from the property <tt><em>name</em>.Endpoints</tt>.</p>
      *
-     * It is legal to create an object adapter with the empty string as
+     * <p>It is legal to create an object adapter with the empty string as
      * its name. Such an object adapter is accessible via bidirectional
      * connections or by collocated invocations that originate from the
-     * same communicator as is used by the adapter.
+     * same communicator as is used by the adapter.</p>
      *
-     * Attempts to create a named object adapter for which no configuration
-     * can be found raise InitializationException.
+     * <p>Attempts to create a named object adapter for which no configuration
+     * can be found raise {@link InitializationException}.
      *
      * @param name The object adapter name.
      *
@@ -234,12 +259,12 @@ local interface Communicator
 
     /**
      *
-     * Create a new object adapter with endpoints. This operation sets
+     * <p>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.
+     * convenience function.</p>
      *
-     * Calling this operation with an empty name will result in a
+     * <p>Calling this operation with an empty name will result in a
      * UUID being generated for the name.
      *
      * @param name The object adapter name.
@@ -257,10 +282,10 @@ local interface Communicator
 
     /**
      *
-     * Create a new object adapter with a router. This operation
-     * creates a routed object adapter.
+     * <p>Create a new object adapter with a router. This operation
+     * creates a routed object adapter.</p>
      *
-     * Calling this operation with an empty name will result in a
+     * <p>Calling this operation with an empty name will result in a
      * UUID being generated for the name.
      *
      * @param name The object adapter name.
@@ -278,26 +303,27 @@ local interface Communicator
 
     /**
      *
-     * Add an object factory to this communicator. Installing a
+     * <p>Add an object factory to this communicator. Installing a
      * factory with an id for which a factory is already registered
-     * throws AlreadyRegisteredException.
+     * throws {@link AlreadyRegisteredException}.</p>
      *
-     * When unmarshaling an Ice object, the Ice run time reads the
+     * <p>When unmarshaling an Ice object, the Ice run time reads the
      * most-derived type id off the wire and attempts to create an
      * instance of the type using a factory. If no instance is created,
      * either because no factory was found, or because all factories
      * returned nil, the behavior of the Ice run time depends on the
-     * format with which the object was marshaled:
+     * format with which the object was marshaled:</p>
      *
-     * If the object uses the "sliced" format, Ice ascends the class
+     * <p>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
+     * {@link NoValueFactoryException}.</p>
      *
-     * If the object uses the "compact" format, Ice immediately raises
-     * NoObjectFactoryException.
+     * <p>If the object uses the "compact" format, Ice immediately raises
+     * {@link NoValueFactoryException}.</p>
      *
-     * The following order is used to locate a factory for a type:
+     * <p>The following order is used to locate a factory for a type:</p>
      *
      * <ol>
      *
@@ -322,8 +348,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 +366,11 @@ local interface Communicator
      *
      * @see #addObjectFactory
      * @see ObjectFactory
+     * @see ValueFactoryManager#find
      *
      **/
-    ["cpp:const"] ObjectFactory findObjectFactory(string id);
+    ["cpp:const", "deprecate:findObjectFactory() is deprecated, use ValueFactoryManager::find() instead."]
+    ObjectFactory findObjectFactory(string id);
 
     /**
      * Get the implicit context associated with this communicator.
@@ -397,12 +427,12 @@ local interface Communicator
 
     /**
      *
-     * Set a default router for this communicator. All newly
+     * <p>Set a default router for this communicator. All newly
      * created proxies will use this default router. To disable the
      * default router, null can be used. Note that this
-     * operation has no effect on existing proxies.
+     * operation has no effect on existing proxies.</p>
      *
-     * You can also set a router for an individual proxy
+     * <p class="Note">You can also set a router for an individual proxy
      * by calling the operation <tt>ice_router</tt> on the proxy.
      *
      * @param rtr The default router to use for this communicator.
@@ -428,15 +458,16 @@ local interface Communicator
 
     /**
      *
-     * Set a default Ice locator for this communicator. All newly
+     * <p>Set a default Ice locator for this communicator. All newly
      * created proxy and object adapters will use this default
      * locator. To disable the default locator, null can be used.
      * Note that this operation has no effect on existing proxies or
-     * object adapters.
+     * object adapters.</p>
      *
-     * 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
-     * by calling {@link ObjectAdapter#setLocator} on the object adapter.
+     * <p class="Note"> 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 by calling the operation {@link ObjectAdapter#setLocator}
+     * on the object adapter.
      *
      * @param loc The default locator to use for this communicator.
      *
@@ -458,6 +489,17 @@ local interface Communicator
      **/
     ["cpp:const"] PluginManager getPluginManager();
 
+    /**
+     *
+     * Get the value factory manager for this communicator.
+     *
+     * @return This communicator's value factory manager.
+     *
+     * @see ValueFactoryManager
+     *
+     **/
+    ["cpp:const"] ValueFactoryManager getValueFactoryManager();
+
     /**
      *
      * Flush any pending batch requests for this communicator.
@@ -465,8 +507,11 @@ 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);
 
     /**
      *
@@ -474,7 +519,7 @@ local interface Communicator
      * 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.
+     * <p>createAdmin call only be called once; subsequent calls raise {@link InitializationException}.</p>
      *
      * @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,7 +529,6 @@ 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);
@@ -498,8 +542,8 @@ local interface Communicator
      * object created by getAdmin is {value of Ice.Admin.InstanceName}/admin, or {UUID}/admin
      * when Ice.Admin.InstanceName is not set.
      *
-     * If Ice.Admin.DelayCreation is 0 or not set, getAdmin is called by the communicator
-     * initialization, after initialization of all plugins.
+     * <p>If Ice.Admin.DelayCreation is 0 or not set, getAdmin is called by the communicator
+     * initialization, after initialization of all plugins.</p>
 
      * @return A proxy to the main ("") facet of the Admin object, or a null proxy if no
      * Admin object is configured.
@@ -512,7 +556,7 @@ local interface Communicator
      *
      * Add a new facet to the Admin object.
      * Adding a servant with a facet that is already registered
-     * throws AlreadyRegisteredException.
+     * throws {@link AlreadyRegisteredException}.
      *
      * @param servant The servant that implements the new Admin facet.
      * @param facet The name of the new Admin facet.
@@ -523,8 +567,8 @@ local interface Communicator
     /**
      *
      * 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
+     * {@link NotRegisteredException}.
      *
      * @param facet The name of the Admin facet.
      * @return The servant associated with this Admin facet.
@@ -554,6 +598,37 @@ local interface Communicator
      *
      **/
     FacetMap findAllAdminFacets();
-};
+}
+
+/**
+ * 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
+}
 
-};
+}