Commit 843e627b authored by Luca Boccassi's avatar Luca Boccassi Committed by GitHub

Merge pull request #2753 from zeromq/zap-domain-docs

Problem: documentation of ZMQ_ZAP_DOMAIN is wrong
parents e2f2193b 7297df62
......@@ -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
......
......@@ -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
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment