summaryrefslogtreecommitdiff
path: root/qpid/cpp/src
diff options
context:
space:
mode:
authorJonathan Robie <jonathan@apache.org>2010-07-28 19:07:04 +0000
committerJonathan Robie <jonathan@apache.org>2010-07-28 19:07:04 +0000
commit37393a5f1bf74e796561619d1dbd1ac680a397e7 (patch)
tree9f1ad590a6c88c11e853a2e1089c36dedfcc2d7c /qpid/cpp/src
parentf2d8997be0a6c78ea40dc5d54babc19487a66de5 (diff)
downloadqpid-python-37393a5f1bf74e796561619d1dbd1ac680a397e7.tar.gz
Improved doxygen comments.
git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk@980163 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'qpid/cpp/src')
-rw-r--r--qpid/cpp/src/qpid/sys/Poller.h10
1 files changed, 8 insertions, 2 deletions
diff --git a/qpid/cpp/src/qpid/sys/Poller.h b/qpid/cpp/src/qpid/sys/Poller.h
index 47b7606a16..ec53b79bad 100644
--- a/qpid/cpp/src/qpid/sys/Poller.h
+++ b/qpid/cpp/src/qpid/sys/Poller.h
@@ -31,8 +31,14 @@ namespace qpid {
namespace sys {
/**
- * Poller: abstract class to encapsulate a file descriptor poll to be used
- * by a reactor.
+ * Poller is an abstract base class that registers callbacks to be
+ * called when there is IO activity. Concrete derived classes
+ * implement polling APIs such as epoll or equivalents on other
+ * operating systems.
+ *
+ * On the broker, Connection::received() is called with incoming
+ * frames from clients, and Connection::doOutput() is called when a
+ * connection is writeable.
*
* @see DispatchHandler for more details of normal use.
*/