zeroc-ice 3.7.0 → 3.7.1

data/ext/ice/cpp/include/Ice/Config.h

@@ -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.
@@ -49,15 +49,22 @@ namespace IceInternal
 namespace Ice
 {
 
+/** The mapping for the Slice byte type. */
 typedef unsigned char Byte;
+/** The mapping for the Slice short type. */
 typedef short Short;
+/** The mapping for the Slice int type. */
 typedef int Int;
 #ifdef ICE_CPP11_MAPPING
+/** The mapping for the Slice long type. */
 typedef long long int Long;
 #else
+/** The mapping for the Slice long type. */
 typedef IceUtil::Int64 Long;
 #endif
+/** The mapping for the Slice float type. */
 typedef float Float;
+/** The mapping for the Slice double type. */
 typedef double Double;
 
 }

data/ext/ice/cpp/include/Ice/ConnectionAsync.h

@@ -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.
@@ -18,6 +18,12 @@
 namespace Ice
 {
 
+/**
+ * Type-safe asynchronous callback wrapper class used for calls to
+ * Ice::Connection::begin_flushBatchRequests.
+ * Create a wrapper instance by calling ::Ice::newCallback_Connection_flushBatchRequests.
+ * \headerfile Ice/Ice.h
+ */
 template<class T>
 class CallbackNC_Connection_flushBatchRequests : public Callback_Connection_flushBatchRequests_Base,
                                                  public ::IceInternal::OnewayCallbackNC<T>
@@ -34,6 +40,7 @@ public:
     {
     }
 
+    /// \cond INTERNAL
     virtual void completed(const ::Ice::AsyncResultPtr& result) const
     {
         ::Ice::ConnectionPtr connection = result->getConnection();
@@ -48,8 +55,17 @@ public:
             ::IceInternal::CallbackNC<T>::exception(result, ex);
         }
     }
+    /// \endcond
 };
 
+/**
+ * Creates a callback wrapper instance that delegates to your object.
+ * @param instance The callback object.
+ * @param excb The exception method of the callback object.
+ * @param sentcb The sent method of the callback object.
+ * @return An object that can be passed to an asynchronous invocation of
+ * Ice::Connection::begin_flushBatchRequests.
+ */
 template<class T> Callback_Connection_flushBatchRequestsPtr
 newCallback_Connection_flushBatchRequests(const IceUtil::Handle<T>& instance,
                                           void (T::*excb)(const ::Ice::Exception&),
@@ -58,6 +74,14 @@ newCallback_Connection_flushBatchRequests(const IceUtil::Handle<T>& instance,
     return new CallbackNC_Connection_flushBatchRequests<T>(instance, excb, sentcb);
 }
 
+/**
+ * Creates a callback wrapper instance that delegates to your object.
+ * @param instance The callback object.
+ * @param excb The exception method of the callback object.
+ * @param sentcb The sent method of the callback object.
+ * @return An object that can be passed to an asynchronous invocation of
+ * Ice::Connection::begin_flushBatchRequests.
+ */
 template<class T> Callback_Connection_flushBatchRequestsPtr
 newCallback_Connection_flushBatchRequests(T* instance, void (T::*excb)(const ::Ice::Exception&),
                                           void (T::*sentcb)(bool) = 0)
@@ -65,6 +89,12 @@ newCallback_Connection_flushBatchRequests(T* instance, void (T::*excb)(const ::I
     return new CallbackNC_Connection_flushBatchRequests<T>(instance, excb, sentcb);
 }
 
+/**
+ * Type-safe asynchronous callback wrapper class used for calls to
+ * Ice::Connection::begin_flushBatchRequests.
+ * Create a wrapper instance by calling ::Ice::newCallback_Connection_flushBatchRequests.
+ * \headerfile Ice/Ice.h
+ */
 template<class T, typename CT>
 class Callback_Connection_flushBatchRequests : public Callback_Connection_flushBatchRequests_Base,
                                                public ::IceInternal::OnewayCallback<T, CT>
@@ -81,6 +111,7 @@ public:
     {
     }
 
+    /// \cond INTERNAL
     virtual void completed(const ::Ice::AsyncResultPtr& result) const
     {
         ::Ice::ConnectionPtr connection = result->getConnection();
@@ -95,8 +126,17 @@ public:
             ::IceInternal::Callback<T, CT>::exception(result, ex);
         }
     }
+    /// \endcond
 };
 
+/**
+ * Creates a callback wrapper instance that delegates to your object.
+ * @param instance The callback object.
+ * @param excb The exception method of the callback object.
+ * @param sentcb The sent method of the callback object.
+ * @return An object that can be passed to an asynchronous invocation of
+ * Ice::Connection::begin_flushBatchRequests.
+ */
 template<class T, typename CT> Callback_Connection_flushBatchRequestsPtr
 newCallback_Connection_flushBatchRequests(const IceUtil::Handle<T>& instance,
                                           void (T::*excb)(const ::Ice::Exception&, const CT&),
@@ -105,6 +145,14 @@ newCallback_Connection_flushBatchRequests(const IceUtil::Handle<T>& instance,
     return new Callback_Connection_flushBatchRequests<T, CT>(instance, excb, sentcb);
 }
 
+/**
+ * Creates a callback wrapper instance that delegates to your object.
+ * @param instance The callback object.
+ * @param excb The exception method of the callback object.
+ * @param sentcb The sent method of the callback object.
+ * @return An object that can be passed to an asynchronous invocation of
+ * Ice::Connection::begin_flushBatchRequests.
+ */
 template<class T, typename CT> Callback_Connection_flushBatchRequestsPtr
 newCallback_Connection_flushBatchRequests(T* instance, void (T::*excb)(const ::Ice::Exception&, const CT&),
                                           void (T::*sentcb)(bool, const CT&) = 0)
@@ -112,6 +160,12 @@ newCallback_Connection_flushBatchRequests(T* instance, void (T::*excb)(const ::I
     return new Callback_Connection_flushBatchRequests<T, CT>(instance, excb, sentcb);
 }
 
+/**
+ * Type-safe asynchronous callback wrapper class used for calls to
+ * Ice::Connection::begin_heartbeat.
+ * Create a wrapper instance by calling ::Ice::newCallback_Connection_heartbeat.
+ * \headerfile Ice/Ice.h
+ */
 template<class T>
 class CallbackNC_Connection_heartbeat : public Callback_Connection_heartbeat_Base,
                                         public ::IceInternal::OnewayCallbackNC<T>
@@ -128,6 +182,7 @@ public:
     {
     }
 
+    /// \cond INTERNAL
     virtual void completed(const ::Ice::AsyncResultPtr& __result) const
     {
         ::Ice::ConnectionPtr __con = __result->getConnection();
@@ -142,8 +197,17 @@ public:
             ::IceInternal::CallbackNC<T>::exception(__result, ex);
         }
     }
+    /// \endcond
 };
 
+/**
+ * Creates a callback wrapper instance that delegates to your object.
+ * @param instance The callback object.
+ * @param excb The exception method of the callback object.
+ * @param sentcb The sent method of the callback object.
+ * @return An object that can be passed to an asynchronous invocation of
+ * Ice::Connection::begin_heartbeat.
+ */
 template<class T> Callback_Connection_heartbeatPtr
 newCallback_Connection_heartbeat(const IceUtil::Handle<T>& instance,
                                  void (T::*excb)(const ::Ice::Exception&),
@@ -152,12 +216,26 @@ newCallback_Connection_heartbeat(const IceUtil::Handle<T>& instance,
     return new CallbackNC_Connection_heartbeat<T>(instance, excb, sentcb);
 }
 
+/**
+ * Creates a callback wrapper instance that delegates to your object.
+ * @param instance The callback object.
+ * @param excb The exception method of the callback object.
+ * @param sentcb The sent method of the callback object.
+ * @return An object that can be passed to an asynchronous invocation of
+ * Ice::Connection::begin_heartbeat.
+ */
 template<class T> Callback_Connection_heartbeatPtr
 newCallback_Connection_heartbeat(T* instance, void (T::*excb)(const ::Ice::Exception&), void (T::*sentcb)(bool) = 0)
 {
     return new CallbackNC_Connection_heartbeat<T>(instance, excb, sentcb);
 }
 
+/**
+ * Type-safe asynchronous callback wrapper class used for calls to
+ * Ice::Connection::begin_heartbeat.
+ * Create a wrapper instance by calling ::Ice::newCallback_Connection_heartbeat.
+ * \headerfile Ice/Ice.h
+ */
 template<class T, typename CT>
 class Callback_Connection_heartbeat : public Callback_Connection_heartbeat_Base,
                                       public ::IceInternal::OnewayCallback<T, CT>
@@ -174,6 +252,7 @@ public:
     {
     }
 
+    /// \cond INTERNAL
     virtual void completed(const ::Ice::AsyncResultPtr& __result) const
     {
         ::Ice::ConnectionPtr __con = __result->getConnection();
@@ -188,8 +267,17 @@ public:
             ::IceInternal::Callback<T, CT>::exception(__result, ex);
         }
     }
+    /// \endcond
 };
 
+/**
+ * Creates a callback wrapper instance that delegates to your object.
+ * @param instance The callback object.
+ * @param excb The exception method of the callback object.
+ * @param sentcb The sent method of the callback object.
+ * @return An object that can be passed to an asynchronous invocation of
+ * Ice::Connection::begin_heartbeat.
+ */
 template<class T, typename CT> Callback_Connection_heartbeatPtr
 newCallback_Connection_heartbeat(const IceUtil::Handle<T>& instance,
                                  void (T::*excb)(const ::Ice::Exception&, const CT&),
@@ -198,6 +286,14 @@ newCallback_Connection_heartbeat(const IceUtil::Handle<T>& instance,
     return new Callback_Connection_heartbeat<T, CT>(instance, excb, sentcb);
 }
 
+/**
+ * Creates a callback wrapper instance that delegates to your object.
+ * @param instance The callback object.
+ * @param excb The exception method of the callback object.
+ * @param sentcb The sent method of the callback object.
+ * @return An object that can be passed to an asynchronous invocation of
+ * Ice::Connection::begin_heartbeat.
+ */
 template<class T, typename CT> Callback_Connection_heartbeatPtr
 newCallback_Connection_heartbeat(T* instance, void (T::*excb)(const ::Ice::Exception&, const CT&),
                                  void (T::*sentcb)(bool, const CT&) = 0)

data/ext/ice/cpp/include/Ice/ConnectionIF.h

@@ -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.
@@ -16,6 +16,7 @@
 namespace Ice
 {
 
+/// \cond INTERNAL
 class ConnectionI;
 #ifdef ICE_CPP11_MAPPING // C++11 mapping
 using ConnectionIPtr = ::std::shared_ptr<ConnectionI>;
@@ -23,6 +24,7 @@ using ConnectionIPtr = ::std::shared_ptr<ConnectionI>;
 ICE_API Ice::LocalObject* upCast(Ice::ConnectionI*);
 typedef IceInternal::Handle<ConnectionI> ConnectionIPtr;
 #endif
+/// \endcond
 
 }
 

data/ext/ice/cpp/include/Ice/ConsoleUtil.h

@@ -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/ext/ice/cpp/include/Ice/DefaultValueFactory.h

@@ -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/ext/ice/cpp/include/Ice/DispatchInterceptor.h

@@ -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.
@@ -15,13 +15,28 @@
 namespace Ice
 {
 
+/**
+ * Base class for a dispatch interceptor, which is a servant that dispatches requests
+ * to another servant. A subclass must implement the dispatch method. A dispatch interceptor
+ * can be registered with an object adapter just like any other servant.
+ * \headerfile Ice/Ice.h
+ */
 class ICE_API DispatchInterceptor : public virtual Object
 {
 public:
 
-    virtual bool dispatch(Request&) = 0;
+    /**
+     * Called by the Ice run time when a new request needs to be dispatched. The implementation
+     * must eventually call ice_dispatch on the delegate servant and pass the given request object.
+     * @param req An opaque object representing the request to be dispatched.
+     * @return True if the request was dispatched synchronously, or false if the request was
+     * dispatched asynchronously.
+     */
+    virtual bool dispatch(Request& req) = 0;
 
+    /// \cond INTERNAL
     virtual bool _iceDispatch(IceInternal::Incoming&, const Current&);
+    /// \endcond
 };
 
 ICE_DEFINE_PTR(DispatchInterceptorPtr, DispatchInterceptor);

data/ext/ice/cpp/include/Ice/Dispatcher.h

@@ -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,24 +24,44 @@
 namespace Ice
 {
 
+/**
+ * Encapsulates all the details of a request dispatch or AMI callback.
+ * The application must eventually invoke run to dispatch the call.
+ * \headerfile Ice/Ice.h
+ */
 class ICE_API DispatcherCall : public virtual IceUtil::Shared
 {
 public:
 
     virtual ~DispatcherCall();
 
+    /**
+     * Dispatches the call.
+     */
     virtual void run() = 0;
 };
 
 typedef IceUtil::Handle<DispatcherCall> DispatcherCallPtr;
 
+/**
+ * Base class for a dispatcher. A subclass must define the dispatch method.
+ * The dispatcher can be installed via InitializationData.
+ * \headerfile Ice/Ice.h
+ */
 class ICE_API Dispatcher : public virtual IceUtil::Shared
 {
 public:
 
     virtual ~Dispatcher();
 
-    virtual void dispatch(const DispatcherCallPtr&, const ConnectionPtr&) = 0;
+    /**
+     * Called by the Ice run time when an incoming request or an AMI callback needs to
+     * be dispatched. The implementation must eventually invoke run on the call object.
+     * @param call An object representing the call that must be dispatched.
+     * @param connection The connection object associated with the call, or nil if no
+     * connection is associated with the call.
+     */
+    virtual void dispatch(const DispatcherCallPtr& call, const ConnectionPtr& connection) = 0;
 };
 
 typedef IceUtil::Handle<Dispatcher> DispatcherPtr;

data/ext/ice/cpp/include/Ice/DynamicLibrary.h

@@ -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/ext/ice/cpp/include/Ice/DynamicLibraryF.h

@@ -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/ext/ice/cpp/include/Ice/Exception.h

@@ -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.
@@ -26,14 +26,20 @@ class InputStream;
 
 typedef IceUtil::Exception Exception;
 
-//
-// Base class for all Ice run-time exceptions
-//
+/**
+ * Base class for all Ice run-time exceptions.
+ * \headerfile Ice/Ice.h
+ */
 class ICE_API LocalException : public IceUtil::Exception
 {
 public:
 
-    LocalException(const char*, int);
+    /**
+     * The file and line number are required for all local exceptions.
+     * @param file The file name in which the exception was raised, typically __FILE__.
+     * @param line The line number at which the exception was raised, typically __LINE__.
+     */
+    LocalException(const char* file, int line);
 
 #ifdef ICE_CPP11_COMPILER
     LocalException(const LocalException&) = default;
@@ -42,22 +48,35 @@ public:
     virtual ~LocalException() throw();
 #endif
 
+    /**
+     * Polymporphically clones this exception.
+     * @return A shallow copy of this exception.
+     */
 #ifdef ICE_CPP11_MAPPING
     std::unique_ptr<LocalException> ice_clone() const;
 #else
     virtual LocalException* ice_clone() const = 0;
 #endif
 
+    /**
+     * Obtains the Slice type ID of this exception.
+     * @return The fully-scoped type ID.
+     */
     static const std::string& ice_staticId();
 };
 
-//
-// Base class for all Ice user exceptions
-//
+/**
+ * Base class for all Ice user exceptions.
+ * \headerfile Ice/Ice.h
+ */
 class ICE_API UserException : public IceUtil::Exception
 {
 public:
 
+    /**
+     * Polymporphically clones this exception.
+     * @return A shallow copy of this exception.
+     */
 #ifdef ICE_CPP11_MAPPING
     std::unique_ptr<UserException> ice_clone() const;
 #else
@@ -65,30 +84,45 @@ public:
 #endif
     virtual Ice::SlicedDataPtr ice_getSlicedData() const;
 
+    /**
+     * Obtains the Slice type ID of this exception.
+     * @return The fully-scoped type ID.
+     */
     static const std::string& ice_staticId();
 
+    /// \cond STREAM
     virtual void _write(::Ice::OutputStream*) const;
     virtual void _read(::Ice::InputStream*);
 
     virtual bool _usesClasses() const;
+    /// \endcond
 
 protected:
 
+    /// \cond STREAM
     virtual void _writeImpl(::Ice::OutputStream*) const {}
     virtual void _readImpl(::Ice::InputStream*) {}
+    /// \endcond
 };
 
-//
-// Base class for all Ice system exceptions
-//
-// System exceptions are currently Ice internal, non-documented
-// exceptions.
-//
+/**
+ * Base class for all Ice system exceptions.
+ *
+ * System exceptions are currently Ice internal, non-documented
+ * exceptions.
+ * \headerfile Ice/Ice.h
+ */
 class ICE_API SystemException : public IceUtil::Exception
 {
 public:
 
-    SystemException(const char*, int);
+    /**
+     * The file and line number are required for all local exceptions.
+     * @param file The file name in which the exception was raised, typically __FILE__.
+     * @param line The line number at which the exception was raised, typically __LINE__.
+     */
+    SystemException(const char* file, int line);
+
 #ifdef ICE_CPP11_COMPILER
     SystemException(const SystemException&) = default;
     virtual ~SystemException();
@@ -96,12 +130,20 @@ public:
     virtual ~SystemException() throw();
 #endif
 
+    /**
+     * Polymporphically clones this exception.
+     * @return A shallow copy of this exception.
+     */
 #ifdef ICE_CPP11_MAPPING
     std::unique_ptr<SystemException> ice_clone() const;
 #else
     virtual SystemException* ice_clone() const = 0;
 #endif
 
+    /**
+     * Obtains the Slice type ID of this exception.
+     * @return The fully-scoped type ID.
+     */
     static const std::string& ice_staticId();
 };