zeroc-ice 3.7.0 → 3.7.1

data/ext/ice/cpp/include/generated/Ice/EndpointF.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
@@ -72,15 +72,21 @@ class Endpoint;
 namespace Ice
 {
 
-using EndpointSeq = ::std::vector<::std::shared_ptr<::Ice::Endpoint>>;
+/**
+ * A sequence of endpoints.
+ */
+using EndpointSeq = ::std::vector<::std::shared_ptr<Endpoint>>;
 
 }
 
+/// \cond STREAM
 namespace Ice
 {
 
 }
+/// \endcond
 
+/// \cond INTERNAL
 namespace Ice
 {
 
@@ -97,6 +103,7 @@ using WSEndpointInfoPtr = ::std::shared_ptr<WSEndpointInfo>;
 using EndpointPtr = ::std::shared_ptr<Endpoint>;
 
 }
+/// \endcond
 
 #else // C++98 mapping
 
@@ -104,42 +111,59 @@ namespace Ice
 {
 
 class EndpointInfo;
-ICE_API ::Ice::LocalObject* upCast(::Ice::EndpointInfo*);
-typedef ::IceInternal::Handle< ::Ice::EndpointInfo> EndpointInfoPtr;
+/// \cond INTERNAL
+ICE_API LocalObject* upCast(EndpointInfo*);
+/// \endcond
+typedef ::IceInternal::Handle< EndpointInfo> EndpointInfoPtr;
 
 class IPEndpointInfo;
-ICE_API ::Ice::LocalObject* upCast(::Ice::IPEndpointInfo*);
-typedef ::IceInternal::Handle< ::Ice::IPEndpointInfo> IPEndpointInfoPtr;
+/// \cond INTERNAL
+ICE_API LocalObject* upCast(IPEndpointInfo*);
+/// \endcond
+typedef ::IceInternal::Handle< IPEndpointInfo> IPEndpointInfoPtr;
 
 class TCPEndpointInfo;
-ICE_API ::Ice::LocalObject* upCast(::Ice::TCPEndpointInfo*);
-typedef ::IceInternal::Handle< ::Ice::TCPEndpointInfo> TCPEndpointInfoPtr;
+/// \cond INTERNAL
+ICE_API LocalObject* upCast(TCPEndpointInfo*);
+/// \endcond
+typedef ::IceInternal::Handle< TCPEndpointInfo> TCPEndpointInfoPtr;
 
 class UDPEndpointInfo;
-ICE_API ::Ice::LocalObject* upCast(::Ice::UDPEndpointInfo*);
-typedef ::IceInternal::Handle< ::Ice::UDPEndpointInfo> UDPEndpointInfoPtr;
+/// \cond INTERNAL
+ICE_API LocalObject* upCast(UDPEndpointInfo*);
+/// \endcond
+typedef ::IceInternal::Handle< UDPEndpointInfo> UDPEndpointInfoPtr;
 
 class WSEndpointInfo;
-ICE_API ::Ice::LocalObject* upCast(::Ice::WSEndpointInfo*);
-typedef ::IceInternal::Handle< ::Ice::WSEndpointInfo> WSEndpointInfoPtr;
+/// \cond INTERNAL
+ICE_API LocalObject* upCast(WSEndpointInfo*);
+/// \endcond
+typedef ::IceInternal::Handle< WSEndpointInfo> WSEndpointInfoPtr;
 
 class Endpoint;
-ICE_API ::Ice::LocalObject* upCast(::Ice::Endpoint*);
-typedef ::IceInternal::Handle< ::Ice::Endpoint> EndpointPtr;
+/// \cond INTERNAL
+ICE_API LocalObject* upCast(Endpoint*);
+/// \endcond
+typedef ::IceInternal::Handle< Endpoint> EndpointPtr;
 
 }
 
 namespace Ice
 {
 
-typedef ::std::vector< ::Ice::EndpointPtr> EndpointSeq;
+/**
+ * A sequence of endpoints.
+ */
+typedef ::std::vector<Ice::EndpointPtr> EndpointSeq;
 
 }
 
+/// \cond STREAM
 namespace Ice
 {
 
 }
+/// \endcond
 
 #endif
 

data/ext/ice/cpp/include/generated/Ice/EndpointTypes.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,36 +60,62 @@
 namespace Ice
 {
 
+/**
+ * Determines the order in which the Ice run time uses the endpoints
+ * in a proxy when establishing a connection.
+ */
 enum class EndpointSelectionType : unsigned char
 {
+    /**
+     * <tt>Random</tt> causes the endpoints to be arranged in a random order.
+     */
     Random,
+    /**
+     * <tt>Ordered</tt> forces the Ice run time to use the endpoints in the
+     * order they appeared in the proxy.
+     */
     Ordered
 };
 
 }
 
+/// \cond STREAM
 namespace Ice
 {
 
 }
+/// \endcond
 
 #else // C++98 mapping
 
 namespace Ice
 {
 
+/**
+ * Determines the order in which the Ice run time uses the endpoints
+ * in a proxy when establishing a connection.
+ */
 enum EndpointSelectionType
 {
+    /**
+     * <tt>Random</tt> causes the endpoints to be arranged in a random order.
+     */
     Random,
+    /**
+     * <tt>Ordered</tt> forces the Ice run time to use the endpoints in the
+     * order they appeared in the proxy.
+     */
     Ordered
 };
 
 }
 
+/// \cond STREAM
 namespace Ice
 {
 
 }
+/// \endcond
 
 #endif
 

data/ext/ice/cpp/include/generated/Ice/FacetMap.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,7 +60,10 @@
 namespace Ice
 {
 
-using FacetMap = ::std::map<::std::string, ::std::shared_ptr<::Ice::Object>>;
+/**
+ * A mapping from facet name to servant.
+ */
+using FacetMap = ::std::map<::std::string, ::std::shared_ptr<Object>>;
 
 }
 
@@ -69,7 +72,10 @@ using FacetMap = ::std::map<::std::string, ::std::shared_ptr<::Ice::Object>>;
 namespace Ice
 {
 
-typedef ::std::map< ::std::string, ::Ice::ObjectPtr> FacetMap;
+/**
+ * A mapping from facet name to servant.
+ */
+typedef ::std::map< ::std::string, Ice::ObjectPtr> FacetMap;
 
 }
 

data/ext/ice/cpp/include/generated/Ice/Identity.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,20 +60,45 @@
 namespace Ice
 {
 
+/**
+ * The identity of an Ice object. In a proxy, an empty {@link Identity#name} denotes a nil
+ * proxy. An identity with an empty {@link Identity#name} and a non-empty {@link Identity#category}
+ * is illegal. You cannot add a servant with an empty name to the Active Servant Map.
+ * @see ServantLocator
+ * @see ObjectAdapter#addServantLocator
+ * \headerfile Ice/Ice.h
+ */
 struct Identity
 {
+    /**
+     * The name of the Ice object.
+     */
     ::std::string name;
+    /**
+     * The Ice object category.
+     */
     ::std::string category;
 
+    /**
+     * Obtains a tuple containing all of the exception's data members.
+     * @return The data members in a tuple.
+     */
+
     std::tuple<const ::std::string&, const ::std::string&> ice_tuple() const
     {
         return std::tie(name, category);
     }
 };
 
-using ObjectDict = ::std::map<::Ice::Identity, ::std::shared_ptr<::Ice::Object>>;
+/**
+ * A mapping between identities and Ice objects.
+ */
+using ObjectDict = ::std::map<Identity, ::std::shared_ptr<Object>>;
 
-using IdentitySeq = ::std::vector<::Ice::Identity>;
+/**
+ * A sequence of identities.
+ */
+using IdentitySeq = ::std::vector<Identity>;
 
 using Ice::operator<;
 using Ice::operator<=;
@@ -84,6 +109,7 @@ using Ice::operator!=;
 
 }
 
+/// \cond STREAM
 namespace Ice
 {
 
@@ -105,15 +131,30 @@ struct StreamReader<::Ice::Identity, S>
 };
 
 }
+/// \endcond
 
 #else // C++98 mapping
 
 namespace Ice
 {
 
+/**
+ * The identity of an Ice object. In a proxy, an empty {@link Identity#name} denotes a nil
+ * proxy. An identity with an empty {@link Identity#name} and a non-empty {@link Identity#category}
+ * is illegal. You cannot add a servant with an empty name to the Active Servant Map.
+ * @see ServantLocator
+ * @see ObjectAdapter#addServantLocator
+ * \headerfile Ice/Ice.h
+ */
 struct Identity
 {
+    /**
+     * The name of the Ice object.
+     */
     ::std::string name;
+    /**
+     * The Ice object category.
+     */
     ::std::string category;
 
     bool operator==(const Identity& rhs_) const
@@ -176,12 +217,19 @@ struct Identity
     }
 };
 
-typedef ::std::map< ::Ice::Identity, ::Ice::ObjectPtr> ObjectDict;
+/**
+ * A mapping between identities and Ice objects.
+ */
+typedef ::std::map<Ice::Identity, Ice::ObjectPtr> ObjectDict;
 
-typedef ::std::vector< ::Ice::Identity> IdentitySeq;
+/**
+ * A sequence of identities.
+ */
+typedef ::std::vector<Ice::Identity> IdentitySeq;
 
 }
 
+/// \cond STREAM
 namespace Ice
 {
 
@@ -214,6 +262,7 @@ struct StreamReader< ::Ice::Identity, S>
 };
 
 }
+/// \endcond
 
 #endif
 

data/ext/ice/cpp/include/generated/Ice/ImplicitContext.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,38 +70,98 @@ class ImplicitContext;
 namespace Ice
 {
 
+/**
+ * An interface to associate implict contexts with communicators.
+ *
+ * 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.
+ *
+ * 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>
+ * <dd>No implicit context at all.</dd>
+ * <dt><tt>PerThread</tt></dt>
+ * <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>
+ *
+ * <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
+ * context. These operations correspond to a subset of the <tt>java.util.Map</tt> methods,
+ * with <tt>java.lang.Object</tt> replaced by <tt>string</tt> and null replaced by the empty-string.
+ * \headerfile Ice/Ice.h
+ */
 class ICE_CLASS(ICE_API) ImplicitContext
 {
 public:
 
     ICE_MEMBER(ICE_API) virtual ~ImplicitContext();
 
+    /**
+     * Get a copy of the underlying context.
+     * @return A copy of the underlying context.
+     */
     virtual ::Ice::Context getContext() const = 0;
 
-    virtual void setContext(const ::Ice::Context&) = 0;
-
-    virtual bool containsKey(const ::std::string&) const = 0;
-
-    virtual ::std::string get(const ::std::string&) const = 0;
-
-    virtual ::std::string put(const ::std::string&, const ::std::string&) = 0;
-
-    virtual ::std::string remove(const ::std::string&) = 0;
+    /**
+     * Set the underlying context.
+     * @param newContext The new context.
+     */
+    virtual void setContext(const Context& newContext) = 0;
+
+    /**
+     * Check if this key has an associated value in the underlying context.
+     * @param key The key.
+     * @return True if the key has an associated value, False otherwise.
+     */
+    virtual bool containsKey(const ::std::string& key) const = 0;
+
+    /**
+     * Get the value associated with the given key in the underlying context.
+     * Returns an empty string if no value is associated with the key.
+     * {@link #containsKey} allows you to distinguish between an empty-string value and
+     * no value at all.
+     * @param key The key.
+     * @return The value associated with the key.
+     */
+    virtual ::std::string get(const ::std::string& key) const = 0;
+
+    /**
+     * Create or update a key/value entry in the underlying context.
+     * @param key The key.
+     * @param value The value.
+     * @return The previous value associated with the key, if any.
+     */
+    virtual ::std::string put(const ::std::string& key, const ::std::string& value) = 0;
+
+    /**
+     * Remove the entry for the given key in the underlying context.
+     * @param key The key.
+     * @return The value associated with the key, if any.
+     */
+    virtual ::std::string remove(const ::std::string& key) = 0;
 };
 
 }
 
+/// \cond STREAM
 namespace Ice
 {
 
 }
+/// \endcond
 
+/// \cond INTERNAL
 namespace Ice
 {
 
 using ImplicitContextPtr = ::std::shared_ptr<ImplicitContext>;
 
 }
+/// \endcond
 
 #else // C++98 mapping
 
@@ -109,15 +169,41 @@ namespace Ice
 {
 
 class ImplicitContext;
-ICE_API ::Ice::LocalObject* upCast(::Ice::ImplicitContext*);
-typedef ::IceInternal::Handle< ::Ice::ImplicitContext> ImplicitContextPtr;
+/// \cond INTERNAL
+ICE_API LocalObject* upCast(ImplicitContext*);
+/// \endcond
+typedef ::IceInternal::Handle< ImplicitContext> ImplicitContextPtr;
 
 }
 
 namespace Ice
 {
 
-class ICE_API ImplicitContext : public virtual ::Ice::LocalObject
+/**
+ * An interface to associate implict contexts with communicators.
+ *
+ * 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.
+ *
+ * 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>
+ * <dd>No implicit context at all.</dd>
+ * <dt><tt>PerThread</tt></dt>
+ * <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>
+ *
+ * <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
+ * context. These operations correspond to a subset of the <tt>java.util.Map</tt> methods,
+ * with <tt>java.lang.Object</tt> replaced by <tt>string</tt> and null replaced by the empty-string.
+ * \headerfile Ice/Ice.h
+ */
+class ICE_API ImplicitContext : public virtual LocalObject
 {
 public:
 
@@ -125,35 +211,71 @@ public:
 
     virtual ~ImplicitContext();
 
-    virtual ::Ice::Context getContext() const = 0;
-
-    virtual void setContext(const ::Ice::Context&) = 0;
-
-    virtual bool containsKey(const ::std::string&) const = 0;
-
-    virtual ::std::string get(const ::std::string&) const = 0;
-
-    virtual ::std::string put(const ::std::string&, const ::std::string&) = 0;
-
-    virtual ::std::string remove(const ::std::string&) = 0;
+    /**
+     * Get a copy of the underlying context.
+     * @return A copy of the underlying context.
+     */
+    virtual Context getContext() const = 0;
+
+    /**
+     * Set the underlying context.
+     * @param newContext The new context.
+     */
+    virtual void setContext(const Context& newContext) = 0;
+
+    /**
+     * Check if this key has an associated value in the underlying context.
+     * @param key The key.
+     * @return True if the key has an associated value, False otherwise.
+     */
+    virtual bool containsKey(const ::std::string& key) const = 0;
+
+    /**
+     * Get the value associated with the given key in the underlying context.
+     * Returns an empty string if no value is associated with the key.
+     * {@link #containsKey} allows you to distinguish between an empty-string value and
+     * no value at all.
+     * @param key The key.
+     * @return The value associated with the key.
+     */
+    virtual ::std::string get(const ::std::string& key) const = 0;
+
+    /**
+     * Create or update a key/value entry in the underlying context.
+     * @param key The key.
+     * @param value The value.
+     * @return The previous value associated with the key, if any.
+     */
+    virtual ::std::string put(const ::std::string& key, const ::std::string& value) = 0;
+
+    /**
+     * Remove the entry for the given key in the underlying context.
+     * @param key The key.
+     * @return The value associated with the key, if any.
+     */
+    virtual ::std::string remove(const ::std::string& key) = 0;
 };
 
+/// \cond INTERNAL
 inline bool operator==(const ImplicitContext& lhs, const ImplicitContext& 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 ImplicitContext& lhs, const ImplicitContext& 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