summaryrefslogtreecommitdiff
path: root/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
commitc0ef5a610cb0d717d37d7f0e2c44817150e2b28e (patch)
tree0dba925511119ee667cf4e2833cc5ceee06b1bfd /cpp/src
parent1c077959ef54f616ec12e9644b4f07557a3e220d (diff)
downloadqpid-python-c0ef5a610cb0d717d37d7f0e2c44817150e2b28e.tar.gz
Improved doxygen comments.
git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk/qpid@980163 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'cpp/src')
-rw-r--r--cpp/src/qpid/sys/Poller.h10
1 files changed, 8 insertions, 2 deletions
diff --git a/cpp/src/qpid/sys/Poller.h b/cpp/src/qpid/sys/Poller.h
index 47b7606a16..ec53b79bad 100644
--- a/cpp/src/qpid/sys/Poller.h
+++ b/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.
*/