zeroc-ice 3.7.0 → 3.7.5

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

@@ -1,13 +1,8 @@
-// **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// Copyright (c) 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.5
 //
 // <auto-generated>
 //
@@ -37,10 +32,10 @@
 #   if ICE_INT_VERSION / 100 != 307
 #       error Ice version mismatch!
 #   endif
-#   if ICE_INT_VERSION % 100 > 50
+#   if ICE_INT_VERSION % 100 >= 50
 #       error Beta header file detected
 #   endif
-#   if ICE_INT_VERSION % 100 < 0
+#   if ICE_INT_VERSION % 100 < 5
 #       error Ice patch level mismatch!
 #   endif
 #endif
@@ -64,17 +59,21 @@ class Communicator;
 
 }
 
+/// \cond STREAM
 namespace Ice
 {
 
 }
+/// \endcond
 
+/// \cond INTERNAL
 namespace Ice
 {
 
 using CommunicatorPtr = ::std::shared_ptr<Communicator>;
 
 }
+/// \endcond
 
 #else // C++98 mapping
 
@@ -82,15 +81,19 @@ namespace Ice
 {
 
 class Communicator;
-ICE_API ::Ice::LocalObject* upCast(::Ice::Communicator*);
-typedef ::IceInternal::Handle< ::Ice::Communicator> CommunicatorPtr;
+/// \cond INTERNAL
+ICE_API LocalObject* upCast(Communicator*);
+/// \endcond
+typedef ::IceInternal::Handle< Communicator> CommunicatorPtr;
 
 }
 
+/// \cond STREAM
 namespace Ice
 {
 
 }
+/// \endcond
 
 #endif
 

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

@@ -1,13 +1,8 @@
-// **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// Copyright (c) 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.5
 //
 // <auto-generated>
 //
@@ -41,10 +36,10 @@
 #   if ICE_INT_VERSION / 100 != 307
 #       error Ice version mismatch!
 #   endif
-#   if ICE_INT_VERSION % 100 > 50
+#   if ICE_INT_VERSION % 100 >= 50
 #       error Beta header file detected
 #   endif
-#   if ICE_INT_VERSION % 100 < 0
+#   if ICE_INT_VERSION % 100 < 5
 #       error Ice patch level mismatch!
 #   endif
 #endif
@@ -76,49 +71,131 @@ class WSConnectionInfo;
 namespace Ice
 {
 
+/**
+ * The batch compression option when flushing queued batch requests.
+ */
 enum class CompressBatch : unsigned char
 {
+    /**
+     * Compress the batch requests.
+     */
     Yes,
+    /**
+     * Don't compress the batch requests.
+     */
     No,
+    /**
+     * Compress the batch requests if at least one request was
+     * made on a compressed proxy.
+     */
     BasedOnProxy
 };
 
+/**
+ * Specifies the close semantics for Active Connection Management.
+ */
 enum class ACMClose : unsigned char
 {
+    /**
+     * Disables automatic connection closure.
+     */
     CloseOff,
+    /**
+     * Gracefully closes a connection that has been idle for the configured timeout period.
+     */
     CloseOnIdle,
+    /**
+     * Forcefully closes a connection that has been idle for the configured timeout period,
+     * but only if the connection has pending invocations.
+     */
     CloseOnInvocation,
+    /**
+     * Combines the behaviors of CloseOnIdle and CloseOnInvocation.
+     */
     CloseOnInvocationAndIdle,
+    /**
+     * Forcefully closes a connection that has been idle for the configured timeout period,
+     * regardless of whether the connection has pending invocations or dispatch.
+     */
     CloseOnIdleForceful
 };
 
+/**
+ * Specifies the heartbeat semantics for Active Connection Management.
+ */
 enum class ACMHeartbeat : unsigned char
 {
+    /**
+     * Disables heartbeats.
+     */
     HeartbeatOff,
+    /**
+     * Send a heartbeat at regular intervals if the connection is idle and only if there are pending dispatch.
+     */
     HeartbeatOnDispatch,
+    /**
+     * Send a heartbeat at regular intervals when the connection is idle.
+     */
     HeartbeatOnIdle,
+    /**
+     * Send a heartbeat at regular intervals until the connection is closed.
+     */
     HeartbeatAlways
 };
 
+/**
+ * A collection of Active Connection Management configuration settings.
+ * \headerfile Ice/Ice.h
+ */
 struct ACM
 {
+    /**
+     * A timeout value in seconds.
+     */
     int timeout;
+    /**
+     * The close semantics.
+     */
     ::Ice::ACMClose close;
+    /**
+     * The heartbeat semantics.
+     */
     ::Ice::ACMHeartbeat heartbeat;
 
+    /**
+     * Obtains a tuple containing all of the struct's data members.
+     * @return The data members in a tuple.
+     */
     std::tuple<const int&, const ::Ice::ACMClose&, const ::Ice::ACMHeartbeat&> ice_tuple() const
     {
         return std::tie(timeout, close, heartbeat);
     }
 };
 
+/**
+ * Determines the behavior when manually closing a connection.
+ */
 enum class ConnectionClose : unsigned char
 {
+    /**
+     * Close the connection immediately without sending a close connection protocol message to the peer
+     * and waiting for the peer to acknowledge it.
+     */
     Forcefully,
+    /**
+     * Close the connection by notifying the peer but do not wait for pending outgoing invocations to complete.
+     * On the server side, the connection will not be closed until all incoming invocations have completed.
+     */
     Gracefully,
+    /**
+     * Wait for all pending invocations to complete before closing the connection.
+     */
     GracefullyWithWait
 };
 
+/**
+ * A collection of HTTP headers.
+ */
 using HeaderDict = ::std::map<::std::string, ::std::string>;
 
 using Ice::operator<;
@@ -133,6 +210,10 @@ using Ice::operator!=;
 namespace Ice
 {
 
+/**
+ * Base class providing access to the connection details.
+ * \headerfile Ice/Ice.h
+ */
 class ICE_CLASS(ICE_API) ConnectionInfo
 {
 public:
@@ -146,52 +227,157 @@ 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) :
-        underlying(::std::move(iceP_underlying)),
-        incoming(iceP_incoming),
-        adapterName(::std::move(iceP_adapterName)),
-        connectionId(::std::move(iceP_connectionId))
+    /**
+     * 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.
+     */
+    ConnectionInfo(const ::std::shared_ptr<::Ice::ConnectionInfo>& underlying, bool incoming, const ::std::string& adapterName, const ::std::string& connectionId) :
+        underlying(underlying),
+        incoming(incoming),
+        adapterName(adapterName),
+        connectionId(connectionId)
     {
     }
 
+    /**
+     * The information of the underyling transport or null if there's
+     * no underlying transport.
+     */
     ::std::shared_ptr<::Ice::ConnectionInfo> underlying;
+    /**
+     * Whether or not the connection is an incoming or outgoing
+     * connection.
+     */
     bool incoming;
+    /**
+     * The name of the adapter associated with the connection.
+     */
     ::std::string adapterName;
+    /**
+     * The connection id.
+     */
     ::std::string connectionId;
 };
 
-using CloseCallback = ::std::function<void(const ::std::shared_ptr<::Ice::Connection>&)>;
-
-using HeartbeatCallback = ::std::function<void(const ::std::shared_ptr<::Ice::Connection>&)>;
-
+/**
+ * This method is called by the the connection when the connection
+ * is closed. If the callback needs more information about the closure,
+ * it can call {@link Connection#throwException}.
+ * @param con The connection that closed.
+ */
+using CloseCallback = ::std::function<void(const ::std::shared_ptr<Connection>& con)>;
+
+/**
+ * This method is called by the the connection when a heartbeat is
+ * received from the peer.
+ * @param con The connection on which a heartbeat was received.
+ */
+using HeartbeatCallback = ::std::function<void(const ::std::shared_ptr<Connection>& con)>;
+
+/**
+ * The user-level interface to a connection.
+ * \headerfile Ice/Ice.h
+ */
 class ICE_CLASS(ICE_API) Connection
 {
 public:
 
     ICE_MEMBER(ICE_API) virtual ~Connection();
 
-    virtual void close(::Ice::ConnectionClose) = 0;
-
-    virtual ::std::shared_ptr<::Ice::ObjectPrx> createProxy(const ::Ice::Identity&) const = 0;
-
-    virtual void setAdapter(const ::std::shared_ptr<::Ice::ObjectAdapter>&) = 0;
-
-    virtual ::std::shared_ptr<::Ice::ObjectAdapter> getAdapter() const = 0;
-
-    virtual ::std::shared_ptr<::Ice::Endpoint> getEndpoint() const = 0;
-
-    virtual void flushBatchRequests(::Ice::CompressBatch compress)
+    /**
+     * Manually close the connection using the specified closure mode.
+     * @param mode Determines how the connection will be closed.
+     * @see ConnectionClose
+     */
+    virtual void close(ConnectionClose mode) noexcept = 0;
+
+    /**
+     * Create a special proxy that always uses this connection. This
+     * can be used for callbacks from a server to a client if the
+     * server cannot directly establish a connection to the client,
+     * for example because of firewalls. In this case, the server
+     * would create a proxy using an already established connection
+     * from the client.
+     * @param id The identity for which a proxy is to be created.
+     * @return A proxy that matches the given identity and uses this
+     * connection.
+     * @see #setAdapter
+     */
+    virtual ::std::shared_ptr<::Ice::ObjectPrx> createProxy(const Identity& id) const = 0;
+
+    /**
+     * Explicitly set an object adapter that dispatches requests that
+     * are received over this connection. A client can invoke an
+     * operation on a server using a proxy, and then set an object
+     * adapter for the outgoing connection that is used by the proxy
+     * in order to receive callbacks. This is useful if the server
+     * cannot establish a connection back to the client, for example
+     * because of firewalls.
+     * @param adapter The object adapter that should be used by this
+     * connection to dispatch requests. The object adapter must be
+     * activated. When the object adapter is deactivated, it is
+     * automatically removed from the connection. Attempts to use a
+     * deactivated object adapter raise {@link ObjectAdapterDeactivatedException}
+     * @see #createProxy
+     * @see #getAdapter
+     */
+    virtual void setAdapter(const ::std::shared_ptr<ObjectAdapter>& adapter) = 0;
+
+    /**
+     * Get the object adapter that dispatches requests for this
+     * connection.
+     * @return The object adapter that dispatches requests for the
+     * connection, or null if no adapter is set.
+     * @see #setAdapter
+     */
+    virtual ::std::shared_ptr<::Ice::ObjectAdapter> getAdapter() const noexcept = 0;
+
+    /**
+     * Get the endpoint from which the connection was created.
+     * @return The endpoint from which the connection was created.
+     */
+    virtual ::std::shared_ptr<::Ice::Endpoint> getEndpoint() const noexcept = 0;
+
+    /**
+     * Flush any pending batch requests for this connection.
+     * This means all batch requests invoked on fixed proxies
+     * associated with the connection.
+     * @param compress Specifies whether or not the queued batch requests
+     * should be compressed before being sent over the wire.
+     */
+    virtual void flushBatchRequests(CompressBatch compress)
     {
         flushBatchRequestsAsync(compress).get();
     }
 
+    /**
+     * Flush any pending batch requests for this connection.
+     * This means all batch requests invoked on fixed proxies
+     * associated with the connection.
+     * @param compress Specifies whether or not the queued batch requests
+     * should be compressed before being sent over the wire.
+     * @param exception The exception callback.
+     * @param sent The sent callback.
+     * @return A function that can be called to cancel the invocation locally.
+     */
     virtual ::std::function<void()>
-    flushBatchRequestsAsync(::Ice::CompressBatch compress,
+    flushBatchRequestsAsync(CompressBatch compress,
                             ::std::function<void(::std::exception_ptr)> exception,
                             ::std::function<void(bool)> sent = nullptr) = 0;
 
+    /**
+     * Flush any pending batch requests for this connection.
+     * This means all batch requests invoked on fixed proxies
+     * associated with the connection.
+     * @param compress Specifies whether or not the queued batch requests
+     * should be compressed before being sent over the wire.
+     * @return The future object for the invocation.
+     */
     template<template<typename> class P = ::std::promise>
-    auto flushBatchRequestsAsync(::Ice::CompressBatch compress)
+    auto flushBatchRequestsAsync(CompressBatch compress)
         -> decltype(::std::declval<P<void>>().get_future())
     {
         using Promise = P<void>;
@@ -208,19 +394,45 @@ public:
         return promise->get_future();
     }
 
-    virtual void setCloseCallback(::Ice::CloseCallback) = 0;
-
-    virtual void setHeartbeatCallback(::Ice::HeartbeatCallback) = 0;
-
+    /**
+     * Set a close callback on the connection. The callback is called by the
+     * connection when it's closed. The callback is called from the
+     * Ice thread pool associated with the connection. If the callback needs
+     * more information about the closure, it can call {@link Connection#throwException}.
+     * @param callback The close callback object.
+     */
+    virtual void setCloseCallback(CloseCallback callback) = 0;
+
+    /**
+     * Set a heartbeat callback on the connection. The callback is called by the
+     * connection when a heartbeat is received. The callback is called
+     * from the Ice thread pool associated with the connection.
+     * @param callback The heartbeat callback object.
+     */
+    virtual void setHeartbeatCallback(HeartbeatCallback callback) = 0;
+
+    /**
+     * Send a heartbeat message.
+     */
     virtual void heartbeat()
     {
         heartbeatAsync().get();
     }
 
+    /**
+     * Send a heartbeat message.
+     * @param exception The exception callback.
+     * @param sent The sent callback.
+     * @return A function that can be called to cancel the invocation locally.
+     */
     virtual ::std::function<void()>
     heartbeatAsync(::std::function<void(::std::exception_ptr)> exception,
                    ::std::function<void(bool)> sent = nullptr) = 0;
 
+    /**
+     * Send a heartbeat message.
+     * @return The future object for the invocation.
+     */
     template<template<typename> class P = ::std::promise>
     auto heartbeatAsync()
         -> decltype(::std::declval<P<void>>().get_future())
@@ -238,23 +450,68 @@ public:
         return promise->get_future();
     }
 
-    virtual void setACM(const Ice::optional<int>&, const Ice::optional<::Ice::ACMClose>&, const Ice::optional<::Ice::ACMHeartbeat>&) = 0;
-
-    virtual ::Ice::ACM getACM() = 0;
-
-    virtual ::std::string type() const = 0;
-
-    virtual int timeout() const = 0;
-
-    virtual ::std::string toString() const = 0;
-
+    /**
+     * Set the active connection management parameters.
+     * @param timeout The timeout value in seconds, must be &gt;= 0.
+     * @param close The close condition
+     * @param heartbeat The hertbeat condition
+     */
+    virtual void setACM(const Ice::optional<int>& timeout, const Ice::optional<ACMClose>& close, const Ice::optional<ACMHeartbeat>& heartbeat) = 0;
+
+    /**
+     * Get the ACM parameters.
+     * @return The ACM parameters.
+     */
+    virtual ::Ice::ACM getACM() noexcept = 0;
+
+    /**
+     * Return the connection type. This corresponds to the endpoint
+     * type, i.e., "tcp", "udp", etc.
+     * @return The type of the connection.
+     */
+    virtual ::std::string type() const noexcept = 0;
+
+    /**
+     * Get the timeout for the connection.
+     * @return The connection's timeout.
+     */
+    virtual int timeout() const noexcept = 0;
+
+    /**
+     * Return a description of the connection as human readable text,
+     * suitable for logging or error messages.
+     * @return The description of the connection as human readable
+     * text.
+     */
+    virtual ::std::string toString() const noexcept = 0;
+
+    /**
+     * Returns the connection information.
+     * @return The connection information.
+     */
     virtual ::std::shared_ptr<::Ice::ConnectionInfo> getInfo() const = 0;
 
-    virtual void setBufferSize(int, int) = 0;
-
+    /**
+     * Set the connection buffer receive/send size.
+     * @param rcvSize The connection receive buffer size.
+     * @param sndSize The connection send buffer size.
+     */
+    virtual void setBufferSize(int rcvSize, int sndSize) = 0;
+
+    /**
+     * Throw an exception indicating the reason for connection closure. For example,
+     * {@link CloseConnectionException} is raised if the connection was closed gracefully,
+     * whereas {@link ConnectionManuallyClosedException} is raised if the connection was
+     * manually closed by the application. This operation does nothing if the connection is
+     * not yet closed.
+     */
     virtual void throwException() const = 0;
 };
 
+/**
+ * Provides access to the connection details of an IP connection
+ * \headerfile Ice/Ice.h
+ */
 class ICE_CLASS(ICE_API) IPConnectionInfo : public ::Ice::ConnectionInfo
 {
 public:
@@ -274,21 +531,48 @@ public:
     IPConnectionInfo& operator=(const IPConnectionInfo&) = default;
     IPConnectionInfo& operator=(IPConnectionInfo&&) = default;
 
-    IPConnectionInfo(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_localAddress, int iceP_localPort, const ::std::string& iceP_remoteAddress, int iceP_remotePort) :
-        ::Ice::ConnectionInfo(::std::move(iceP_underlying), iceP_incoming, ::std::move(iceP_adapterName), ::std::move(iceP_connectionId)),
-        localAddress(::std::move(iceP_localAddress)),
-        localPort(iceP_localPort),
-        remoteAddress(::std::move(iceP_remoteAddress)),
-        remotePort(iceP_remotePort)
+    /**
+     * 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 localAddress The local address.
+     * @param localPort The local port.
+     * @param remoteAddress The remote address.
+     * @param remotePort The remote port.
+     */
+    IPConnectionInfo(const ::std::shared_ptr<::Ice::ConnectionInfo>& underlying, bool incoming, const ::std::string& adapterName, const ::std::string& connectionId, const ::std::string& localAddress, int localPort, const ::std::string& remoteAddress, int remotePort) :
+        ConnectionInfo(underlying, incoming, adapterName, connectionId),
+        localAddress(localAddress),
+        localPort(localPort),
+        remoteAddress(remoteAddress),
+        remotePort(remotePort)
     {
     }
 
+    /**
+     * The local address.
+     */
     ::std::string localAddress;
+    /**
+     * The local port.
+     */
     int localPort = -1;
+    /**
+     * The remote address.
+     */
     ::std::string remoteAddress;
+    /**
+     * The remote port.
+     */
     int remotePort = -1;
 };
 
+/**
+ * Provides access to the connection details of a TCP connection
+ * \headerfile Ice/Ice.h
+ */
 class ICE_CLASS(ICE_API) TCPConnectionInfo : public ::Ice::IPConnectionInfo
 {
 public:
@@ -306,17 +590,40 @@ public:
     TCPConnectionInfo& operator=(const TCPConnectionInfo&) = default;
     TCPConnectionInfo& operator=(TCPConnectionInfo&&) = default;
 
-    TCPConnectionInfo(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_localAddress, int iceP_localPort, const ::std::string& iceP_remoteAddress, int iceP_remotePort, int iceP_rcvSize, int iceP_sndSize) :
-        ::Ice::IPConnectionInfo(::std::move(iceP_underlying), iceP_incoming, ::std::move(iceP_adapterName), ::std::move(iceP_connectionId), ::std::move(iceP_localAddress), iceP_localPort, ::std::move(iceP_remoteAddress), iceP_remotePort),
-        rcvSize(iceP_rcvSize),
-        sndSize(iceP_sndSize)
+    /**
+     * 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 localAddress The local address.
+     * @param localPort The local port.
+     * @param remoteAddress The remote address.
+     * @param remotePort The remote port.
+     * @param rcvSize The connection buffer receive size.
+     * @param sndSize The connection buffer send size.
+     */
+    TCPConnectionInfo(const ::std::shared_ptr<::Ice::ConnectionInfo>& underlying, bool incoming, const ::std::string& adapterName, const ::std::string& connectionId, const ::std::string& localAddress, int localPort, const ::std::string& remoteAddress, int remotePort, int rcvSize, int sndSize) :
+        IPConnectionInfo(underlying, incoming, adapterName, connectionId, localAddress, localPort, remoteAddress, remotePort),
+        rcvSize(rcvSize),
+        sndSize(sndSize)
     {
     }
 
+    /**
+     * The connection buffer receive size.
+     */
     int rcvSize = 0;
+    /**
+     * The connection buffer send size.
+     */
     int sndSize = 0;
 };
 
+/**
+ * Provides access to the connection details of a UDP connection
+ * \headerfile Ice/Ice.h
+ */
 class ICE_CLASS(ICE_API) UDPConnectionInfo : public ::Ice::IPConnectionInfo
 {
 public:
@@ -335,21 +642,52 @@ public:
     UDPConnectionInfo& operator=(const UDPConnectionInfo&) = default;
     UDPConnectionInfo& operator=(UDPConnectionInfo&&) = default;
 
-    UDPConnectionInfo(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_localAddress, int iceP_localPort, const ::std::string& iceP_remoteAddress, int iceP_remotePort, const ::std::string& iceP_mcastAddress, int iceP_mcastPort, int iceP_rcvSize, int iceP_sndSize) :
-        ::Ice::IPConnectionInfo(::std::move(iceP_underlying), iceP_incoming, ::std::move(iceP_adapterName), ::std::move(iceP_connectionId), ::std::move(iceP_localAddress), iceP_localPort, ::std::move(iceP_remoteAddress), iceP_remotePort),
-        mcastAddress(::std::move(iceP_mcastAddress)),
-        mcastPort(iceP_mcastPort),
-        rcvSize(iceP_rcvSize),
-        sndSize(iceP_sndSize)
+    /**
+     * 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 localAddress The local address.
+     * @param localPort The local port.
+     * @param remoteAddress The remote address.
+     * @param remotePort The remote port.
+     * @param mcastAddress The multicast address.
+     * @param mcastPort The multicast port.
+     * @param rcvSize The connection buffer receive size.
+     * @param sndSize The connection buffer send size.
+     */
+    UDPConnectionInfo(const ::std::shared_ptr<::Ice::ConnectionInfo>& underlying, bool incoming, const ::std::string& adapterName, const ::std::string& connectionId, const ::std::string& localAddress, int localPort, const ::std::string& remoteAddress, int remotePort, const ::std::string& mcastAddress, int mcastPort, int rcvSize, int sndSize) :
+        IPConnectionInfo(underlying, incoming, adapterName, connectionId, localAddress, localPort, remoteAddress, remotePort),
+        mcastAddress(mcastAddress),
+        mcastPort(mcastPort),
+        rcvSize(rcvSize),
+        sndSize(sndSize)
     {
     }
 
+    /**
+     * The multicast address.
+     */
     ::std::string mcastAddress;
+    /**
+     * The multicast port.
+     */
     int mcastPort = -1;
+    /**
+     * The connection buffer receive size.
+     */
     int rcvSize = 0;
+    /**
+     * The connection buffer send size.
+     */
     int sndSize = 0;
 };
 
+/**
+ * Provides access to the connection details of a WebSocket connection
+ * \headerfile Ice/Ice.h
+ */
 class ICE_CLASS(ICE_API) WSConnectionInfo : public ::Ice::ConnectionInfo
 {
 public:
@@ -363,22 +701,36 @@ public:
     WSConnectionInfo& operator=(const WSConnectionInfo&) = default;
     WSConnectionInfo& operator=(WSConnectionInfo&&) = default;
 
-    WSConnectionInfo(const ::std::shared_ptr<::Ice::ConnectionInfo>& iceP_underlying, bool iceP_incoming, const ::std::string& iceP_adapterName, const ::std::string& iceP_connectionId, const ::Ice::HeaderDict& iceP_headers) :
-        ::Ice::ConnectionInfo(::std::move(iceP_underlying), iceP_incoming, ::std::move(iceP_adapterName), ::std::move(iceP_connectionId)),
-        headers(::std::move(iceP_headers))
+    /**
+     * 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 headers The headers from the HTTP upgrade request.
+     */
+    WSConnectionInfo(const ::std::shared_ptr<::Ice::ConnectionInfo>& underlying, bool incoming, const ::std::string& adapterName, const ::std::string& connectionId, const ::Ice::HeaderDict& headers) :
+        ConnectionInfo(underlying, incoming, adapterName, connectionId),
+        headers(headers)
     {
     }
 
+    /**
+     * The headers from the HTTP upgrade request.
+     */
     ::Ice::HeaderDict headers;
 };
 
 }
 
+/// \cond STREAM
 namespace Ice
 {
 
 }
+/// \endcond
 
+/// \cond INTERNAL
 namespace Ice
 {
 
@@ -395,6 +747,7 @@ using UDPConnectionInfoPtr = ::std::shared_ptr<UDPConnectionInfo>;
 using WSConnectionInfoPtr = ::std::shared_ptr<WSConnectionInfo>;
 
 }
+/// \endcond
 
 #else // C++98 mapping
 
@@ -402,70 +755,147 @@ namespace Ice
 {
 
 class ConnectionInfo;
-ICE_API ::Ice::LocalObject* upCast(::Ice::ConnectionInfo*);
-typedef ::IceInternal::Handle< ::Ice::ConnectionInfo> ConnectionInfoPtr;
+/// \cond INTERNAL
+ICE_API LocalObject* upCast(ConnectionInfo*);
+/// \endcond
+typedef ::IceInternal::Handle< ConnectionInfo> ConnectionInfoPtr;
 
 class Connection;
-ICE_API ::Ice::LocalObject* upCast(::Ice::Connection*);
-typedef ::IceInternal::Handle< ::Ice::Connection> ConnectionPtr;
+/// \cond INTERNAL
+ICE_API LocalObject* upCast(Connection*);
+/// \endcond
+typedef ::IceInternal::Handle< Connection> ConnectionPtr;
 
 class CloseCallback;
-ICE_API ::Ice::LocalObject* upCast(::Ice::CloseCallback*);
-typedef ::IceInternal::Handle< ::Ice::CloseCallback> CloseCallbackPtr;
+/// \cond INTERNAL
+ICE_API LocalObject* upCast(CloseCallback*);
+/// \endcond
+typedef ::IceInternal::Handle< CloseCallback> CloseCallbackPtr;
 
 class HeartbeatCallback;
-ICE_API ::Ice::LocalObject* upCast(::Ice::HeartbeatCallback*);
-typedef ::IceInternal::Handle< ::Ice::HeartbeatCallback> HeartbeatCallbackPtr;
+/// \cond INTERNAL
+ICE_API LocalObject* upCast(HeartbeatCallback*);
+/// \endcond
+typedef ::IceInternal::Handle< HeartbeatCallback> HeartbeatCallbackPtr;
 
 class IPConnectionInfo;
-ICE_API ::Ice::LocalObject* upCast(::Ice::IPConnectionInfo*);
-typedef ::IceInternal::Handle< ::Ice::IPConnectionInfo> IPConnectionInfoPtr;
+/// \cond INTERNAL
+ICE_API LocalObject* upCast(IPConnectionInfo*);
+/// \endcond
+typedef ::IceInternal::Handle< IPConnectionInfo> IPConnectionInfoPtr;
 
 class TCPConnectionInfo;
-ICE_API ::Ice::LocalObject* upCast(::Ice::TCPConnectionInfo*);
-typedef ::IceInternal::Handle< ::Ice::TCPConnectionInfo> TCPConnectionInfoPtr;
+/// \cond INTERNAL
+ICE_API LocalObject* upCast(TCPConnectionInfo*);
+/// \endcond
+typedef ::IceInternal::Handle< TCPConnectionInfo> TCPConnectionInfoPtr;
 
 class UDPConnectionInfo;
-ICE_API ::Ice::LocalObject* upCast(::Ice::UDPConnectionInfo*);
-typedef ::IceInternal::Handle< ::Ice::UDPConnectionInfo> UDPConnectionInfoPtr;
+/// \cond INTERNAL
+ICE_API LocalObject* upCast(UDPConnectionInfo*);
+/// \endcond
+typedef ::IceInternal::Handle< UDPConnectionInfo> UDPConnectionInfoPtr;
 
 class WSConnectionInfo;
-ICE_API ::Ice::LocalObject* upCast(::Ice::WSConnectionInfo*);
-typedef ::IceInternal::Handle< ::Ice::WSConnectionInfo> WSConnectionInfoPtr;
+/// \cond INTERNAL
+ICE_API LocalObject* upCast(WSConnectionInfo*);
+/// \endcond
+typedef ::IceInternal::Handle< WSConnectionInfo> WSConnectionInfoPtr;
 
 }
 
 namespace Ice
 {
 
+/**
+ * The batch compression option when flushing queued batch requests.
+ */
 enum CompressBatch
 {
+    /**
+     * Compress the batch requests.
+     */
     CompressBatchYes,
+    /**
+     * Don't compress the batch requests.
+     */
     CompressBatchNo,
+    /**
+     * Compress the batch requests if at least one request was
+     * made on a compressed proxy.
+     */
     CompressBatchBasedOnProxy
 };
 
+/**
+ * Specifies the close semantics for Active Connection Management.
+ */
 enum ACMClose
 {
+    /**
+     * Disables automatic connection closure.
+     */
     CloseOff,
+    /**
+     * Gracefully closes a connection that has been idle for the configured timeout period.
+     */
     CloseOnIdle,
+    /**
+     * Forcefully closes a connection that has been idle for the configured timeout period,
+     * but only if the connection has pending invocations.
+     */
     CloseOnInvocation,
+    /**
+     * Combines the behaviors of CloseOnIdle and CloseOnInvocation.
+     */
     CloseOnInvocationAndIdle,
+    /**
+     * Forcefully closes a connection that has been idle for the configured timeout period,
+     * regardless of whether the connection has pending invocations or dispatch.
+     */
     CloseOnIdleForceful
 };
 
+/**
+ * Specifies the heartbeat semantics for Active Connection Management.
+ */
 enum ACMHeartbeat
 {
+    /**
+     * Disables heartbeats.
+     */
     HeartbeatOff,
+    /**
+     * Send a heartbeat at regular intervals if the connection is idle and only if there are pending dispatch.
+     */
     HeartbeatOnDispatch,
+    /**
+     * Send a heartbeat at regular intervals when the connection is idle.
+     */
     HeartbeatOnIdle,
+    /**
+     * Send a heartbeat at regular intervals until the connection is closed.
+     */
     HeartbeatAlways
 };
 
+/**
+ * A collection of Active Connection Management configuration settings.
+ * \headerfile Ice/Ice.h
+ */
 struct ACM
 {
+    /**
+     * A timeout value in seconds.
+     */
     ::Ice::Int timeout;
+    /**
+     * The close semantics.
+     */
     ::Ice::ACMClose close;
+    /**
+     * The heartbeat semantics.
+     */
     ::Ice::ACMHeartbeat heartbeat;
 
     bool operator==(const ACM& rhs_) const
@@ -540,13 +970,30 @@ struct ACM
     }
 };
 
+/**
+ * Determines the behavior when manually closing a connection.
+ */
 enum ConnectionClose
 {
+    /**
+     * Close the connection immediately without sending a close connection protocol message to the peer
+     * and waiting for the peer to acknowledge it.
+     */
     ConnectionCloseForcefully,
+    /**
+     * Close the connection by notifying the peer but do not wait for pending outgoing invocations to complete.
+     * On the server side, the connection will not be closed until all incoming invocations have completed.
+     */
     ConnectionCloseGracefully,
+    /**
+     * Wait for all pending invocations to complete before closing the connection.
+     */
     ConnectionCloseGracefullyWithWait
 };
 
+/**
+ * A collection of HTTP headers.
+ */
 typedef ::std::map< ::std::string, ::std::string> HeaderDict;
 
 }
@@ -554,9 +1001,19 @@ typedef ::std::map< ::std::string, ::std::string> HeaderDict;
 namespace Ice
 {
 
+/**
+ * Base class for asynchronous callback wrapper classes used for calls to
+ * IceProxy::Ice::Connection::begin_flushBatchRequests.
+ * Create a wrapper instance by calling ::Ice::newCallback_Connection_flushBatchRequests.
+ */
 class Callback_Connection_flushBatchRequests_Base : public virtual ::IceInternal::CallbackBase { };
 typedef ::IceUtil::Handle< Callback_Connection_flushBatchRequests_Base> Callback_Connection_flushBatchRequestsPtr;
 
+/**
+ * Base class for asynchronous callback wrapper classes used for calls to
+ * IceProxy::Ice::Connection::begin_heartbeat.
+ * Create a wrapper instance by calling ::Ice::newCallback_Connection_heartbeat.
+ */
 class Callback_Connection_heartbeat_Base : public virtual ::IceInternal::CallbackBase { };
 typedef ::IceUtil::Handle< Callback_Connection_heartbeat_Base> Callback_Connection_heartbeatPtr;
 
@@ -565,7 +1022,11 @@ typedef ::IceUtil::Handle< Callback_Connection_heartbeat_Base> Callback_Connecti
 namespace Ice
 {
 
-class ICE_API ConnectionInfo : public virtual ::Ice::LocalObject
+/**
+ * Base class providing access to the connection details.
+ * \headerfile Ice/Ice.h
+ */
+class ICE_API ConnectionInfo : public virtual LocalObject
 {
 public:
 
@@ -577,31 +1038,60 @@ public:
     {
     }
 
-    ConnectionInfo(const ::Ice::ConnectionInfoPtr& iceP_underlying, bool iceP_incoming, const ::std::string& iceP_adapterName, const ::std::string& iceP_connectionId) :
-        underlying(iceP_underlying),
-        incoming(iceP_incoming),
-        adapterName(iceP_adapterName),
-        connectionId(iceP_connectionId)
+    /**
+     * 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.
+     */
+    ConnectionInfo(const ::Ice::ConnectionInfoPtr& underlying, bool incoming, const ::std::string& adapterName, const ::std::string& connectionId) :
+        underlying(underlying),
+        incoming(incoming),
+        adapterName(adapterName),
+        connectionId(connectionId)
     {
     }
 
+    /**
+     * The information of the underyling transport or null if there's
+     * no underlying transport.
+     */
     ::Ice::ConnectionInfoPtr underlying;
+    /**
+     * Whether or not the connection is an incoming or outgoing
+     * connection.
+     */
     bool incoming;
+    /**
+     * The name of the adapter associated with the connection.
+     */
     ::std::string adapterName;
+    /**
+     * The connection id.
+     */
     ::std::string connectionId;
 };
 
+/// \cond INTERNAL
 inline bool operator==(const ConnectionInfo& lhs, const ConnectionInfo& 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 ConnectionInfo& lhs, const ConnectionInfo& 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 CloseCallback : public virtual ::Ice::LocalObject
+/// \endcond
+
+/**
+ * An application can implement this interface to receive notifications when
+ * a connection closes.
+ * @see Connection#setCloseCallback
+ * \headerfile Ice/Ice.h
+ */
+class ICE_API CloseCallback : public virtual LocalObject
 {
 public:
 
@@ -609,20 +1099,34 @@ public:
 
     virtual ~CloseCallback();
 
-    virtual void closed(const ::Ice::ConnectionPtr&) = 0;
+    /**
+     * This method is called by the the connection when the connection
+     * is closed. If the callback needs more information about the closure,
+     * it can call {@link Connection#throwException}.
+     * @param con The connection that closed.
+     */
+    virtual void closed(const ConnectionPtr& con) = 0;
 };
 
+/// \cond INTERNAL
 inline bool operator==(const CloseCallback& lhs, const CloseCallback& 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 CloseCallback& lhs, const CloseCallback& 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 HeartbeatCallback : public virtual ::Ice::LocalObject
+/// \endcond
+
+/**
+ * An application can implement this interface to receive notifications when
+ * a connection receives a heartbeat message.
+ * @see Connection#setHeartbeatCallback
+ * \headerfile Ice/Ice.h
+ */
+class ICE_API HeartbeatCallback : public virtual LocalObject
 {
 public:
 
@@ -630,20 +1134,31 @@ public:
 
     virtual ~HeartbeatCallback();
 
-    virtual void heartbeat(const ::Ice::ConnectionPtr&) = 0;
+    /**
+     * This method is called by the the connection when a heartbeat is
+     * received from the peer.
+     * @param con The connection on which a heartbeat was received.
+     */
+    virtual void heartbeat(const ConnectionPtr& con) = 0;
 };
 
+/// \cond INTERNAL
 inline bool operator==(const HeartbeatCallback& lhs, const HeartbeatCallback& 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 HeartbeatCallback& lhs, const HeartbeatCallback& 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
 
-class ICE_API Connection : public virtual ::Ice::LocalObject
+/**
+ * The user-level interface to a connection.
+ * \headerfile Ice/Ice.h
+ */
+class ICE_API Connection : public virtual LocalObject
 {
 public:
 
@@ -651,68 +1166,236 @@ public:
 
     virtual ~Connection();
 
-    virtual void close(::Ice::ConnectionClose) = 0;
-
-    virtual ::Ice::ObjectPrx createProxy(const ::Ice::Identity&) const = 0;
-
-    virtual void setAdapter(const ::Ice::ObjectAdapterPtr&) = 0;
-
-    virtual ::Ice::ObjectAdapterPtr getAdapter() const = 0;
-
-    virtual ::Ice::EndpointPtr getEndpoint() const = 0;
-
-    virtual void flushBatchRequests(::Ice::CompressBatch) = 0;
-
-    virtual ::Ice::AsyncResultPtr begin_flushBatchRequests(::Ice::CompressBatch compress) = 0;
-
-    virtual ::Ice::AsyncResultPtr begin_flushBatchRequests(::Ice::CompressBatch compress, const ::Ice::CallbackPtr& del, const ::Ice::LocalObjectPtr& cookie = 0) = 0;
-
-    virtual ::Ice::AsyncResultPtr begin_flushBatchRequests(::Ice::CompressBatch compress, const ::Ice::Callback_Connection_flushBatchRequestsPtr& del, const ::Ice::LocalObjectPtr& cookie = 0) = 0;
-
-    virtual void end_flushBatchRequests(const ::Ice::AsyncResultPtr&) = 0;
-
-    virtual void setCloseCallback(const ::Ice::CloseCallbackPtr&) = 0;
-
-    virtual void setHeartbeatCallback(const ::Ice::HeartbeatCallbackPtr&) = 0;
-
+    /**
+     * Manually close the connection using the specified closure mode.
+     * @param mode Determines how the connection will be closed.
+     * @see ConnectionClose
+     */
+    virtual void close(ConnectionClose mode) ICE_NOEXCEPT = 0;
+
+    /**
+     * Create a special proxy that always uses this connection. This
+     * can be used for callbacks from a server to a client if the
+     * server cannot directly establish a connection to the client,
+     * for example because of firewalls. In this case, the server
+     * would create a proxy using an already established connection
+     * from the client.
+     * @param id The identity for which a proxy is to be created.
+     * @return A proxy that matches the given identity and uses this
+     * connection.
+     * @see #setAdapter
+     */
+    virtual ObjectPrx createProxy(const Identity& id) const = 0;
+
+    /**
+     * Explicitly set an object adapter that dispatches requests that
+     * are received over this connection. A client can invoke an
+     * operation on a server using a proxy, and then set an object
+     * adapter for the outgoing connection that is used by the proxy
+     * in order to receive callbacks. This is useful if the server
+     * cannot establish a connection back to the client, for example
+     * because of firewalls.
+     * @param adapter The object adapter that should be used by this
+     * connection to dispatch requests. The object adapter must be
+     * activated. When the object adapter is deactivated, it is
+     * automatically removed from the connection. Attempts to use a
+     * deactivated object adapter raise {@link ObjectAdapterDeactivatedException}
+     * @see #createProxy
+     * @see #getAdapter
+     */
+    virtual void setAdapter(const ObjectAdapterPtr& adapter) = 0;
+
+    /**
+     * Get the object adapter that dispatches requests for this
+     * connection.
+     * @return The object adapter that dispatches requests for the
+     * connection, or null if no adapter is set.
+     * @see #setAdapter
+     */
+    virtual ObjectAdapterPtr getAdapter() const ICE_NOEXCEPT = 0;
+
+    /**
+     * Get the endpoint from which the connection was created.
+     * @return The endpoint from which the connection was created.
+     */
+    virtual EndpointPtr getEndpoint() const ICE_NOEXCEPT = 0;
+
+    /**
+     * Flush any pending batch requests for this connection.
+     * This means all batch requests invoked on fixed proxies
+     * associated with the connection.
+     * @param compress Specifies whether or not the queued batch requests
+     * should be compressed before being sent over the wire.
+     */
+    virtual void flushBatchRequests(CompressBatch compress) = 0;
+
+    /**
+     * Flush any pending batch requests for this connection.
+     * This means all batch requests invoked on fixed proxies
+     * associated with the connection.
+     * @param compress Specifies whether or not the queued batch requests
+     * should be compressed before being sent over the wire.
+     * @return The asynchronous result object for the invocation.
+     */
+    virtual AsyncResultPtr begin_flushBatchRequests(CompressBatch compress) = 0;
+
+    /**
+     * Flush any pending batch requests for this connection.
+     * This means all batch requests invoked on fixed proxies
+     * associated with the connection.
+     * @param compress Specifies whether or not the queued batch requests
+     * should be compressed before being sent over the wire.
+     * @param cb Callback to be invoked when the invocation completes
+     * @param cookie Extra data to associate with the invocation.
+     * @return The asynchronous result object for the invocation.
+     */
+    virtual AsyncResultPtr begin_flushBatchRequests(CompressBatch compress, const CallbackPtr& cb, const LocalObjectPtr& cookie = 0) = 0;
+
+    /**
+     * Flush any pending batch requests for this connection.
+     * This means all batch requests invoked on fixed proxies
+     * associated with the connection.
+     * @param compress Specifies whether or not the queued batch requests
+     * should be compressed before being sent over the wire.
+     * @param cb Callback to be invoked when the invocation completes
+     * @param cookie Extra data to associate with the invocation.
+     * @return The asynchronous result object for the invocation.
+     */
+    virtual AsyncResultPtr begin_flushBatchRequests(CompressBatch compress, const Callback_Connection_flushBatchRequestsPtr& cb, const LocalObjectPtr& cookie = 0) = 0;
+
+    /**
+     * Flush any pending batch requests for this connection.
+     * This means all batch requests invoked on fixed proxies
+     * associated with the connection.
+     * @param result The asynchronous result object returned by the begin_ method.
+     */
+    virtual void end_flushBatchRequests(const AsyncResultPtr& result) = 0;
+
+    /**
+     * Set a close callback on the connection. The callback is called by the
+     * connection when it's closed. The callback is called from the
+     * Ice thread pool associated with the connection. If the callback needs
+     * more information about the closure, it can call {@link Connection#throwException}.
+     * @param callback The close callback object.
+     */
+    virtual void setCloseCallback(const CloseCallbackPtr& callback) = 0;
+
+    /**
+     * Set a heartbeat callback on the connection. The callback is called by the
+     * connection when a heartbeat is received. The callback is called
+     * from the Ice thread pool associated with the connection.
+     * @param callback The heartbeat callback object.
+     */
+    virtual void setHeartbeatCallback(const HeartbeatCallbackPtr& callback) = 0;
+
+    /**
+     * Send a heartbeat message.
+     */
     virtual void heartbeat() = 0;
 
-    virtual ::Ice::AsyncResultPtr begin_heartbeat() = 0;
-
-    virtual ::Ice::AsyncResultPtr begin_heartbeat(const ::Ice::CallbackPtr& del, const ::Ice::LocalObjectPtr& cookie = 0) = 0;
-
-    virtual ::Ice::AsyncResultPtr begin_heartbeat(const ::Ice::Callback_Connection_heartbeatPtr& del, const ::Ice::LocalObjectPtr& cookie = 0) = 0;
-
-    virtual void end_heartbeat(const ::Ice::AsyncResultPtr&) = 0;
-
-    virtual void setACM(const IceUtil::Optional< ::Ice::Int>&, const IceUtil::Optional< ::Ice::ACMClose>&, const IceUtil::Optional< ::Ice::ACMHeartbeat>&) = 0;
-
-    virtual ::Ice::ACM getACM() = 0;
-
-    virtual ::std::string type() const = 0;
-
-    virtual ::Ice::Int timeout() const = 0;
-
-    virtual ::std::string toString() const = 0;
-
-    virtual ::Ice::ConnectionInfoPtr getInfo() const = 0;
-
-    virtual void setBufferSize(::Ice::Int, ::Ice::Int) = 0;
-
+    /**
+     * Send a heartbeat message.
+     * @return The asynchronous result object for the invocation.
+     */
+    virtual AsyncResultPtr begin_heartbeat() = 0;
+
+    /**
+     * Send a heartbeat message.
+     * @param cb Callback to be invoked when the invocation completes
+     * @param cookie Extra data to associate with the invocation.
+     * @return The asynchronous result object for the invocation.
+     */
+    virtual AsyncResultPtr begin_heartbeat(const CallbackPtr& cb, const LocalObjectPtr& cookie = 0) = 0;
+
+    /**
+     * Send a heartbeat message.
+     * @param cb Callback to be invoked when the invocation completes
+     * @param cookie Extra data to associate with the invocation.
+     * @return The asynchronous result object for the invocation.
+     */
+    virtual AsyncResultPtr begin_heartbeat(const Callback_Connection_heartbeatPtr& cb, const LocalObjectPtr& cookie = 0) = 0;
+
+    /**
+     * Send a heartbeat message.
+     * @param result The asynchronous result object returned by the begin_ method.
+     */
+    virtual void end_heartbeat(const AsyncResultPtr& result) = 0;
+
+    /**
+     * Set the active connection management parameters.
+     * @param timeout The timeout value in seconds, must be &gt;= 0.
+     * @param close The close condition
+     * @param heartbeat The hertbeat condition
+     */
+    virtual void setACM(const IceUtil::Optional<Int>& timeout, const IceUtil::Optional<ACMClose>& close, const IceUtil::Optional<ACMHeartbeat>& heartbeat) = 0;
+
+    /**
+     * Get the ACM parameters.
+     * @return The ACM parameters.
+     */
+    virtual ACM getACM() ICE_NOEXCEPT = 0;
+
+    /**
+     * Return the connection type. This corresponds to the endpoint
+     * type, i.e., "tcp", "udp", etc.
+     * @return The type of the connection.
+     */
+    virtual ::std::string type() const ICE_NOEXCEPT = 0;
+
+    /**
+     * Get the timeout for the connection.
+     * @return The connection's timeout.
+     */
+    virtual Int timeout() const ICE_NOEXCEPT = 0;
+
+    /**
+     * Return a description of the connection as human readable text,
+     * suitable for logging or error messages.
+     * @return The description of the connection as human readable
+     * text.
+     */
+    virtual ::std::string toString() const ICE_NOEXCEPT = 0;
+
+    /**
+     * Returns the connection information.
+     * @return The connection information.
+     */
+    virtual ConnectionInfoPtr getInfo() const = 0;
+
+    /**
+     * Set the connection buffer receive/send size.
+     * @param rcvSize The connection receive buffer size.
+     * @param sndSize The connection send buffer size.
+     */
+    virtual void setBufferSize(Int rcvSize, Int sndSize) = 0;
+
+    /**
+     * Throw an exception indicating the reason for connection closure. For example,
+     * {@link CloseConnectionException} is raised if the connection was closed gracefully,
+     * whereas {@link ConnectionManuallyClosedException} is raised if the connection was
+     * manually closed by the application. This operation does nothing if the connection is
+     * not yet closed.
+     */
     virtual void throwException() const = 0;
 };
 
+/// \cond INTERNAL
 inline bool operator==(const Connection& lhs, const Connection& 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 Connection& lhs, const Connection& 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
 
-class ICE_API IPConnectionInfo : public ::Ice::ConnectionInfo
+/**
+ * Provides access to the connection details of an IP connection
+ * \headerfile Ice/Ice.h
+ */
+class ICE_API IPConnectionInfo : public ConnectionInfo
 {
 public:
 
@@ -720,6 +1403,7 @@ public:
 
     virtual ~IPConnectionInfo();
 
+    /** Default constructor that assigns default values to members as specified in the Slice definition. */
     IPConnectionInfo() :
         localAddress(""),
         localPort(-1),
@@ -728,32 +1412,61 @@ public:
     {
     }
 
-    IPConnectionInfo(const ::Ice::ConnectionInfoPtr& iceP_underlying, bool iceP_incoming, const ::std::string& iceP_adapterName, const ::std::string& iceP_connectionId, const ::std::string& iceP_localAddress, ::Ice::Int iceP_localPort, const ::std::string& iceP_remoteAddress, ::Ice::Int iceP_remotePort) :
-        ::Ice::ConnectionInfo(iceP_underlying, iceP_incoming, iceP_adapterName, iceP_connectionId),
-        localAddress(iceP_localAddress),
-        localPort(iceP_localPort),
-        remoteAddress(iceP_remoteAddress),
-        remotePort(iceP_remotePort)
+    /**
+     * 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 localAddress The local address.
+     * @param localPort The local port.
+     * @param remoteAddress The remote address.
+     * @param remotePort The remote port.
+     */
+    IPConnectionInfo(const ::Ice::ConnectionInfoPtr& underlying, bool incoming, const ::std::string& adapterName, const ::std::string& connectionId, const ::std::string& localAddress, ::Ice::Int localPort, const ::std::string& remoteAddress, ::Ice::Int remotePort) :
+        ::Ice::ConnectionInfo(underlying, incoming, adapterName, connectionId),
+        localAddress(localAddress),
+        localPort(localPort),
+        remoteAddress(remoteAddress),
+        remotePort(remotePort)
     {
     }
 
+    /**
+     * The local address.
+     */
     ::std::string localAddress;
+    /**
+     * The local port.
+     */
     ::Ice::Int localPort;
+    /**
+     * The remote address.
+     */
     ::std::string remoteAddress;
+    /**
+     * The remote port.
+     */
     ::Ice::Int remotePort;
 };
 
+/// \cond INTERNAL
 inline bool operator==(const IPConnectionInfo& lhs, const IPConnectionInfo& 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 IPConnectionInfo& lhs, const IPConnectionInfo& 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
 
-class ICE_API TCPConnectionInfo : public ::Ice::IPConnectionInfo
+/**
+ * Provides access to the connection details of a TCP connection
+ * \headerfile Ice/Ice.h
+ */
+class ICE_API TCPConnectionInfo : public IPConnectionInfo
 {
 public:
 
@@ -761,34 +1474,60 @@ public:
 
     virtual ~TCPConnectionInfo();
 
+    /** Default constructor that assigns default values to members as specified in the Slice definition. */
     TCPConnectionInfo() :
         rcvSize(0),
         sndSize(0)
     {
     }
 
-    TCPConnectionInfo(const ::Ice::ConnectionInfoPtr& iceP_underlying, bool iceP_incoming, const ::std::string& iceP_adapterName, const ::std::string& iceP_connectionId, const ::std::string& iceP_localAddress, ::Ice::Int iceP_localPort, const ::std::string& iceP_remoteAddress, ::Ice::Int iceP_remotePort, ::Ice::Int iceP_rcvSize, ::Ice::Int iceP_sndSize) :
-        ::Ice::IPConnectionInfo(iceP_underlying, iceP_incoming, iceP_adapterName, iceP_connectionId, iceP_localAddress, iceP_localPort, iceP_remoteAddress, iceP_remotePort),
-        rcvSize(iceP_rcvSize),
-        sndSize(iceP_sndSize)
+    /**
+     * 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 localAddress The local address.
+     * @param localPort The local port.
+     * @param remoteAddress The remote address.
+     * @param remotePort The remote port.
+     * @param rcvSize The connection buffer receive size.
+     * @param sndSize The connection buffer send size.
+     */
+    TCPConnectionInfo(const ::Ice::ConnectionInfoPtr& underlying, bool incoming, const ::std::string& adapterName, const ::std::string& connectionId, const ::std::string& localAddress, ::Ice::Int localPort, const ::std::string& remoteAddress, ::Ice::Int remotePort, ::Ice::Int rcvSize, ::Ice::Int sndSize) :
+        ::Ice::IPConnectionInfo(underlying, incoming, adapterName, connectionId, localAddress, localPort, remoteAddress, remotePort),
+        rcvSize(rcvSize),
+        sndSize(sndSize)
     {
     }
 
+    /**
+     * The connection buffer receive size.
+     */
     ::Ice::Int rcvSize;
+    /**
+     * The connection buffer send size.
+     */
     ::Ice::Int sndSize;
 };
 
+/// \cond INTERNAL
 inline bool operator==(const TCPConnectionInfo& lhs, const TCPConnectionInfo& 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 TCPConnectionInfo& lhs, const TCPConnectionInfo& 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
 
-class ICE_API UDPConnectionInfo : public ::Ice::IPConnectionInfo
+/**
+ * Provides access to the connection details of a UDP connection
+ * \headerfile Ice/Ice.h
+ */
+class ICE_API UDPConnectionInfo : public IPConnectionInfo
 {
 public:
 
@@ -796,6 +1535,7 @@ public:
 
     virtual ~UDPConnectionInfo();
 
+    /** Default constructor that assigns default values to members as specified in the Slice definition. */
     UDPConnectionInfo() :
         mcastPort(-1),
         rcvSize(0),
@@ -803,32 +1543,65 @@ public:
     {
     }
 
-    UDPConnectionInfo(const ::Ice::ConnectionInfoPtr& iceP_underlying, bool iceP_incoming, const ::std::string& iceP_adapterName, const ::std::string& iceP_connectionId, const ::std::string& iceP_localAddress, ::Ice::Int iceP_localPort, const ::std::string& iceP_remoteAddress, ::Ice::Int iceP_remotePort, const ::std::string& iceP_mcastAddress, ::Ice::Int iceP_mcastPort, ::Ice::Int iceP_rcvSize, ::Ice::Int iceP_sndSize) :
-        ::Ice::IPConnectionInfo(iceP_underlying, iceP_incoming, iceP_adapterName, iceP_connectionId, iceP_localAddress, iceP_localPort, iceP_remoteAddress, iceP_remotePort),
-        mcastAddress(iceP_mcastAddress),
-        mcastPort(iceP_mcastPort),
-        rcvSize(iceP_rcvSize),
-        sndSize(iceP_sndSize)
+    /**
+     * 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 localAddress The local address.
+     * @param localPort The local port.
+     * @param remoteAddress The remote address.
+     * @param remotePort The remote port.
+     * @param mcastAddress The multicast address.
+     * @param mcastPort The multicast port.
+     * @param rcvSize The connection buffer receive size.
+     * @param sndSize The connection buffer send size.
+     */
+    UDPConnectionInfo(const ::Ice::ConnectionInfoPtr& underlying, bool incoming, const ::std::string& adapterName, const ::std::string& connectionId, const ::std::string& localAddress, ::Ice::Int localPort, const ::std::string& remoteAddress, ::Ice::Int remotePort, const ::std::string& mcastAddress, ::Ice::Int mcastPort, ::Ice::Int rcvSize, ::Ice::Int sndSize) :
+        ::Ice::IPConnectionInfo(underlying, incoming, adapterName, connectionId, localAddress, localPort, remoteAddress, remotePort),
+        mcastAddress(mcastAddress),
+        mcastPort(mcastPort),
+        rcvSize(rcvSize),
+        sndSize(sndSize)
     {
     }
 
+    /**
+     * The multicast address.
+     */
     ::std::string mcastAddress;
+    /**
+     * The multicast port.
+     */
     ::Ice::Int mcastPort;
+    /**
+     * The connection buffer receive size.
+     */
     ::Ice::Int rcvSize;
+    /**
+     * The connection buffer send size.
+     */
     ::Ice::Int sndSize;
 };
 
+/// \cond INTERNAL
 inline bool operator==(const UDPConnectionInfo& lhs, const UDPConnectionInfo& 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 UDPConnectionInfo& lhs, const UDPConnectionInfo& 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
 
-class ICE_API WSConnectionInfo : public ::Ice::ConnectionInfo
+/**
+ * Provides access to the connection details of a WebSocket connection
+ * \headerfile Ice/Ice.h
+ */
+class ICE_API WSConnectionInfo : public ConnectionInfo
 {
 public:
 
@@ -840,31 +1613,46 @@ public:
     {
     }
 
-    WSConnectionInfo(const ::Ice::ConnectionInfoPtr& iceP_underlying, bool iceP_incoming, const ::std::string& iceP_adapterName, const ::std::string& iceP_connectionId, const ::Ice::HeaderDict& iceP_headers) :
-        ::Ice::ConnectionInfo(iceP_underlying, iceP_incoming, iceP_adapterName, iceP_connectionId),
-        headers(iceP_headers)
+    /**
+     * 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 headers The headers from the HTTP upgrade request.
+     */
+    WSConnectionInfo(const ::Ice::ConnectionInfoPtr& underlying, bool incoming, const ::std::string& adapterName, const ::std::string& connectionId, const ::Ice::HeaderDict& headers) :
+        ::Ice::ConnectionInfo(underlying, incoming, adapterName, connectionId),
+        headers(headers)
     {
     }
 
+    /**
+     * The headers from the HTTP upgrade request.
+     */
     ::Ice::HeaderDict headers;
 };
 
+/// \cond INTERNAL
 inline bool operator==(const WSConnectionInfo& lhs, const WSConnectionInfo& 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 WSConnectionInfo& lhs, const WSConnectionInfo& 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