generic-library/libzmq
1
0
Fork 0
mirror of https://github.com/zeromq/libzmq.git synced 2025-03-04 07:27:26 +01:00
Code Issues Projects Releases Wiki Activity

Problem: documentation of ZMQ_ZAP_DOMAIN is wrong

Browse Source 
Solution: fix documentation
This commit is contained in:
sigiesec 2017-09-19 09:13:57 +02:00
parent e2f2193bec
commit 7297df6278
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/zmq_getsockopt.txt
View File

@ -822,7 +822,8 @@ ZMQ_ZAP_DOMAIN: Retrieve RFC 27 authentication domain
The 'ZMQ_ZAP_DOMAIN' option shall retrieve the last ZAP domain set for
the socket. The returned value shall be a NULL-terminated string and MAY
be empty. The returned size SHALL include the terminating null byte.
be empty. An empty string means that ZAP authentication is disabled.
The returned size SHALL include the terminating null byte.
[horizontal]
Option value type:: character string

11
doc/zmq_setsockopt.txt
View File

@ -1064,16 +1064,15 @@ Applicable socket types:: ZMQ_XPUB
ZMQ_ZAP_DOMAIN: Set RFC 27 authentication domain
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Sets the domain for ZAP (ZMQ RFC 27) authentication. For NULL security (the
default on all tcp:// connections), ZAP authentication only happens if you
set a non-empty domain. For PLAIN and CURVE security, ZAP requests are always
made, if there is a ZAP handler present. See http://rfc.zeromq.org/spec:27
for more details.
Sets the domain for ZAP (ZMQ RFC 27) authentication. A ZAP domain must be
specified to enable authentication. When the ZAP domain is empty, which is
the default, ZAP authentication is disabled.
See http://rfc.zeromq.org/spec:27 for more details.
[horizontal]
Option value type:: character string
Option value unit:: N/A
Default value:: not set
Default value:: empty
Applicable socket types:: all, when using TCP transport