summaryrefslogtreecommitdiff
path: root/doc/zmq_poll.txt
diff options
context:
space:
mode:
authorMartin Sustrik <sustrik@250bpm.com>2010-03-16 15:23:55 +0100
committerMartin Sustrik <sustrik@250bpm.com>2010-03-16 15:23:55 +0100
commit8a3f97400a2b3ef2ec088a00868087b85cfd81b6 (patch)
tree19db284aa7dec3c4d473bc5caf3a5b120842edf9 /doc/zmq_poll.txt
parent1705ec224745b935e13d8f18ef81bcbef45ff143 (diff)
Clarify zmq_poll restrictions
Diffstat (limited to 'doc/zmq_poll.txt')
-rw-r--r--doc/zmq_poll.txt3
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/zmq_poll.txt b/doc/zmq_poll.txt
index a50d55e..a13cc4b 100644
--- a/doc/zmq_poll.txt
+++ b/doc/zmq_poll.txt
@@ -36,6 +36,9 @@ descriptor 'fd', for the event(s) specified in 'events'. If both 'socket' and
'fd' are set in a single *zmq_pollitem_t*, the 0MQ socket referenced by
'socket' shall take precedence and the value of 'fd' shall be ignored.
+NOTE: All 0MQ sockets passed to the _zmq_poll()_ function must share the
+same 0MQ 'context' and must belong to the thread calling _zmq_poll()_.
+
For each *zmq_pollitem_t* item, _zmq_poll()_ shall first clear the 'revents'
member, and then indicate any requested events that have occured by setting the
bit corresponding to the event condition in the 'revents' member.