zeroc-ice 3.7.0 → 3.7.1

data/ext/ice/cpp/include/generated/Ice/ObjectAdapterF.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
@@ -64,17 +64,21 @@ class ObjectAdapter;
 
 }
 
+/// \cond STREAM
 namespace Ice
 {
 
 }
+/// \endcond
 
+/// \cond INTERNAL
 namespace Ice
 {
 
 using ObjectAdapterPtr = ::std::shared_ptr<ObjectAdapter>;
 
 }
+/// \endcond
 
 #else // C++98 mapping
 
@@ -82,15 +86,19 @@ namespace Ice
 {
 
 class ObjectAdapter;
-ICE_API ::Ice::LocalObject* upCast(::Ice::ObjectAdapter*);
-typedef ::IceInternal::Handle< ::Ice::ObjectAdapter> ObjectAdapterPtr;
+/// \cond INTERNAL
+ICE_API LocalObject* upCast(ObjectAdapter*);
+/// \endcond
+typedef ::IceInternal::Handle< ObjectAdapter> ObjectAdapterPtr;
 
 }
 
+/// \cond STREAM
 namespace Ice
 {
 
 }
+/// \endcond
 
 #endif
 

data/ext/ice/cpp/include/generated/Ice/ObjectFactory.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,30 +67,59 @@ class ObjectFactory;
 namespace Ice
 {
 
+/**
+ * A factory for objects. Object factories are used when receiving "objects by value".
+ * An object factory must be implemented by the application writer and registered
+ * with the communicator.
+ *
+ * @deprecated ObjectFactory has been deprecated, use ValueFactory instead.
+ * \headerfile Ice/Ice.h
+ */
 class ICE_CLASS(ICE_API) ObjectFactory
 {
 public:
 
     ICE_MEMBER(ICE_API) virtual ~ObjectFactory();
 
-    ICE_DEPRECATED_API("ObjectFactory has been deprecated, use ValueFactory instead.") virtual ::std::shared_ptr<::Ice::Value> create(const ::std::string&) = 0;
-
+    /**
+     * Create a new object for a given object 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 interfaces of type <tt>Bar</tt> in the module
+     * <tt>Foo</tt> is <tt>"::Foo::Bar"</tt>.
+     *
+     * <p class="Note">The leading "<tt>::</tt>" is required.
+     * @param type The object type.
+     * @return The object created for the given type, or nil if the
+     * factory is unable to create the object.
+     */
+    ICE_DEPRECATED_API("ObjectFactory has been deprecated, use ValueFactory instead.") virtual ::std::shared_ptr<::Ice::Value> create(const ::std::string& type) = 0;
+
+    /**
+     * Called when the factory is removed from the communicator, or if
+     * the communicator is destroyed.
+     * @see Communicator#destroy
+     */
     ICE_DEPRECATED_API("ObjectFactory has been deprecated, use ValueFactory instead.") virtual void destroy() = 0;
 };
 
 }
 
+/// \cond STREAM
 namespace Ice
 {
 
 }
+/// \endcond
 
+/// \cond INTERNAL
 namespace Ice
 {
 
 using ObjectFactoryPtr = ::std::shared_ptr<ObjectFactory>;
 
 }
+/// \endcond
 
 #else // C++98 mapping
 
@@ -98,15 +127,25 @@ namespace Ice
 {
 
 class ObjectFactory;
-ICE_API ::Ice::LocalObject* upCast(::Ice::ObjectFactory*);
-typedef ::IceInternal::Handle< ::Ice::ObjectFactory> ObjectFactoryPtr;
+/// \cond INTERNAL
+ICE_API LocalObject* upCast(ObjectFactory*);
+/// \endcond
+typedef ::IceInternal::Handle< ObjectFactory> ObjectFactoryPtr;
 
 }
 
 namespace Ice
 {
 
-class ICE_API ObjectFactory : public virtual ::Ice::LocalObject
+/**
+ * A factory for objects. Object factories are used when receiving "objects by value".
+ * An object factory must be implemented by the application writer and registered
+ * with the communicator.
+ *
+ * @deprecated ObjectFactory has been deprecated, use ValueFactory instead.
+ * \headerfile Ice/Ice.h
+ */
+class ICE_API ObjectFactory : public virtual LocalObject
 {
 public:
 
@@ -114,27 +153,48 @@ public:
 
     virtual ~ObjectFactory();
 
-    ICE_DEPRECATED_API("ObjectFactory has been deprecated, use ValueFactory instead.") virtual ::Ice::ValuePtr create(const ::std::string&) = 0;
-
+    /**
+     * Create a new object for a given object 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 interfaces of type <tt>Bar</tt> in the module
+     * <tt>Foo</tt> is <tt>"::Foo::Bar"</tt>.
+     *
+     * <p class="Note">The leading "<tt>::</tt>" is required.
+     * @param type The object type.
+     * @return The object created for the given type, or nil if the
+     * factory is unable to create the object.
+     */
+    ICE_DEPRECATED_API("ObjectFactory has been deprecated, use ValueFactory instead.") virtual ValuePtr create(const ::std::string& type) = 0;
+
+    /**
+     * Called when the factory is removed from the communicator, or if
+     * the communicator is destroyed.
+     * @see Communicator#destroy
+     */
     ICE_DEPRECATED_API("ObjectFactory has been deprecated, use ValueFactory instead.") virtual void destroy() = 0;
 };
 
+/// \cond INTERNAL
 inline bool operator==(const ObjectFactory& lhs, const ObjectFactory& 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 ObjectFactory& lhs, const ObjectFactory& 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/Plugin.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>
 //
@@ -42,7 +42,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,41 +70,94 @@ class PluginManager;
 namespace Ice
 {
 
+/**
+ * A communicator plug-in. A plug-in generally adds a feature to a
+ * communicator, such as support for a protocol.
+ *
+ * The communicator loads its plug-ins in two stages: the first stage
+ * creates the plug-ins, and the second stage invokes {@link Plugin#initialize} on
+ * each one.
+ * \headerfile Ice/Ice.h
+ */
 class ICE_CLASS(ICE_API) Plugin
 {
 public:
 
     ICE_MEMBER(ICE_API) virtual ~Plugin();
 
+    /**
+     * Perform any necessary initialization steps.
+     */
     virtual void initialize() = 0;
 
+    /**
+     * Called when the communicator is being destroyed.
+     */
     virtual void destroy() = 0;
 };
 
+/**
+ * Each communicator has a plug-in manager to administer the set of
+ * plug-ins.
+ * \headerfile Ice/Ice.h
+ */
 class ICE_CLASS(ICE_API) PluginManager
 {
 public:
 
     ICE_MEMBER(ICE_API) virtual ~PluginManager();
 
+    /**
+     * Initialize the configured plug-ins. The communicator automatically initializes
+     * the plug-ins by default, but an application may need to interact directly with
+     * a plug-in prior to initialization. In this case, the application must set
+     * <tt>Ice.InitPlugins=0</tt> and then invoke {@link #initializePlugins}
+     * manually. The plug-ins are initialized in the order in which they are loaded.
+     * If a plug-in raises an exception during initialization, the communicator
+     * invokes destroy on the plug-ins that have already been initialized.
+     * @throws InitializationException Raised if the plug-ins have already been initialized.
+     */
     virtual void initializePlugins() = 0;
 
-    virtual ::Ice::StringSeq getPlugins() = 0;
-
-    virtual ::std::shared_ptr<::Ice::Plugin> getPlugin(const ::std::string&) = 0;
-
-    virtual void addPlugin(const ::std::string&, const ::std::shared_ptr<::Ice::Plugin>&) = 0;
-
-    virtual void destroy() = 0;
+    /**
+     * Get a list of plugins installed.
+     * @return The names of the plugins installed.
+     * @see #getPlugin
+     */
+    virtual ::Ice::StringSeq getPlugins() noexcept = 0;
+
+    /**
+     * Obtain a plug-in by name.
+     * @param name The plug-in's name.
+     * @return The plug-in.
+     * @throws NotRegisteredException Raised if no plug-in is found with the given name.
+     */
+    virtual ::std::shared_ptr<::Ice::Plugin> getPlugin(const ::std::string& name) = 0;
+
+    /**
+     * Install a new plug-in.
+     * @param name The plug-in's name.
+     * @param pi The plug-in.
+     * @throws AlreadyRegisteredException Raised if a plug-in already exists with the given name.
+     */
+    virtual void addPlugin(const ::std::string& name, const ::std::shared_ptr<Plugin>& pi) = 0;
+
+    /**
+     * Called when the communicator is being destroyed.
+     */
+    virtual void destroy() noexcept = 0;
 };
 
 }
 
+/// \cond STREAM
 namespace Ice
 {
 
 }
+/// \endcond
 
+/// \cond INTERNAL
 namespace Ice
 {
 
@@ -113,6 +166,7 @@ using PluginPtr = ::std::shared_ptr<Plugin>;
 using PluginManagerPtr = ::std::shared_ptr<PluginManager>;
 
 }
+/// \endcond
 
 #else // C++98 mapping
 
@@ -120,19 +174,32 @@ namespace Ice
 {
 
 class Plugin;
-ICE_API ::Ice::LocalObject* upCast(::Ice::Plugin*);
-typedef ::IceInternal::Handle< ::Ice::Plugin> PluginPtr;
+/// \cond INTERNAL
+ICE_API LocalObject* upCast(Plugin*);
+/// \endcond
+typedef ::IceInternal::Handle< Plugin> PluginPtr;
 
 class PluginManager;
-ICE_API ::Ice::LocalObject* upCast(::Ice::PluginManager*);
-typedef ::IceInternal::Handle< ::Ice::PluginManager> PluginManagerPtr;
+/// \cond INTERNAL
+ICE_API LocalObject* upCast(PluginManager*);
+/// \endcond
+typedef ::IceInternal::Handle< PluginManager> PluginManagerPtr;
 
 }
 
 namespace Ice
 {
 
-class ICE_API Plugin : public virtual ::Ice::LocalObject
+/**
+ * A communicator plug-in. A plug-in generally adds a feature to a
+ * communicator, such as support for a protocol.
+ *
+ * The communicator loads its plug-ins in two stages: the first stage
+ * creates the plug-ins, and the second stage invokes {@link Plugin#initialize} on
+ * each one.
+ * \headerfile Ice/Ice.h
+ */
+class ICE_API Plugin : public virtual LocalObject
 {
 public:
 
@@ -140,22 +207,35 @@ public:
 
     virtual ~Plugin();
 
+    /**
+     * Perform any necessary initialization steps.
+     */
     virtual void initialize() = 0;
 
+    /**
+     * Called when the communicator is being destroyed.
+     */
     virtual void destroy() = 0;
 };
 
+/// \cond INTERNAL
 inline bool operator==(const Plugin& lhs, const Plugin& 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 Plugin& lhs, const Plugin& 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 PluginManager : public virtual ::Ice::LocalObject
+/// \endcond
+
+/**
+ * Each communicator has a plug-in manager to administer the set of
+ * plug-ins.
+ * \headerfile Ice/Ice.h
+ */
+class ICE_API PluginManager : public virtual LocalObject
 {
 public:
 
@@ -163,33 +243,67 @@ public:
 
     virtual ~PluginManager();
 
+    /**
+     * Initialize the configured plug-ins. The communicator automatically initializes
+     * the plug-ins by default, but an application may need to interact directly with
+     * a plug-in prior to initialization. In this case, the application must set
+     * <tt>Ice.InitPlugins=0</tt> and then invoke {@link #initializePlugins}
+     * manually. The plug-ins are initialized in the order in which they are loaded.
+     * If a plug-in raises an exception during initialization, the communicator
+     * invokes destroy on the plug-ins that have already been initialized.
+     * @throws InitializationException Raised if the plug-ins have already been initialized.
+     */
     virtual void initializePlugins() = 0;
 
-    virtual ::Ice::StringSeq getPlugins() = 0;
-
-    virtual ::Ice::PluginPtr getPlugin(const ::std::string&) = 0;
-
-    virtual void addPlugin(const ::std::string&, const ::Ice::PluginPtr&) = 0;
-
-    virtual void destroy() = 0;
+    /**
+     * Get a list of plugins installed.
+     * @return The names of the plugins installed.
+     * @see #getPlugin
+     */
+    virtual StringSeq getPlugins() ICE_NOEXCEPT = 0;
+
+    /**
+     * Obtain a plug-in by name.
+     * @param name The plug-in's name.
+     * @return The plug-in.
+     * @throws NotRegisteredException Raised if no plug-in is found with the given name.
+     */
+    virtual PluginPtr getPlugin(const ::std::string& name) = 0;
+
+    /**
+     * Install a new plug-in.
+     * @param name The plug-in's name.
+     * @param pi The plug-in.
+     * @throws AlreadyRegisteredException Raised if a plug-in already exists with the given name.
+     */
+    virtual void addPlugin(const ::std::string& name, const PluginPtr& pi) = 0;
+
+    /**
+     * Called when the communicator is being destroyed.
+     */
+    virtual void destroy() ICE_NOEXCEPT = 0;
 };
 
+/// \cond INTERNAL
 inline bool operator==(const PluginManager& lhs, const PluginManager& 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 PluginManager& lhs, const PluginManager& 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