diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/zmq_getsockopt.txt | 19 | ||||
| -rw-r--r-- | doc/zmq_setsockopt.txt | 19 |
2 files changed, 37 insertions, 1 deletions
diff --git a/doc/zmq_getsockopt.txt b/doc/zmq_getsockopt.txt index 97b4032..b48b06b 100644 --- a/doc/zmq_getsockopt.txt +++ b/doc/zmq_getsockopt.txt @@ -297,7 +297,7 @@ 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 option shall 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] @@ -307,6 +307,23 @@ Default value:: 1 Applicable socket types:: all, when using multicast transports +ZMQ_FILTER: Switches message filtering on or off +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The option shall retrieve the filtering behaiour of the socket. +If 1, messages are filtered according to subcriptions as expected. +If 0, messages are not filtered. This is a performance tweak. If a device +receives a message from XSUB socket and it is about to send it to XPUB socket +immediately, filtering would be done twice. We can thus turn off filtering in +XSUB socket and rely on filtering in XPUB socket. + +[horizontal] +Option value type:: int +Option value unit:: boolean +Default value:: 1 +Applicable socket types:: ZMQ_SUB, ZMQ_XSUB + + 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 ed3b3a7..4b639c5 100644 --- a/doc/zmq_setsockopt.txt +++ b/doc/zmq_setsockopt.txt @@ -284,6 +284,7 @@ Option value unit:: connections Default value:: 100 Applicable socket types:: all, only for connection-oriented transports. + ZMQ_MAXMSGSIZE: Maximum acceptable inbound message size ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -296,6 +297,7 @@ Option value unit:: bytes Default value:: -1 Applicable socket types:: all + ZMQ_MULTICAST_HOPS: Maximum network hops for multicast packets ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -309,6 +311,23 @@ Option value unit:: network hops Default value:: 1 Applicable socket types:: all, when using multicast transports + +ZMQ_FILTER: Switches message filtering on or off +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +If set to 1, messages are filtered according to subcriptions as expected. +If set to 0, messages are not filtered. This is a performance tweak. If a device +receives a message from XSUB socket and it is about to send it to XPUB socket +immediately, filtering would be done twice. We can thus turn off filtering in +XSUB socket and rely on filtering in XPUB socket. + +[horizontal] +Option value type:: int +Option value unit:: boolean +Default value:: 1 +Applicable socket types:: ZMQ_SUB, ZMQ_XSUB + + RETURN VALUE ------------ The _zmq_setsockopt()_ function shall return zero if successful. Otherwise it |