summaryrefslogtreecommitdiff
path: root/cpp/src/qpid/SessionId.h
diff options
context:
space:
mode:
Diffstat (limited to 'cpp/src/qpid/SessionId.h')
-rw-r--r--cpp/src/qpid/SessionId.h12
1 files changed, 11 insertions, 1 deletions
diff --git a/cpp/src/qpid/SessionId.h b/cpp/src/qpid/SessionId.h
index 08553e8b1d..291c42a2bb 100644
--- a/cpp/src/qpid/SessionId.h
+++ b/cpp/src/qpid/SessionId.h
@@ -27,7 +27,17 @@
namespace qpid {
-/** Identifier for a session */
+/** Identifier for a session.
+ * There are two parts to a session identifier:
+ *
+ * getUserId() returns the authentication principal associated with
+ * the session's connection.
+ *
+ * getName() returns the session name.
+ *
+ * The name must be unique among sessions with the same authentication
+ * principal.
+ */
class SessionId : boost::totally_ordered1<SessionId> {
std::string userId;
std::string name;