summaryrefslogtreecommitdiff
path: root/qpid/cpp/src
diff options
context:
space:
mode:
authorJonathan Robie <jonathan@apache.org>2010-07-28 15:31:27 +0000
committerJonathan Robie <jonathan@apache.org>2010-07-28 15:31:27 +0000
commitcf0dbf0c6ecb6ac67d6a7089296f3d3eaaaa0ff5 (patch)
tree5089d3c5d9ffe56be7d87ba659e18665d30450f9 /qpid/cpp/src
parent3b641bf3bc773c4077c191dc139be84fc6e6fae4 (diff)
downloadqpid-python-cf0dbf0c6ecb6ac67d6a7089296f3d3eaaaa0ff5.tar.gz
Improved doxygen documentation of SessionState.
git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk@980096 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'qpid/cpp/src')
-rw-r--r--qpid/cpp/src/qpid/broker/SemanticState.h13
1 files changed, 11 insertions, 2 deletions
diff --git a/qpid/cpp/src/qpid/broker/SemanticState.h b/qpid/cpp/src/qpid/broker/SemanticState.h
index 2b314920e6..4a2adde415 100644
--- a/qpid/cpp/src/qpid/broker/SemanticState.h
+++ b/qpid/cpp/src/qpid/broker/SemanticState.h
@@ -53,8 +53,17 @@ namespace broker {
class SessionContext;
/**
- * SemanticState holds the L3 and L4 state of an open session, whether
- * attached to a channel or suspended.
+ *
+ * SemanticState implements the behavior of a Session, especially the
+ * state of consumers subscribed to queues. The code for ConsumerImpl
+ * is also in SemanticState.cpp
+ *
+ * SemanticState holds the AMQP Execution and Model state of an open
+ * session, whether attached to a channel or suspended.
+ *
+ * Message delivery is driven by ConsumerImpl::doOutput(), which is
+ * called when a client's socket is ready to write data.
+ *
*/
class SemanticState : private boost::noncopyable {
public: