zeroc-ice 3.7.0 → 3.7.1

data/ext/ice/cpp/include/generated/Ice/RouterF.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>
 //
@@ -41,7 +41,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
@@ -66,11 +66,14 @@ class RouterPrx;
 
 }
 
+/// \cond STREAM
 namespace Ice
 {
 
 }
+/// \endcond
 
+/// \cond INTERNAL
 namespace Ice
 {
 
@@ -78,6 +81,7 @@ using RouterPtr = ::std::shared_ptr<Router>;
 using RouterPrxPtr = ::std::shared_ptr<RouterPrx>;
 
 }
+/// \endcond
 
 #else // C++98 mapping
 
@@ -88,8 +92,10 @@ namespace Ice
 {
 
 class Router;
+/// \cond INTERNAL
 ICE_API void _readProxy(::Ice::InputStream*, ::IceInternal::ProxyHandle< ::IceProxy::Ice::Router>&);
 ICE_API ::IceProxy::Ice::Object* upCast(::IceProxy::Ice::Router*);
+/// \endcond
 
 }
 
@@ -99,18 +105,24 @@ namespace Ice
 {
 
 class Router;
-ICE_API ::Ice::Object* upCast(::Ice::Router*);
-typedef ::IceInternal::Handle< ::Ice::Router> RouterPtr;
+/// \cond INTERNAL
+ICE_API Object* upCast(Router*);
+/// \endcond
+typedef ::IceInternal::Handle< Router> RouterPtr;
 typedef ::IceInternal::ProxyHandle< ::IceProxy::Ice::Router> RouterPrx;
 typedef RouterPrx RouterPrxPtr;
-ICE_API void _icePatchObjectPtr(RouterPtr&, const ::Ice::ObjectPtr&);
+/// \cond INTERNAL
+ICE_API void _icePatchObjectPtr(RouterPtr&, const ObjectPtr&);
+/// \endcond
 
 }
 
+/// \cond STREAM
 namespace Ice
 {
 
 }
+/// \endcond
 
 #endif
 

data/ext/ice/cpp/include/generated/Ice/ServantLocator.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
@@ -69,32 +69,109 @@ class ServantLocator;
 namespace Ice
 {
 
+/**
+ * A servant locator is called by an object adapter to
+ * locate a servant that is not found in its active servant map.
+ * @see ObjectAdapter
+ * @see ObjectAdapter#addServantLocator
+ * @see ObjectAdapter#findServantLocator
+ * \headerfile Ice/Ice.h
+ */
 class ICE_CLASS(ICE_API) ServantLocator
 {
 public:
 
     ICE_MEMBER(ICE_API) virtual ~ServantLocator();
 
-    virtual ::std::shared_ptr<::Ice::Object> locate(const ::Ice::Current&, ::std::shared_ptr<void>&) = 0;
-
-    virtual void finished(const ::Ice::Current&, const ::std::shared_ptr<::Ice::Object>&, const ::std::shared_ptr<void>&) = 0;
-
-    virtual void deactivate(const ::std::string&) = 0;
+    /**
+     * Called before a request is dispatched if a
+     * servant cannot be found in the object adapter's active servant
+     * map. Note that the object adapter does not automatically insert
+     * the returned servant into its active servant map. This must be
+     * done by the servant locator implementation, if this is desired.
+     *
+     * <tt>locate</tt> can throw any user exception. If it does, that exception
+     * is marshaled back to the client. If the Slice definition for the
+     * corresponding operation includes that user exception, the client
+     * receives that user exception; otherwise, the client receives
+     * {@link UnknownUserException}.
+     *
+     * If <tt>locate</tt> throws any exception, the Ice run time does <em>not</em>
+     * call <tt>finished</tt>.
+     *
+     * <p class="Note">If you call <tt>locate</tt> from your own code, you
+     * must also call <tt>finished</tt> when you have finished using the
+     * servant, provided that <tt>locate</tt> returned a non-null servant;
+     * otherwise, you will get undefined behavior if you use
+     * servant locators such as the Freeze Evictor.
+     * @param curr Information about the current operation for which
+     * a servant is required.
+     * @param cookie A "cookie" that will be passed to <tt>finished</tt>.
+     * @return The located servant, or null if no suitable servant has
+     * been found.
+     * @throws UserException The implementation can raise a UserException
+     * and the run time will marshal it as the result of the invocation.
+     * @see ObjectAdapter
+     * @see Current
+     * @see #finished
+     */
+    virtual ::std::shared_ptr<::Ice::Object> locate(const Current& curr, ::std::shared_ptr<void>& cookie) = 0;
+
+    /**
+     * Called by the object adapter after a request has been
+     * made. This operation is only called if <tt>locate</tt> was called
+     * prior to the request and returned a non-null servant. This
+     * operation can be used for cleanup purposes after a request.
+     *
+     * <tt>finished</tt> can throw any user exception. If it does, that exception
+     * is marshaled back to the client. If the Slice definition for the
+     * corresponding operation includes that user exception, the client
+     * receives that user exception; otherwise, the client receives
+     * {@link UnknownUserException}.
+     *
+     * If both the operation and <tt>finished</tt> throw an exception, the
+     * exception thrown by <tt>finished</tt> is marshaled back to the client.
+     * @param curr Information about the current operation call for
+     * which a servant was located by <tt>locate</tt>.
+     * @param servant The servant that was returned by <tt>locate</tt>.
+     * @param cookie The cookie that was returned by <tt>locate</tt>.
+     * @throws UserException The implementation can raise a UserException
+     * and the run time will marshal it as the result of the invocation.
+     * @see ObjectAdapter
+     * @see Current
+     * @see #locate
+     */
+    virtual void finished(const Current& curr, const ::std::shared_ptr<Object>& servant, const ::std::shared_ptr<void>& cookie) = 0;
+
+    /**
+     * Called when the object adapter in which this servant locator is
+     * installed is destroyed.
+     * @param category Indicates for which category the servant locator
+     * is being deactivated.
+     * @see ObjectAdapter#destroy
+     * @see Communicator#shutdown
+     * @see Communicator#destroy
+     */
+    virtual void deactivate(const ::std::string& category) = 0;
 };
 
 }
 
+/// \cond STREAM
 namespace Ice
 {
 
 }
+/// \endcond
 
+/// \cond INTERNAL
 namespace Ice
 {
 
 using ServantLocatorPtr = ::std::shared_ptr<ServantLocator>;
 
 }
+/// \endcond
 
 #else // C++98 mapping
 
@@ -102,15 +179,25 @@ namespace Ice
 {
 
 class ServantLocator;
-ICE_API ::Ice::LocalObject* upCast(::Ice::ServantLocator*);
-typedef ::IceInternal::Handle< ::Ice::ServantLocator> ServantLocatorPtr;
+/// \cond INTERNAL
+ICE_API LocalObject* upCast(ServantLocator*);
+/// \endcond
+typedef ::IceInternal::Handle< ServantLocator> ServantLocatorPtr;
 
 }
 
 namespace Ice
 {
 
-class ICE_API ServantLocator : public virtual ::Ice::LocalObject
+/**
+ * A servant locator is called by an object adapter to
+ * locate a servant that is not found in its active servant map.
+ * @see ObjectAdapter
+ * @see ObjectAdapter#addServantLocator
+ * @see ObjectAdapter#findServantLocator
+ * \headerfile Ice/Ice.h
+ */
+class ICE_API ServantLocator : public virtual LocalObject
 {
 public:
 
@@ -118,29 +205,98 @@ public:
 
     virtual ~ServantLocator();
 
-    virtual ::Ice::ObjectPtr locate(const ::Ice::Current&, ::Ice::LocalObjectPtr&) = 0;
-
-    virtual void finished(const ::Ice::Current&, const ::Ice::ObjectPtr&, const ::Ice::LocalObjectPtr&) = 0;
-
-    virtual void deactivate(const ::std::string&) = 0;
+    /**
+     * Called before a request is dispatched if a
+     * servant cannot be found in the object adapter's active servant
+     * map. Note that the object adapter does not automatically insert
+     * the returned servant into its active servant map. This must be
+     * done by the servant locator implementation, if this is desired.
+     *
+     * <tt>locate</tt> can throw any user exception. If it does, that exception
+     * is marshaled back to the client. If the Slice definition for the
+     * corresponding operation includes that user exception, the client
+     * receives that user exception; otherwise, the client receives
+     * {@link UnknownUserException}.
+     *
+     * If <tt>locate</tt> throws any exception, the Ice run time does <em>not</em>
+     * call <tt>finished</tt>.
+     *
+     * <p class="Note">If you call <tt>locate</tt> from your own code, you
+     * must also call <tt>finished</tt> when you have finished using the
+     * servant, provided that <tt>locate</tt> returned a non-null servant;
+     * otherwise, you will get undefined behavior if you use
+     * servant locators such as the Freeze Evictor.
+     * @param curr Information about the current operation for which
+     * a servant is required.
+     * @param cookie A "cookie" that will be passed to <tt>finished</tt>.
+     * @return The located servant, or null if no suitable servant has
+     * been found.
+     * @throws UserException The implementation can raise a UserException
+     * and the run time will marshal it as the result of the invocation.
+     * @see ObjectAdapter
+     * @see Current
+     * @see #finished
+     */
+    virtual ObjectPtr locate(const Current& curr, LocalObjectPtr& cookie) = 0;
+
+    /**
+     * Called by the object adapter after a request has been
+     * made. This operation is only called if <tt>locate</tt> was called
+     * prior to the request and returned a non-null servant. This
+     * operation can be used for cleanup purposes after a request.
+     *
+     * <tt>finished</tt> can throw any user exception. If it does, that exception
+     * is marshaled back to the client. If the Slice definition for the
+     * corresponding operation includes that user exception, the client
+     * receives that user exception; otherwise, the client receives
+     * {@link UnknownUserException}.
+     *
+     * If both the operation and <tt>finished</tt> throw an exception, the
+     * exception thrown by <tt>finished</tt> is marshaled back to the client.
+     * @param curr Information about the current operation call for
+     * which a servant was located by <tt>locate</tt>.
+     * @param servant The servant that was returned by <tt>locate</tt>.
+     * @param cookie The cookie that was returned by <tt>locate</tt>.
+     * @throws UserException The implementation can raise a UserException
+     * and the run time will marshal it as the result of the invocation.
+     * @see ObjectAdapter
+     * @see Current
+     * @see #locate
+     */
+    virtual void finished(const Current& curr, const ObjectPtr& servant, const LocalObjectPtr& cookie) = 0;
+
+    /**
+     * Called when the object adapter in which this servant locator is
+     * installed is destroyed.
+     * @param category Indicates for which category the servant locator
+     * is being deactivated.
+     * @see ObjectAdapter#destroy
+     * @see Communicator#shutdown
+     * @see Communicator#destroy
+     */
+    virtual void deactivate(const ::std::string& category) = 0;
 };
 
+/// \cond INTERNAL
 inline bool operator==(const ServantLocator& lhs, const ServantLocator& 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 ServantLocator& lhs, const ServantLocator& 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/ServantLocatorF.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 ServantLocator;
 
 }
 
+/// \cond STREAM
 namespace Ice
 {
 
 }
+/// \endcond
 
+/// \cond INTERNAL
 namespace Ice
 {
 
 using ServantLocatorPtr = ::std::shared_ptr<ServantLocator>;
 
 }
+/// \endcond
 
 #else // C++98 mapping
 
@@ -82,15 +86,19 @@ namespace Ice
 {
 
 class ServantLocator;
-ICE_API ::Ice::LocalObject* upCast(::Ice::ServantLocator*);
-typedef ::IceInternal::Handle< ::Ice::ServantLocator> ServantLocatorPtr;
+/// \cond INTERNAL
+ICE_API LocalObject* upCast(ServantLocator*);
+/// \endcond
+typedef ::IceInternal::Handle< ServantLocator> ServantLocatorPtr;
 
 }
 
+/// \cond STREAM
 namespace Ice
 {
 
 }
+/// \endcond
 
 #endif
 

data/ext/ice/cpp/include/generated/Ice/SliceChecksumDict.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,6 +60,11 @@
 namespace Ice
 {
 
+/**
+ * A mapping from type IDs to Slice checksums. The dictionary
+ * allows verification at run time that client and server
+ * use matching Slice definitions.
+ */
 using SliceChecksumDict = ::std::map<::std::string, ::std::string>;
 
 }
@@ -69,6 +74,11 @@ using SliceChecksumDict = ::std::map<::std::string, ::std::string>;
 namespace Ice
 {
 
+/**
+ * A mapping from type IDs to Slice checksums. The dictionary
+ * allows verification at run time that client and server
+ * use matching Slice definitions.
+ */
 typedef ::std::map< ::std::string, ::std::string> SliceChecksumDict;
 
 }