summaryrefslogtreecommitdiff
path: root/doc/zmq_poll.txt
diff options
context:
space:
mode:
authorMartin Lucina <mato@kotelna.sk>2010-06-02 18:36:34 +0200
committerMartin Lucina <mato@kotelna.sk>2010-06-02 18:36:34 +0200
commit7c9b09bc511236c8cc5f6cea7623a8b98fedf302 (patch)
tree1a2f6be6ef87fb4a21c4ace9b36df0f3c06d0e6c /doc/zmq_poll.txt
parent9d00d300b0d6b45d2954792540cc95a0c3fb6a01 (diff)
Documentation: Flow control, zmq_socket(3)
Mostly Flow control and additions to zmq_socket(3) Removed/changed lots of text regarding message queues More fixes for 2.0.7 changes
Diffstat (limited to 'doc/zmq_poll.txt')
-rw-r--r--doc/zmq_poll.txt28
1 files changed, 14 insertions, 14 deletions
diff --git a/doc/zmq_poll.txt b/doc/zmq_poll.txt
index 9106b5b..d96af3e 100644
--- a/doc/zmq_poll.txt
+++ b/doc/zmq_poll.txt
@@ -54,18 +54,16 @@ The 'events' and 'revents' members of *zmq_pollitem_t* are bitmasks constructed
by OR'ing a combination of the following event flags:
*ZMQ_POLLIN*::
-For 0MQ sockets, at least one message may be dequeued from the underlying
-_message queue_ associated with 'socket' without blocking. For standard sockets
-this is equivalent to the 'POLLIN' flag of the _poll()_ system call and
-generally means that at least one byte of data may be read from 'fd' without
-blocking.
+For 0MQ sockets, at least one message may be received from the 'socket' without
+blocking. For standard sockets this is equivalent to the 'POLLIN' flag of the
+_poll()_ system call and generally means that at least one byte of data may be
+read from 'fd' without blocking.
*ZMQ_POLLOUT*::
-For 0MQ sockets, at least one message may be queued on the underlying
-_message queue_ associated with 'socket' without blocking. For standard sockets
-this is equivalent to the 'POLLOUT' flag of the _poll()_ system call and
-generally means that at least one byte of data may be written to 'fd'
-without blocking.
+For 0MQ sockets, at least one message may be sent to the 'socket' without
+blocking. For standard sockets this is equivalent to the 'POLLOUT' flag of the
+_poll()_ system call and generally means that at least one byte of data may be
+written to 'fd' without blocking.
*ZMQ_POLLERR*::
For standard sockets, this flag is passed through _zmq_poll()_ to the
@@ -82,10 +80,12 @@ of those interfaces in ways not defined in this documentation.
RETURN VALUE
------------
Upon successful completion, the _zmq_poll()_ function shall return the number
-of *zmq_pollitem_t* structures with events signaled in 'revents' or `0` if the
-'timeout' period has expired and no events have been signaled. Upon failure,
-_zmq_poll()_ shall return `-1` and set 'errno' to one of the values defined
-below.
+of *zmq_pollitem_t* structures with events signaled in 'revents' or `0` if no
+events have been signaled. Upon failure, _zmq_poll()_ shall return `-1` and set
+'errno' to one of the values defined below.
+
+IMPORTANT: The _zmq_poll()_ function may return *before* the 'timeout' period
+has expired even if no events have been signaled.
ERRORS