zeroc-ice 3.6.2 → 3.6.3

data/slice/Ice/Router.ice

@@ -31,6 +31,9 @@ interface Router
      * Get the router's client proxy, i.e., the proxy to use for
      * forwarding requests from the client to the router.
      *
+     * If a null proxy is returned, the client will forward requests
+     * to the router's endpoints.
+     *
      * @return The router's client proxy.
      *
      **/

data/slice/IceGrid/Session.ice

@@ -88,7 +88,8 @@ interface Session extends Glacier2::Session
 
     /**
      *
-     * Release an object.
+     * Release an object that was allocated using <tt>allocateObjectById</tt> or
+     * <tt>allocateObjectByType</tt>.
      *
      * @param id The identity of the object to release.
      *
@@ -99,9 +100,6 @@ interface Session extends Glacier2::Session
      * released. This might happen if the object isn't allocatable or
      * isn't allocated by the session.
      *
-     * @see #allocateObjectById
-     * @see #allocateObjectByType
-     *
      **/
     void releaseObject(Ice::Identity id)
         throws ObjectNotRegisteredException, AllocationException;
@@ -109,14 +107,12 @@ interface Session extends Glacier2::Session
     /**
      *
      * Set the allocation timeout. If no objects are available for an
-     * allocation request, the request will hang for the duration of
-     * this timeout.
+     * allocation request, a call to <tt>allocateObjectById</tt> or
+     * <tt>allocateObjectByType</tt> will block for the duration of this
+     * timeout.
      *
      * @param timeout The timeout in milliseconds.
      *
-     * @see #allocateObjectById
-     * @see #allocateObjectByType
-     *
      **/
     idempotent void setAllocationTimeout(int timeout);
 };

data/slice/IceLocatorDiscovery/IceLocatorDiscovery.ice

@@ -25,9 +25,9 @@ module IceLocatorDiscovery
  * are searching for Ice locators. Ice locator implementations invoke
  * on this interface to provide their locator proxy.
  *
- * @see Locator
+ * @see Ice.Locator
  * @see Lookup
- * 
+ *
  **/
 interface LookupReply
 {
@@ -47,14 +47,14 @@ interface LookupReply
  * The Ice lookup interface is implemented by Ice locator
  * implementations and can be used by clients to find available Ice
  * locators on the network.
- * 
- * Ice locator implementations provide a well-known `Ice/LocatorLookup' 
- * object accessible through UDP multicast. Clients typically make a 
+ *
+ * Ice locator implementations provide a well-known `Ice/LocatorLookup'
+ * object accessible through UDP multicast. Clients typically make a
  * multicast findLocator request to find the locator proxy.
  *
- * @see Locator
+ * @see Ice.Locator
  * @see LookupReply
- * 
+ *
  **/
 interface Lookup
 {

data/slice/IcePatch2/FileServer.ice

@@ -16,9 +16,9 @@
 
 /**
  *
- * IcePatch can be used to update file hiearchies in a simple and
+ * IcePatch can be used to update file hierarchies in a simple and
  * efficient manner. Checksums ensure file integrity, and data is
- * compressed before download.
+ * compressed before downloading.
  *
  **/
 ["objc:prefix:ICEPATCH2"]
@@ -35,8 +35,7 @@ sequence<Ice::ByteSeq> ByteSeqSeq;
 
 /**
  *
- * The <tt>partition</tt> argument for
- * {@link FileServer#getFileInfoSeq} was not in the range 0-255.
+ * A <tt>partition</tt> argument for was not in the range 0-255.
  *
  **/
 exception PartitionOutOfRangeException
@@ -45,8 +44,7 @@ exception PartitionOutOfRangeException
 
 /**
  *
- * This exception is raised if {@link FileServer#getFileCompressed} cannot read the
- * contents of a file.
+ * This exception is raised if a file's contents cannot be read.
  *
  **/
 exception FileAccessException
@@ -61,11 +59,8 @@ exception FileAccessException
 
 /**
  *
- * This exception is raised if {@link FileServer#getFileCompressed} or
- * {@link FileServer#getFileInfoSeq} try to operate in files with size
- * large than 2.1 GB, these operations does not support working with
- * large files instead {@link FileServer#getLargeFileCompressed} and 
- * {@link FileServer#getLargeFileInfoSeq} must be used.
+ * This exception is raised if an operation tries to use a file whose size is
+ * larger than 2.1 GB. Use the "large" versions of the operations instead.
  *
  **/
 exception FileSizeRangeException extends FileAccessException
@@ -81,19 +76,18 @@ interface FileServer
 {
     /**
      *
-     * Return the {@link FileInfoSeq} for the specified partition. If the
-     * partion number is out of range, the operation throws
+     * Return file information for the specified partition.
      * 
-     * <p class="Deprecated"> This operation is deprecated, and only keep for
-     * compativility with old Ice clients (older than version 3.6).
-     *
-     * {@link PartitionOutOfRangException}.
+     * <p class="Deprecated"> This operation is deprecated and only present for
+     * compatibility with old Ice clients (older than version 3.6).
      *
      * @param partition The partition number in the range 0-255.
      *
-     * @return A sequence containing the {@link FileInfo} structures for
-     * files in the specified partition.
+     * @return A sequence containing information about the files in the
+     * specified partition.
      *
+     * @throws PartitionOutOfRangeException If the partition number is out of range.
+     * @throws FileSizeRangeException If a file is larger than 2.1GB.
      **/
     ["deprecate:getFileInfoSeq() is deprecated, use getLargeFileInfoSeq() instead.",
      "nonmutating", "cpp:const"] idempotent FileInfoSeq getFileInfoSeq(int partition)
@@ -101,15 +95,14 @@ interface FileServer
         
     /**
      *
-     * Return the {@link FileInfoSeq} for the specified partition. If the
-     * partion number is out of range, the operation throws
-     * {@link PartitionOutOfRangException}.
+     * Returns file information for the specified partition.
      *
      * @param partition The partition number in the range 0-255.
      *
-     * @return A sequence containing the {@link FileInfo} structures for
-     * files in the specified partition.
+     * @return A sequence containing information about the files in the
+     * specified partition.
      *
+     * @throws PartitionOutOfRangeException If the partition number is out of range.
      **/
     ["nonmutating", "cpp:const"] idempotent LargeFileInfoSeq getLargeFileInfoSeq(int partition)
         throws PartitionOutOfRangeException;
@@ -139,13 +132,11 @@ interface FileServer
 
     /**
      *
-     * Read the specified file. If the read operation fails, the
-     * operation throws {@link FileAccessException}. This operation may only
-     * return fewer bytes than requested in case there was an
-     * end-of-file condition.
+     * Read the specified file. This operation may only return fewer bytes than requested
+     * in case there was an end-of-file condition.
      *
-     * <p class="Deprecated"> This operation is deprecated, and only keep for
-     * compativility with old Ice clients (older than version 3.6).
+     * <p class="Deprecated"> This operation is deprecated and only present for
+     * compatibility with old Ice clients (older than version 3.6).
      *
      * @param path The pathname (relative to the data directory) for
      * the file to be read.
@@ -156,6 +147,9 @@ interface FileServer
      *
      * @return A sequence containing the compressed file contents.
      *
+     * @throws FileAccessException If an error occurred while trying to read the file.
+     * @throws FileSizeRangeException If a file is larger than 2.1GB.
+     *
      **/
     ["deprecate:getFileCompressed() is deprecated, use getLargeFileCompressed() instead.",
      "amd", "nonmutating", "cpp:const", "cpp:array"] 
@@ -164,10 +158,8 @@ interface FileServer
         
     /**
      *
-     * Read the specified file. If the read operation fails, the
-     * operation throws {@link FileAccessException}. This operation may only
-     * return fewer bytes than requested in case there was an
-     * end-of-file condition.
+     * Read the specified file. This operation may only return fewer bytes than requested
+     * in case there was an end-of-file condition.
      *
      * @param path The pathname (relative to the data directory) for
      * the file to be read.
@@ -178,6 +170,8 @@ interface FileServer
      *
      * @return A sequence containing the compressed file contents.
      *
+     * @throws FileAccessException If an error occurred while trying to read the file.
+     *
      **/
     ["amd", "nonmutating", "cpp:const", "cpp:array"] 
     idempotent Ice::ByteSeq getLargeFileCompressed(string path, long pos, int num)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zeroc-ice
 version: !ruby/object:Gem::Version
-  version: 3.6.2
+  version: 3.6.3
 platform: ruby
 authors:
 - ZeroC, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-01 00:00:00.000000000 Z
+date: 2016-10-05 00:00:00.000000000 Z
 dependencies: []
 description: |
   The Internet Communications Engine (Ice) provides a robust, proven
@@ -363,40 +363,40 @@ files:
 - ext/ice/cpp/src/Ice/BuiltinSequences.cpp
 - ext/ice/cpp/src/Ice/CommunicatorF.cpp
 - ext/ice/cpp/src/Ice/ConnectionF.cpp
+- ext/ice/cpp/src/Ice/Current.cpp
 - ext/ice/cpp/src/Ice/FacetMap.cpp
 - ext/ice/cpp/src/Ice/EndpointF.cpp
-- ext/ice/cpp/src/Ice/Current.cpp
 - ext/ice/cpp/src/Ice/EndpointTypes.cpp
 - ext/ice/cpp/src/Ice/Identity.cpp
+- ext/ice/cpp/src/Ice/Connection.cpp
+- ext/ice/cpp/src/Ice/Communicator.cpp
 - ext/ice/cpp/src/Ice/Endpoint.cpp
 - ext/ice/cpp/src/Ice/ImplicitContextF.cpp
-- ext/ice/cpp/src/Ice/Connection.cpp
 - ext/ice/cpp/src/Ice/InstrumentationF.cpp
-- ext/ice/cpp/src/Ice/Communicator.cpp
-- ext/ice/cpp/src/Ice/LocatorF.cpp
 - ext/ice/cpp/src/Ice/Locator.cpp
+- ext/ice/cpp/src/Ice/Instrumentation.cpp
+- ext/ice/cpp/src/Ice/LocatorF.cpp
 - ext/ice/cpp/src/Ice/Logger.cpp
 - ext/ice/cpp/src/Ice/LoggerF.cpp
-- ext/ice/cpp/src/Ice/Instrumentation.cpp
-- ext/ice/cpp/src/Ice/ImplicitContext.cpp
 - ext/ice/cpp/src/Ice/LocalException.cpp
+- ext/ice/cpp/src/Ice/ImplicitContext.cpp
 - ext/ice/cpp/src/Ice/ObjectAdapterF.cpp
 - ext/ice/cpp/src/Ice/Metrics.cpp
+- ext/ice/cpp/src/Ice/PluginF.cpp
 - ext/ice/cpp/src/Ice/ObjectFactory.cpp
 - ext/ice/cpp/src/Ice/ObjectFactoryF.cpp
-- ext/ice/cpp/src/Ice/PluginF.cpp
 - ext/ice/cpp/src/Ice/Plugin.cpp
 - ext/ice/cpp/src/Ice/Process.cpp
 - ext/ice/cpp/src/Ice/ProcessF.cpp
+- ext/ice/cpp/src/Ice/PropertiesF.cpp
 - ext/ice/cpp/src/Ice/PropertiesAdmin.cpp
-- ext/ice/cpp/src/Ice/Properties.cpp
 - ext/ice/cpp/src/Ice/ObjectAdapter.cpp
-- ext/ice/cpp/src/Ice/PropertiesF.cpp
-- ext/ice/cpp/src/Ice/RemoteLogger.cpp
+- ext/ice/cpp/src/Ice/Properties.cpp
 - ext/ice/cpp/src/Ice/Router.cpp
+- ext/ice/cpp/src/Ice/RemoteLogger.cpp
 - ext/ice/cpp/src/Ice/RouterF.cpp
-- ext/ice/cpp/src/Ice/ServantLocator.cpp
 - ext/ice/cpp/src/Ice/ServantLocatorF.cpp
+- ext/ice/cpp/src/Ice/ServantLocator.cpp
 - ext/ice/cpp/src/Ice/SliceChecksumDict.cpp
 - ext/ice/cpp/src/Ice/Version.cpp
 - ext/ice/cpp/src/IceSSL/AcceptorI.h
@@ -566,43 +566,43 @@ files:
 - ext/ice/cpp/include/Ice/UserExceptionFactory.h
 - ext/ice/cpp/include/Ice/BuiltinSequences.h
 - ext/ice/cpp/include/Ice/CommunicatorF.h
-- ext/ice/cpp/include/Ice/FacetMap.h
 - ext/ice/cpp/include/Ice/ConnectionF.h
-- ext/ice/cpp/include/Ice/EndpointF.h
 - ext/ice/cpp/include/Ice/Current.h
+- ext/ice/cpp/include/Ice/FacetMap.h
+- ext/ice/cpp/include/Ice/EndpointF.h
 - ext/ice/cpp/include/Ice/EndpointTypes.h
-- ext/ice/cpp/include/Ice/ImplicitContextF.h
 - ext/ice/cpp/include/Ice/Identity.h
-- ext/ice/cpp/include/Ice/Endpoint.h
-- ext/ice/cpp/include/Ice/InstrumentationF.h
-- ext/ice/cpp/include/Ice/LocatorF.h
-- ext/ice/cpp/include/Ice/Connection.h
 - ext/ice/cpp/include/Ice/Communicator.h
+- ext/ice/cpp/include/Ice/ImplicitContextF.h
+- ext/ice/cpp/include/Ice/Connection.h
+- ext/ice/cpp/include/Ice/LocatorF.h
+- ext/ice/cpp/include/Ice/InstrumentationF.h
+- ext/ice/cpp/include/Ice/Endpoint.h
+- ext/ice/cpp/include/Ice/Instrumentation.h
 - ext/ice/cpp/include/Ice/Logger.h
 - ext/ice/cpp/include/Ice/LoggerF.h
 - ext/ice/cpp/include/Ice/ImplicitContext.h
-- ext/ice/cpp/include/Ice/Instrumentation.h
+- ext/ice/cpp/include/Ice/Locator.h
 - ext/ice/cpp/include/Ice/ObjectAdapterF.h
+- ext/ice/cpp/include/Ice/PluginF.h
 - ext/ice/cpp/include/Ice/ObjectFactory.h
 - ext/ice/cpp/include/Ice/ObjectFactoryF.h
-- ext/ice/cpp/include/Ice/PluginF.h
-- ext/ice/cpp/include/Ice/ProcessF.h
 - ext/ice/cpp/include/Ice/Plugin.h
-- ext/ice/cpp/include/Ice/Locator.h
+- ext/ice/cpp/include/Ice/PropertiesF.h
+- ext/ice/cpp/include/Ice/ProcessF.h
+- ext/ice/cpp/include/Ice/LocalException.h
 - ext/ice/cpp/include/Ice/Process.h
 - ext/ice/cpp/include/Ice/Properties.h
-- ext/ice/cpp/include/Ice/PropertiesF.h
 - ext/ice/cpp/include/Ice/ObjectAdapter.h
-- ext/ice/cpp/include/Ice/LocalException.h
-- ext/ice/cpp/include/Ice/RouterF.h
 - ext/ice/cpp/include/Ice/PropertiesAdmin.h
-- ext/ice/cpp/include/Ice/ServantLocator.h
+- ext/ice/cpp/include/Ice/RouterF.h
+- ext/ice/cpp/include/Ice/Router.h
 - ext/ice/cpp/include/Ice/ServantLocatorF.h
+- ext/ice/cpp/include/Ice/ServantLocator.h
 - ext/ice/cpp/include/Ice/SliceChecksumDict.h
-- ext/ice/cpp/include/Ice/Router.h
+- ext/ice/cpp/include/Ice/Version.h
 - ext/ice/cpp/include/Ice/Metrics.h
 - ext/ice/cpp/include/Ice/RemoteLogger.h
-- ext/ice/cpp/include/Ice/Version.h
 - ext/ice/cpp/include/IceSSL/Config.h
 - ext/ice/cpp/include/IceSSL/IceSSL.h
 - ext/ice/cpp/include/IceSSL/Plugin.h