diff options
author | Martin Lucina <mato@kotelna.sk> | 2010-12-01 10:57:37 +0100 |
---|---|---|
committer | Martin Sustrik <sustrik@250bpm.com> | 2010-12-01 10:57:37 +0100 |
commit | b70d628fad5ab97d24473b83fd18997b4e87477d (patch) | |
tree | 71d2556da535ece2407db7f983a30cf7a04419dc /doc/zmq_poll.txt | |
parent | 5bb0a339be31064900257e04e2ffd32e80911d63 (diff) |
Documentation updates for 2.1
- Clarify ZMQ_LINGER, zmq_close (), zmq_term () relationship
- New socket options
- Clarify thread safety of sockets and migration between threads
- Other minor and spelling fixes
Signed-off-by: Martin Lucina <mato@kotelna.sk>
Diffstat (limited to 'doc/zmq_poll.txt')
-rw-r--r-- | doc/zmq_poll.txt | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/doc/zmq_poll.txt b/doc/zmq_poll.txt index f709c07..e8e001c 100644 --- a/doc/zmq_poll.txt +++ b/doc/zmq_poll.txt @@ -40,17 +40,17 @@ 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 +member, and then indicate any requested events that have occurred by setting the bit corresponding to the event condition in the 'revents' member. -If none of the requested events have occured on any *zmq_pollitem_t* item, +If none of the requested events have occurred on any *zmq_pollitem_t* item, _zmq_poll()_ shall wait 'timeout' microseconds for an event to occur on any of the requested items. If the value of 'timeout' is `0`, _zmq_poll()_ shall return immediately. If the value of 'timeout' is `-1`, _zmq_poll()_ shall -block indefinitely until a requested event has occured on at least one +block indefinitely until a requested event has occurred on at least one *zmq_pollitem_t*. -The 'events' and 'revents' members of *zmq_pollitem_t* are bitmasks constructed +The 'events' and 'revents' members of *zmq_pollitem_t* are bit masks constructed by OR'ing a combination of the following event flags: *ZMQ_POLLIN*:: @@ -93,7 +93,8 @@ associated 0MQ 'context' was terminated. *EFAULT*:: The provided 'items' was not valid (NULL). *EINTR*:: -The poll was interrupted by delivery of a signal before any event was available. +The operation was interrupted by delivery of a signal before any events were +available. EXAMPLE |