diff options
| author | Ian Barber <ian.barber@gmail.com> | 2012-04-29 07:43:56 +0200 |
|---|---|---|
| committer | Martin Sustrik <sustrik@250bpm.com> | 2012-04-29 07:43:56 +0200 |
| commit | 2af62438193eb43bd8da817a64c3b30618c8beeb (patch) | |
| tree | 61276314f20c63e4ef612b74aabba7106e74a16a | |
| parent | ffc06a399711b69d44985b8c84c704c81fcdf336 (diff) | |
Refine documentation for XS_FD option
| -rw-r--r-- | doc/xs_getsockopt.txt | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/xs_getsockopt.txt b/doc/xs_getsockopt.txt index fe40662..681015c 100644 --- a/doc/xs_getsockopt.txt +++ b/doc/xs_getsockopt.txt @@ -237,7 +237,7 @@ Applicable socket types:: all, only for connection-oriented transports XS_RECONNECT_IVL_MAX: Retrieve maximum reconnection interval ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The 'XS_RECONNECT_IVL_MAX' option shall retrieve the maximum reconnection +The 'XS_RECONNECT_IVL_MAX' option shall retrieve the maximum reconnection interval for the specified 'socket'. This is the maximum period the library shall wait between attempts to reconnect. On each reconnect attempt, the previous interval shall be doubled untill XS_RECONNECT_IVL_MAX is reached. This @@ -354,6 +354,13 @@ necessarily indicate that messages are available to be read from, or can be written to, the underlying socket; applications must retrieve the actual event state with a subsequent retrieval of the 'XS_EVENTS' option. +NOTE: The returned file descriptor is also used internally by the 'zmq_send' +and 'zmq_recv' functions. As the descriptor is edge triggered, applications +must update the state of 'ZMQ_EVENTS' after each invocation of 'zmq_send' +or 'zmq_recv'.To be more explicit: after calling 'zmq_send' the socket may +become readable (and vice versa) without triggering a read event on the +file descriptor. + CAUTION: The returned file descriptor is intended for use with a 'poll' or similar system call only. Applications must never attempt to read or write data to it directly, neither should they try to close it. |