zeroc-ice 3.6.4 → 3.6.5

data/slice/Ice/Connection.ice

@@ -1,7 +1,7 @@
 
 // **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// 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.
@@ -80,6 +80,8 @@ local interface ConnectionCallback
      * This method is called by the the connection when a heartbeat is
      * received from the peer.
      *
+     * @param con The connection on which a heartbeat was received.
+     *
      **/
     void heartbeat(Connection con);
 
@@ -88,31 +90,60 @@ local interface ConnectionCallback
      * This method is called by the the connection when the connection
      * is closed.
      *
+     * @param con The connection that closed.
+     *
      **/
     void closed(Connection con);
 };
 
+/**
+ * Specifies the close semantics for Active Connection Management.
+ */
 local enum ACMClose
 {
+    /** Disables automatic connection closure. */
     CloseOff,
+    /** Gracefully closes a connection that has been idle for the configured timeout period. */
     CloseOnIdle,
+    /**
+     * Forcefully closes a connection that has been idle for the configured timeout period,
+     * but only if the connection has pending invocations.
+     */
     CloseOnInvocation,
+    /** Combines the behaviors of CloseOnIdle and CloseOnInvocation. */
     CloseOnInvocationAndIdle,
+    /**
+     * Forcefully closes a connection that has been idle for the configured timeout period,
+     * regardless of whether the connection has pending invocations or dispatch.
+     */
     CloseOnIdleForceful
 };
 
+/**
+ * Specifies the heartbeat semantics for Active Connection Management.
+ */
 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,
+    /** 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.
+ */
 local struct ACM
 {
+    /** A timeout value in seconds. */
     int timeout;
+    /** The close semantics. */
     ACMClose close;
+    /** The heartbeat semantics. */
     ACMHeartbeat heartbeat;
 };
 
@@ -222,7 +253,7 @@ local interface Connection
      *
      * Set the active connection management parameters.
      *
-     * @param timeout The timeout value in milliseconds.
+     * @param timeout The timeout value in seconds.
      *
      * @param close The close condition
      *
@@ -280,7 +311,6 @@ local interface Connection
      **/
     ["cpp:const"] ConnectionInfo getInfo();
 
-
     /**
      *
      * Set the connectiion buffer receive/send size.
@@ -335,6 +365,7 @@ local class UDPConnectionInfo extends IPConnectionInfo
     int mcastPort = -1;
 };
 
+/** A collection of HTTP headers. */
 dictionary<string, string> HeaderDict;
 
 /**

data/slice/Ice/ConnectionF.ice

@@ -1,6 +1,6 @@
 // **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// 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.

data/slice/Ice/Current.ice

@@ -1,6 +1,6 @@
 // **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// 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.
@@ -32,8 +32,7 @@ dictionary<string, string> Context;
 
 /**
  *
- * The {@link OperationMode} determines the retry behavior an
- * invocation in case of a (potentially) recoverable error.
+ * Determines the retry behavior of an invocation in case of a (potentially) recoverable error.
  *
  **/
 //
@@ -60,7 +59,7 @@ enum OperationMode
      * the failure to the application only if the second attempt
      * fails.
      *
-     * <p class="Deprecated"><tt>Nonmutating</tt> is deprecated; Use the
+     * <tt>Nonmutating</tt> is deprecated; Use the
      * <tt>idempotent</tt> keyword instead. For C++, to retain the mapping
      * of <tt>nonmutating</tt> operations to C++ <tt>const</tt>
      * member functions, use the <tt>\["cpp:const"]</tt> metadata
@@ -154,7 +153,7 @@ local struct Current
      * The encoding version used to encode the input and output parameters.
      *
      **/
-    Ice::EncodingVersion encoding;
+    EncodingVersion encoding;
 };
 
 };

data/slice/Ice/Endpoint.ice

@@ -1,6 +1,6 @@
 // **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// 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.
@@ -81,6 +81,7 @@ local class EndpointInfo
      *
      * Returns the type of the endpoint.
      *
+     * @return The endpoint type.
      **/
     ["cpp:const"] short type();
 
@@ -88,6 +89,7 @@ local class EndpointInfo
      *
      * Returns true if this endpoint is a datagram endpoint.
      *
+     * @return True for a datagram endpoint.
      **/
     ["cpp:const"] bool datagram();
 
@@ -95,6 +97,7 @@ local class EndpointInfo
      *
      * Returns true if this endpoint is a secure endpoint.
      *
+     * @return True for a secure endpoint.
      **/
     ["cpp:const"] bool secure();
 };
@@ -221,14 +224,14 @@ local class OpaqueEndpointInfo extends EndpointInfo
      * encode the rawBytes).
      *
      **/
-    Ice::EncodingVersion rawEncoding;
+    EncodingVersion rawEncoding;
 
     /**
      *
      * The raw encoding of the opaque endpoint.
      *
      **/
-    Ice::ByteSeq rawBytes;
+    ByteSeq rawBytes;
 };
 
 };

data/slice/Ice/EndpointF.ice

@@ -1,6 +1,6 @@
 // **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// 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.

data/slice/Ice/EndpointTypes.ice

@@ -1,6 +1,6 @@
 // **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// 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.

data/slice/Ice/FacetMap.ice

@@ -1,6 +1,6 @@
 // **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// 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.

data/slice/Ice/Identity.ice

@@ -1,6 +1,6 @@
 // **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// 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.

data/slice/Ice/ImplicitContext.ice

@@ -1,6 +1,6 @@
 // **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// 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.
@@ -24,8 +24,9 @@ module Ice
  *
  * When you make a remote invocation without an explicit context parameter,
  * Ice uses the per-proxy context (if any) combined with the <tt>ImplicitContext</tt>
- * associated with the communicator.</p>
- * <p>Ice provides several implementations of <tt>ImplicitContext</tt>. The implementation
+ * associated with the communicator.
+ *
+ * Ice provides several implementations of <tt>ImplicitContext</tt>. The implementation
  * used depends on the value of the <tt>Ice.ImplicitContext</tt> property.
  * <dl>
  * <dt><tt>None</tt> (default)</dt>
@@ -34,7 +35,7 @@ module Ice
  * <dd>The implementation maintains a context per thread.</dd>
  * <dt><tt>Shared</tt></dt>
  * <dd>The implementation maintains a single context shared by all threads.</dd>
- * </dl><p>
+ * </dl>
  *  
  * <tt>ImplicitContext</tt> also provides a number of operations to create, update or retrieve
  * an entry in the underlying context without first retrieving a copy of the entire

data/slice/Ice/ImplicitContextF.ice

@@ -1,6 +1,6 @@
 // **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// 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.

data/slice/Ice/Instrumentation.ice

@@ -1,6 +1,6 @@
 // **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// 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.

data/slice/Ice/InstrumentationF.ice

@@ -1,6 +1,6 @@
 // **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// 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.

data/slice/Ice/LocalException.ice

@@ -1,6 +1,6 @@
 // **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// 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.
@@ -58,7 +58,7 @@ local exception PluginInitializationException
  * supported with collocation optimization.
  *
  **/
-["cpp:ice_print", "deprecate:this exception isn't used anymore by the Ice runtime"]
+["cpp:ice_print", "deprecate:This exception is no longer used by the Ice run time"]
 local exception CollocationOptimizationException
 {
 };
@@ -661,8 +661,7 @@ local exception InvocationTimeoutException extends TimeoutException
 /**
  *
  * This exception indicates that an asynchronous invocation failed
- * because it was canceled explicitly by the user using the
- * <tt>Ice::AsyncResult::cancel</tt> method.
+ * because it was canceled explicitly by the user.
  *
  **/
 ["cpp:ice_print"]

data/slice/Ice/Locator.ice

@@ -1,6 +1,6 @@
 // **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// 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.
@@ -92,11 +92,11 @@ interface Locator
      *
      * @return The proxy, or null if the object is not active.
      *
-     * @throws ObjectNotFoundException Raised if the object cannot
+     * @throws Ice.ObjectNotFoundException Raised if the object cannot
      * be found.
      *
      **/
-    ["amd", "nonmutating", "cpp:const"] idempotent Object* findObjectById(Ice::Identity id)
+    ["amd", "nonmutating", "cpp:const"] idempotent Object* findObjectById(Identity id)
         throws ObjectNotFoundException;
 
     /**
@@ -108,7 +108,7 @@ interface Locator
      *
      * @return The adapter proxy, or null if the adapter is not active.
      *
-     * @throws AdapterNotFoundException Raised if the adapter cannot be
+     * @throws Ice.AdapterNotFoundException Raised if the adapter cannot be
      * found.
      *
      **/

data/slice/Ice/LocatorF.ice

@@ -1,6 +1,6 @@
 // **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// 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.

data/slice/Ice/Logger.ice

@@ -1,6 +1,6 @@
 // **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// 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.
@@ -28,6 +28,8 @@ local interface Logger
      * Print a message. The message is printed literally, without
      * any decorations such as executable name or time stamp.
      *
+     * @param message The message to log.
+     *
      **/
     void print(string message);
 
@@ -78,6 +80,7 @@ local interface Logger
      * Returns a clone of the logger with a new prefix.
      *
      * @param prefix The new prefix for the logger.
+     * @return A logger instance.
      *
      */
     Logger cloneWithPrefix(string prefix);

data/slice/Ice/LoggerF.ice

@@ -1,6 +1,6 @@
 // **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// 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.

data/slice/Ice/Metrics.ice

@@ -1,6 +1,6 @@
 // **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// 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.

data/slice/Ice/ObjectAdapter.ice

@@ -1,6 +1,6 @@
 // **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// 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.

data/slice/Ice/ObjectAdapterF.ice

@@ -1,6 +1,6 @@
 // **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// 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.

data/slice/Ice/ObjectFactory.ice

@@ -1,6 +1,6 @@
 // **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// 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.
@@ -32,9 +32,9 @@ local interface ObjectFactory
      * absolute Slice type id, i.e., the id relative to the
      * unnamed top-level Slice module. For example, the absolute
      * Slice type id for interfaces of type <tt>Bar</tt> in the module
-     * <tt>Foo</tt> is <tt>::Foo::Bar</tt>.
+     * <tt>Foo</tt> is <tt>"::Foo::Bar"</tt>.
      *
-     * <p class="Note">The leading "<tt>::</tt>" is required.
+     * The leading "<tt>::</tt>" is required.
      *
      * @param type The object type.
      *

data/slice/Ice/ObjectFactoryF.ice

@@ -1,6 +1,6 @@
 // **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// 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.

data/slice/Ice/Plugin.ice

@@ -1,7 +1,7 @@
 
 // **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// 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.

data/slice/Ice/PluginF.ice

@@ -1,6 +1,6 @@
 // **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// 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.

data/slice/Ice/Process.ice

@@ -1,6 +1,6 @@
 // **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// 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.
@@ -20,7 +20,7 @@ module Ice
  * An administrative interface for process management. Managed servers must
  * implement this interface.
  *
- * <p class="Note">A servant implementing this interface is a potential target
+ * A servant implementing this interface is a potential target
  * for denial-of-service attacks, therefore proper security precautions
  * should be taken. For example, the servant can use a UUID to make its
  * identity harder to guess, and be registered in an object adapter with
@@ -38,7 +38,6 @@ interface Process
      **/
     void shutdown();
 
-
     /**
      *
      * Write a message on the process' stdout or stderr.

data/slice/Ice/ProcessF.ice

@@ -1,6 +1,6 @@
 // **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// 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.

data/slice/Ice/Properties.ice

@@ -1,6 +1,6 @@
 // **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// 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.

data/slice/Ice/PropertiesAdmin.ice

@@ -1,6 +1,6 @@
 // **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// 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.

data/slice/Ice/PropertiesF.ice

@@ -1,6 +1,6 @@
 // **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// 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.

data/slice/Ice/RemoteLogger.ice

@@ -1,6 +1,6 @@
 // **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// 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.
@@ -122,29 +122,21 @@ interface RemoteLogger
 {
     /**
      *
-     * init is called by {@link LoggerAdmin#attachRemoteLogger} when a
-     * RemoteLogger proxy is attached.
+     * init is called by attachRemoteLogger when a RemoteLogger proxy is attached.
      *
-     * @param prefix The prefix of the associated local {@link Logger}
+     * @param prefix The prefix of the associated local Logger.
      *
      * @param logMessages Old log messages generated before "now".
      *
-     * @see LoggerAdmin#attachRemoteLogger
-     *
-     *
      **/
     void init(string prefix, LogMessageSeq logMessages);
 
-
     /**
      *
-     * Log a {@link LogMessage}. Note that log may be called by {@link LoggerAdmin}
-     * before {@link #init}.
+     * Log a LogMessage. Note that log may be called by LoggerAdmin before init.
      *
      * @param message The message to log.
      *
-     * @see Logger
-     *
      **/
     void log(LogMessage message);
 };
@@ -152,9 +144,7 @@ interface RemoteLogger
 
 /**
  *
- * An exception thrown by {@link LoggerAdmin#attachRemoteLogger} to report
- * that the provided {@link RemoteLogger} was previously attached to this
- * {@link LoggerAdmin}.
+ * Thrown when the provided RemoteLogger was previously attached to a LoggerAdmin.
  *
  **/
 exception RemoteLoggerAlreadyAttachedException
@@ -171,9 +161,8 @@ interface LoggerAdmin
 {
     /**
      *
-     * attachRemoteLogger is called to attach a {@link RemoteLogger} object to
-     * the local {@link Logger}.
-     * attachRemoteLogger calls init on the provided {@link RemoteLogger} proxy.
+     * Attaches a RemoteLogger object to the local logger.
+     * attachRemoteLogger calls init on the provided RemoteLogger proxy.
      *
      * @param prx A proxy to the remote logger.
      *
@@ -185,7 +174,7 @@ interface LoggerAdmin
      * An empty list means no filtering (send all trace categories).
      *
      * @param messageMax The maximum number of log messages (of all types) to be provided
-     * to {@link RemoteLogger#init}. A negative value requests all messages available.
+     * to init. A negative value requests all messages available.
      *
      * @throws RemoteLoggerAlreadyAttachedException Raised if this remote logger is already
      * attached to this admin object.
@@ -197,8 +186,7 @@ interface LoggerAdmin
 
     /**
      *
-     * detachRemoteLogger is called to detach a {@link RemoteLogger} object from
-     * the local {@link Logger}.
+     * Detaches a RemoteLogger object from the local logger.
      *
      * @param prx A proxy to the remote logger.
      *
@@ -209,7 +197,7 @@ interface LoggerAdmin
 
     /**
      *
-     * getLog retrieves log messages recently logged.
+     * Retrieves log messages recently logged.
      *
      * @param messageTypes The list of message types that the caller wishes to receive.
      * An empty list means no filtering (send all message types).
@@ -221,7 +209,7 @@ interface LoggerAdmin
      * @param messageMax The maximum number of log messages (of all types) to be returned.
      * A negative value requests all messages available.
      *
-     * @param prefix The prefix of the associated local {@link Logger}.
+     * @param prefix The prefix of the associated local logger.
      *
      * @return The Log messages.
      *

data/slice/Ice/Router.ice

@@ -1,6 +1,6 @@
 // **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// 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.

data/slice/Ice/RouterF.ice

@@ -1,6 +1,6 @@
 // **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// 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.