From 6d0cea54aa629fd94172daeda7d2aafcecd0cbdb Mon Sep 17 00:00:00 2001 From: Joe Eli McIlvain Date: Fri, 31 Jul 2015 22:37:36 -0700 Subject: [PATCH] Fix alphabetical order of non-deprecated setsockopt docs. --- doc/zmq_setsockopt.txt | 44 +++++++++++++++++++++--------------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/doc/zmq_setsockopt.txt b/doc/zmq_setsockopt.txt index 41da9a9b..13918956 100644 --- a/doc/zmq_setsockopt.txt +++ b/doc/zmq_setsockopt.txt @@ -329,6 +329,28 @@ Default value:: 0 (false) Applicable socket types:: all, only for connection-oriented transports. +ZMQ_INVERT_MATCHING: Invert message filtering +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Reverses the filtering behavior of PUB-SUB sockets, when set to 1. + +On 'PUB' and 'XPUB' sockets, this causes messages to be sent to all +connected sockets 'except' those subscribed to a prefix that matches +the message. On 'SUB' sockets, this causes only incoming messages that +do 'not' match any of the socket's subscriptions to be received by the user. + +Whenever 'ZMQ_INVERT_MATCHING' is set to 1 on a 'PUB' socket, all 'SUB' +sockets connecting to it must also have the option set to 1. Failure to +do so will have the 'SUB' sockets reject everything the 'PUB' socket sends +them. 'XSUB' sockets do not need to do this because they do not filter +incoming messages. + +[horizontal] +Option value type:: int +Option value unit:: 0,1 +Default value:: 0 +Applicable socket types:: ZMQ_PUB, ZMQ_XPUB, ZMQ_SUB + + ZMQ_IPV6: Enable IPv6 on socket ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Set the IPv6 option for the socket. A value of `1` means IPv6 is @@ -1020,28 +1042,6 @@ Default value:: 1 (true) Applicable socket types:: all, when using TCP transports. -ZMQ_INVERT_MATCHING: Invert message filtering -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Reverses the filtering behavior of PUB-SUB sockets, when set to 1. - -On 'PUB' and 'XPUB' sockets, this causes messages to be sent to all -connected sockets 'except' those subscribed to a prefix that matches -the message. On 'SUB' sockets, this causes only incoming messages that -do 'not' match any of the socket's subscriptions to be received by the user. - -Whenever 'ZMQ_INVERT_MATCHING' is set to 1 on a 'PUB' socket, all 'SUB' -sockets connecting to it must also have the option set to 1. Failure to -do so will have the 'SUB' sockets reject everything the 'PUB' socket sends -them. 'XSUB' sockets do not need to do this because they do not filter -incoming messages. - -[horizontal] -Option value type:: int -Option value unit:: 0,1 -Default value:: 0 -Applicable socket types:: ZMQ_PUB, ZMQ_XPUB, ZMQ_SUB - - RETURN VALUE ------------ The _zmq_setsockopt()_ function shall return zero if successful. Otherwise it