diff options
| author | Martin Sustrik <sustrik@250bpm.com> | 2011-05-15 18:25:43 +0200 |
|---|---|---|
| committer | Martin Sustrik <sustrik@250bpm.com> | 2011-05-15 18:25:43 +0200 |
| commit | 5d0cffc52f575ff572751cc85fd43063391a211d (patch) | |
| tree | 2f61c1e0f6060fc756feefef11fcafa1c168d16f /doc | |
| parent | 49df2f416cd43e9e18f3dbd964271c5cca835729 (diff) | |
ZMQ_MULTICAST_HOPS socket option added
Sets the time-to-live field in every multicast packet sent from the socket.
Signed-off-by: Martin Sustrik <sustrik@250bpm.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/zmq_getsockopt.txt | 15 | ||||
| -rw-r--r-- | doc/zmq_setsockopt.txt | 12 |
2 files changed, 26 insertions, 1 deletions
diff --git a/doc/zmq_getsockopt.txt b/doc/zmq_getsockopt.txt index 9d67ce2..97b4032 100644 --- a/doc/zmq_getsockopt.txt +++ b/doc/zmq_getsockopt.txt @@ -283,7 +283,7 @@ Applicable socket types:: all, only for connection-oriented transports ZMQ_MAXMSGSIZE: Maximum acceptable inbound message size ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The options shall retrieve limit for the inbound messages. If a peer sends +The option shall retrieve limit for the inbound messages. If a peer sends a message larger than ZMQ_MAXMSGSIZE it is disconnected. Value of -1 means 'no limit'. @@ -294,6 +294,19 @@ Default value:: -1 Applicable socket types:: all +ZMQ_MULTICAST_HOPS: Maximum network hops for multicast packets +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The option shell retrieve time-to-live used for outbound multicast packets. +The default of 1 means that the multicast packets don't leave the local network. + +[horizontal] +Option value type:: int +Option value unit:: network hops +Default value:: 1 +Applicable socket types:: all, when using multicast transports + + ZMQ_FD: Retrieve file descriptor associated with the socket ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The 'ZMQ_FD' option shall retrieve the file descriptor associated with the diff --git a/doc/zmq_setsockopt.txt b/doc/zmq_setsockopt.txt index f5c873e..ed3b3a7 100644 --- a/doc/zmq_setsockopt.txt +++ b/doc/zmq_setsockopt.txt @@ -296,6 +296,18 @@ Option value unit:: bytes Default value:: -1 Applicable socket types:: all +ZMQ_MULTICAST_HOPS: Maximum network hops for multicast packets +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Sets the time-to-live field in every multicast packet sent from this socket. +The default is 1 which means that the multicast packets don't leave the local +network. + +[horizontal] +Option value type:: int +Option value unit:: network hops +Default value:: 1 +Applicable socket types:: all, when using multicast transports RETURN VALUE ------------ |