zeroc-ice 3.7.0 → 3.7.1

data/ext/ice/cpp/include/generated/Ice/ValueFactory.h

@@ -1,13 +1,13 @@
 // **********************************************************************
 //
-// 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.
 //
 // **********************************************************************
 //
-// Ice version 3.7.0
+// Ice version 3.7.1
 //
 // <auto-generated>
 //
@@ -40,7 +40,7 @@
 #   if ICE_INT_VERSION % 100 > 50
 #       error Beta header file detected
 #   endif
-#   if ICE_INT_VERSION % 100 < 0
+#   if ICE_INT_VERSION % 100 < 1
 #       error Ice patch level mismatch!
 #   endif
 #endif
@@ -67,32 +67,102 @@ class ValueFactoryManager;
 namespace Ice
 {
 
-using ValueFactory = ::std::function<::std::shared_ptr<::Ice::Value>(const ::std::string&)>;
-
+/**
+ * Create a new value for a given value type. The type is the
+ * absolute Slice type id, i.e., the id relative to the
+ * unnamed top-level Slice module. For example, the absolute
+ * Slice type id for an interface <tt>Bar</tt> in the module
+ * <tt>Foo</tt> is <tt>"::Foo::Bar"</tt>.
+ *
+ * Note that the leading "<tt>::</tt>" is required.
+ * @param type The value type.
+ * @return The value created for the given type, or nil if the
+ * factory is unable to create the value.
+ */
+using ValueFactory = ::std::function<::std::shared_ptr<Value>(const ::std::string& type)>;
+
+/**
+ * A value factory manager maintains a collection of value factories.
+ * An application can supply a custom implementation during communicator
+ * initialization, otherwise Ice provides a default implementation.
+ * @see ValueFactory
+ * \headerfile Ice/Ice.h
+ */
 class ICE_CLASS(ICE_API) ValueFactoryManager
 {
 public:
 
     ICE_MEMBER(ICE_API) virtual ~ValueFactoryManager();
 
-    virtual void add(::Ice::ValueFactory, const ::std::string&) = 0;
-
-    virtual ::Ice::ValueFactory find(const ::std::string&) const = 0;
+    /**
+     * Add a value factory. Attempting to add a factory with an id for
+     * which a factory is already registered throws AlreadyRegisteredException.
+     *
+     * When unmarshaling an Ice value, 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 value was marshaled:
+     *
+     * If the value 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 NoValueFactoryException.
+     *
+     * If the value uses the "compact" format, Ice immediately raises
+     * NoValueFactoryException.
+     *
+     * The following order is used to locate a factory for a type:
+     *
+     * <ol>
+     *
+     * <li>The Ice run-time looks for a factory registered
+     * specifically for the type.</li>
+     *
+     * <li>If no instance has been created, the Ice run-time looks
+     * for the default factory, which is registered with an empty type id.
+     * </li>
+     *
+     * <li>If no instance has been created by any of the preceding
+     * steps, the Ice run-time looks for a factory that may have been
+     * statically generated by the language mapping for non-abstract classes.
+     * </li>
+     *
+     * </ol>
+     * @param factory The factory to add.
+     * @param id The type id for which the factory can create instances, or
+     * an empty string for the default factory.
+     */
+    virtual void add(ValueFactory factory, const ::std::string& id) = 0;
+
+    /**
+     * Find an value factory registered with this communicator.
+     * @param id The type id for which the factory can create instances,
+     * or an empty string for the default factory.
+     * @return The value factory, or null if no value factory was
+     * found for the given id.
+     */
+    virtual ::Ice::ValueFactory find(const ::std::string& id) const noexcept = 0;
 };
 
 }
 
+/// \cond STREAM
 namespace Ice
 {
 
 }
+/// \endcond
 
+/// \cond INTERNAL
 namespace Ice
 {
 
 using ValueFactoryManagerPtr = ::std::shared_ptr<ValueFactoryManager>;
 
 }
+/// \endcond
 
 #else // C++98 mapping
 
@@ -100,19 +170,31 @@ namespace Ice
 {
 
 class ValueFactory;
-ICE_API ::Ice::LocalObject* upCast(::Ice::ValueFactory*);
-typedef ::IceInternal::Handle< ::Ice::ValueFactory> ValueFactoryPtr;
+/// \cond INTERNAL
+ICE_API LocalObject* upCast(ValueFactory*);
+/// \endcond
+typedef ::IceInternal::Handle< ValueFactory> ValueFactoryPtr;
 
 class ValueFactoryManager;
-ICE_API ::Ice::LocalObject* upCast(::Ice::ValueFactoryManager*);
-typedef ::IceInternal::Handle< ::Ice::ValueFactoryManager> ValueFactoryManagerPtr;
+/// \cond INTERNAL
+ICE_API LocalObject* upCast(ValueFactoryManager*);
+/// \endcond
+typedef ::IceInternal::Handle< ValueFactoryManager> ValueFactoryManagerPtr;
 
 }
 
 namespace Ice
 {
 
-class ICE_API ValueFactory : public virtual ::Ice::LocalObject
+/**
+ * A factory for values. Value factories are used in several
+ * places, such as when Ice receives a class instance and
+ * when Freeze restores a persistent value. Value factories
+ * must be implemented by the application writer and registered
+ * with the communicator.
+ * \headerfile Ice/Ice.h
+ */
+class ICE_API ValueFactory : public virtual LocalObject
 {
 public:
 
@@ -120,20 +202,41 @@ public:
 
     virtual ~ValueFactory();
 
-    virtual ::Ice::ValuePtr create(const ::std::string&) = 0;
+    /**
+     * Create a new value for a given value type. The type is the
+     * absolute Slice type id, i.e., the id relative to the
+     * unnamed top-level Slice module. For example, the absolute
+     * Slice type id for an interface <tt>Bar</tt> in the module
+     * <tt>Foo</tt> is <tt>"::Foo::Bar"</tt>.
+     *
+     * Note that the leading "<tt>::</tt>" is required.
+     * @param type The value type.
+     * @return The value created for the given type, or nil if the
+     * factory is unable to create the value.
+     */
+    virtual ValuePtr create(const ::std::string& type) = 0;
 };
 
+/// \cond INTERNAL
 inline bool operator==(const ValueFactory& lhs, const ValueFactory& rhs)
 {
-    return static_cast<const ::Ice::LocalObject&>(lhs) == static_cast<const ::Ice::LocalObject&>(rhs);
+    return static_cast<const LocalObject&>(lhs) == static_cast<const LocalObject&>(rhs);
 }
 
 inline bool operator<(const ValueFactory& lhs, const ValueFactory& rhs)
 {
-    return static_cast<const ::Ice::LocalObject&>(lhs) < static_cast<const ::Ice::LocalObject&>(rhs);
+    return static_cast<const LocalObject&>(lhs) < static_cast<const LocalObject&>(rhs);
 }
-
-class ICE_API ValueFactoryManager : public virtual ::Ice::LocalObject
+/// \endcond
+
+/**
+ * A value factory manager maintains a collection of value factories.
+ * An application can supply a custom implementation during communicator
+ * initialization, otherwise Ice provides a default implementation.
+ * @see ValueFactory
+ * \headerfile Ice/Ice.h
+ */
+class ICE_API ValueFactoryManager : public virtual LocalObject
 {
 public:
 
@@ -141,27 +244,78 @@ public:
 
     virtual ~ValueFactoryManager();
 
-    virtual void add(const ::Ice::ValueFactoryPtr&, const ::std::string&) = 0;
-
-    virtual ::Ice::ValueFactoryPtr find(const ::std::string&) const = 0;
+    /**
+     * Add a value factory. Attempting to add a factory with an id for
+     * which a factory is already registered throws AlreadyRegisteredException.
+     *
+     * When unmarshaling an Ice value, 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 value was marshaled:
+     *
+     * If the value 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 NoValueFactoryException.
+     *
+     * If the value uses the "compact" format, Ice immediately raises
+     * NoValueFactoryException.
+     *
+     * The following order is used to locate a factory for a type:
+     *
+     * <ol>
+     *
+     * <li>The Ice run-time looks for a factory registered
+     * specifically for the type.</li>
+     *
+     * <li>If no instance has been created, the Ice run-time looks
+     * for the default factory, which is registered with an empty type id.
+     * </li>
+     *
+     * <li>If no instance has been created by any of the preceding
+     * steps, the Ice run-time looks for a factory that may have been
+     * statically generated by the language mapping for non-abstract classes.
+     * </li>
+     *
+     * </ol>
+     * @param factory The factory to add.
+     * @param id The type id for which the factory can create instances, or
+     * an empty string for the default factory.
+     */
+    virtual void add(const ValueFactoryPtr& factory, const ::std::string& id) = 0;
+
+    /**
+     * Find an value factory registered with this communicator.
+     * @param id The type id for which the factory can create instances,
+     * or an empty string for the default factory.
+     * @return The value factory, or null if no value factory was
+     * found for the given id.
+     */
+    virtual ValueFactoryPtr find(const ::std::string& id) const ICE_NOEXCEPT = 0;
 };
 
+/// \cond INTERNAL
 inline bool operator==(const ValueFactoryManager& lhs, const ValueFactoryManager& rhs)
 {
-    return static_cast<const ::Ice::LocalObject&>(lhs) == static_cast<const ::Ice::LocalObject&>(rhs);
+    return static_cast<const LocalObject&>(lhs) == static_cast<const LocalObject&>(rhs);
 }
 
 inline bool operator<(const ValueFactoryManager& lhs, const ValueFactoryManager& rhs)
 {
-    return static_cast<const ::Ice::LocalObject&>(lhs) < static_cast<const ::Ice::LocalObject&>(rhs);
+    return static_cast<const LocalObject&>(lhs) < static_cast<const LocalObject&>(rhs);
 }
+/// \endcond
 
 }
 
+/// \cond STREAM
 namespace Ice
 {
 
 }
+/// \endcond
 
 #endif
 

data/ext/ice/cpp/include/generated/Ice/Version.h

@@ -1,13 +1,13 @@
 // **********************************************************************
 //
-// 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.
 //
 // **********************************************************************
 //
-// Ice version 3.7.0
+// Ice version 3.7.1
 //
 // <auto-generated>
 //
@@ -40,7 +40,7 @@
 #   if ICE_INT_VERSION % 100 > 50
 #       error Beta header file detected
 #   endif
-#   if ICE_INT_VERSION % 100 < 0
+#   if ICE_INT_VERSION % 100 < 1
 #       error Ice patch level mismatch!
 #   endif
 #endif
@@ -60,23 +60,41 @@
 namespace Ice
 {
 
+/**
+ * A version structure for the protocol version.
+ * \headerfile Ice/Ice.h
+ */
 struct ProtocolVersion
 {
-    ::Ice::Byte major;
-    ::Ice::Byte minor;
+    Byte major;
+    Byte minor;
 
-    std::tuple<const ::Ice::Byte&, const ::Ice::Byte&> ice_tuple() const
+    /**
+     * Obtains a tuple containing all of the exception's data members.
+     * @return The data members in a tuple.
+     */
+
+    std::tuple<const Byte&, const Byte&> ice_tuple() const
     {
         return std::tie(major, minor);
     }
 };
 
+/**
+ * A version structure for the encoding version.
+ * \headerfile Ice/Ice.h
+ */
 struct EncodingVersion
 {
-    ::Ice::Byte major;
-    ::Ice::Byte minor;
+    Byte major;
+    Byte minor;
+
+    /**
+     * Obtains a tuple containing all of the exception's data members.
+     * @return The data members in a tuple.
+     */
 
-    std::tuple<const ::Ice::Byte&, const ::Ice::Byte&> ice_tuple() const
+    std::tuple<const Byte&, const Byte&> ice_tuple() const
     {
         return std::tie(major, minor);
     }
@@ -91,6 +109,7 @@ using Ice::operator!=;
 
 }
 
+/// \cond STREAM
 namespace Ice
 {
 
@@ -129,16 +148,21 @@ struct StreamReader<::Ice::EncodingVersion, S>
 };
 
 }
+/// \endcond
 
 #else // C++98 mapping
 
 namespace Ice
 {
 
+/**
+ * A version structure for the protocol version.
+ * \headerfile Ice/Ice.h
+ */
 struct ProtocolVersion
 {
-    ::Ice::Byte major;
-    ::Ice::Byte minor;
+    Byte major;
+    Byte minor;
 
     bool operator==(const ProtocolVersion& rhs_) const
     {
@@ -200,10 +224,14 @@ struct ProtocolVersion
     }
 };
 
+/**
+ * A version structure for the encoding version.
+ * \headerfile Ice/Ice.h
+ */
 struct EncodingVersion
 {
-    ::Ice::Byte major;
-    ::Ice::Byte minor;
+    Byte major;
+    Byte minor;
 
     bool operator==(const EncodingVersion& rhs_) const
     {
@@ -267,6 +295,7 @@ struct EncodingVersion
 
 }
 
+/// \cond STREAM
 namespace Ice
 {
 
@@ -327,6 +356,7 @@ struct StreamReader< ::Ice::EncodingVersion, S>
 };
 
 }
+/// \endcond
 
 #endif
 

data/ext/ice/cpp/include/generated/IceSSL/ConnectionInfo.h

@@ -1,13 +1,13 @@
 // **********************************************************************
 //
-// 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.
 //
 // **********************************************************************
 //
-// Ice version 3.7.0
+// Ice version 3.7.1
 //
 // <auto-generated>
 //
@@ -43,7 +43,7 @@
 #   if ICE_INT_VERSION % 100 > 50
 #       error Beta header file detected
 #   endif
-#   if ICE_INT_VERSION % 100 < 0
+#   if ICE_INT_VERSION % 100 < 1
 #       error Ice patch level mismatch!
 #   endif
 #endif
@@ -70,6 +70,10 @@ class ConnectionInfo;
 namespace IceSSL
 {
 
+/**
+ * Provides access to the connection details of an SSL connection
+ * \headerfile IceSSL/IceSSL.h
+ */
 class ICE_CLASS(ICESSL_API) ConnectionInfo : public ::Ice::ConnectionInfo
 {
 public:
@@ -83,32 +87,55 @@ public:
     ConnectionInfo& operator=(const ConnectionInfo&) = default;
     ConnectionInfo& operator=(ConnectionInfo&&) = default;
 
-    ConnectionInfo(const ::std::shared_ptr<::Ice::ConnectionInfo>& iceP_underlying, bool iceP_incoming, const ::std::string& iceP_adapterName, const ::std::string& iceP_connectionId, const ::std::string& iceP_cipher, const std::vector<CertificatePtr>& iceP_certs, bool iceP_verified) :
-        ::Ice::ConnectionInfo(::std::move(iceP_underlying), iceP_incoming, ::std::move(iceP_adapterName), ::std::move(iceP_connectionId)),
-        cipher(::std::move(iceP_cipher)),
-        certs(::std::move(iceP_certs)),
-        verified(iceP_verified)
+    /**
+     * One-shot constructor to initialize all data members.
+     * @param underlying The information of the underyling transport or null if there's no underlying transport.
+     * @param incoming Whether or not the connection is an incoming or outgoing connection.
+     * @param adapterName The name of the adapter associated with the connection.
+     * @param connectionId The connection id.
+     * @param cipher The negotiated cipher suite.
+     * @param certs The certificate chain.
+     * @param verified The certificate chain verification status.
+     */
+    ConnectionInfo(const ::std::shared_ptr<::Ice::ConnectionInfo>& underlying, bool incoming, const ::std::string& adapterName, const ::std::string& connectionId, const ::std::string& cipher, const std::vector<CertificatePtr>& certs, bool verified) :
+        ::Ice::ConnectionInfo(::std::move(underlying), incoming, ::std::move(adapterName), ::std::move(connectionId)),
+        cipher(::std::move(cipher)),
+        certs(::std::move(certs)),
+        verified(verified)
     {
     }
 
+    /**
+     * The negotiated cipher suite.
+     */
     ::std::string cipher;
+    /**
+     * The certificate chain.
+     */
     std::vector<CertificatePtr> certs;
+    /**
+     * The certificate chain verification status.
+     */
     bool verified;
 };
 
 }
 
+/// \cond STREAM
 namespace Ice
 {
 
 }
+/// \endcond
 
+/// \cond INTERNAL
 namespace IceSSL
 {
 
 using ConnectionInfoPtr = ::std::shared_ptr<ConnectionInfo>;
 
 }
+/// \endcond
 
 #else // C++98 mapping
 
@@ -116,14 +143,20 @@ namespace IceSSL
 {
 
 class ConnectionInfo;
-ICESSL_API ::Ice::LocalObject* upCast(::IceSSL::ConnectionInfo*);
-typedef ::IceInternal::Handle< ::IceSSL::ConnectionInfo> ConnectionInfoPtr;
+/// \cond INTERNAL
+ICESSL_API ::Ice::LocalObject* upCast(ConnectionInfo*);
+/// \endcond
+typedef ::IceInternal::Handle< ConnectionInfo> ConnectionInfoPtr;
 
 }
 
 namespace IceSSL
 {
 
+/**
+ * Provides access to the connection details of an SSL connection
+ * \headerfile IceSSL/IceSSL.h
+ */
 class ICESSL_API ConnectionInfo : public ::Ice::ConnectionInfo
 {
 public:
@@ -136,19 +169,39 @@ public:
     {
     }
 
-    ConnectionInfo(const ::Ice::ConnectionInfoPtr& iceP_underlying, bool iceP_incoming, const ::std::string& iceP_adapterName, const ::std::string& iceP_connectionId, const ::std::string& iceP_cipher, const std::vector<CertificatePtr>& iceP_certs, bool iceP_verified) :
-        ::Ice::ConnectionInfo(iceP_underlying, iceP_incoming, iceP_adapterName, iceP_connectionId),
-        cipher(iceP_cipher),
-        certs(iceP_certs),
-        verified(iceP_verified)
+    /**
+     * One-shot constructor to initialize all data members.
+     * @param underlying The information of the underyling transport or null if there's no underlying transport.
+     * @param incoming Whether or not the connection is an incoming or outgoing connection.
+     * @param adapterName The name of the adapter associated with the connection.
+     * @param connectionId The connection id.
+     * @param cipher The negotiated cipher suite.
+     * @param certs The certificate chain.
+     * @param verified The certificate chain verification status.
+     */
+    ConnectionInfo(const ::Ice::ConnectionInfoPtr& underlying, bool incoming, const ::std::string& adapterName, const ::std::string& connectionId, const ::std::string& cipher, const std::vector<CertificatePtr>& certs, bool verified) :
+        ::Ice::ConnectionInfo(underlying, incoming, adapterName, connectionId),
+        cipher(cipher),
+        certs(certs),
+        verified(verified)
     {
     }
 
+    /**
+     * The negotiated cipher suite.
+     */
     ::std::string cipher;
+    /**
+     * The certificate chain.
+     */
     std::vector<CertificatePtr> certs;
+    /**
+     * The certificate chain verification status.
+     */
     bool verified;
 };
 
+/// \cond INTERNAL
 inline bool operator==(const ConnectionInfo& lhs, const ConnectionInfo& rhs)
 {
     return static_cast<const ::Ice::LocalObject&>(lhs) == static_cast<const ::Ice::LocalObject&>(rhs);
@@ -158,13 +211,16 @@ inline bool operator<(const ConnectionInfo& lhs, const ConnectionInfo& rhs)
 {
     return static_cast<const ::Ice::LocalObject&>(lhs) < static_cast<const ::Ice::LocalObject&>(rhs);
 }
+/// \endcond
 
 }
 
+/// \cond STREAM
 namespace Ice
 {
 
 }
+/// \endcond
 
 #endif