Try to clarify the intent of zmq_msg_gets() in documentation

This commit is contained in:
Thomas Rodgers 2015-01-16 10:50:04 -06:00
parent 413f835bc8
commit 39285cb969

View File

@ -19,8 +19,18 @@ property specified by the 'property' argument for the message pointed to by
the 'message' argument. Both the 'property' argument and the 'value' the 'message' argument. Both the 'property' argument and the 'value'
shall be NULL-terminated UTF8-encoded strings. shall be NULL-terminated UTF8-encoded strings.
The following properties can be retrieved with the _zmq_msg_gets()_ function: Metadata is defined on a per-connection basis during the ZeroMQ connection
handshake as specified in <rfc.zeromq.org/spec:37>.
The following ZMTP properties can be retrieved with the _zmq_msg_gets()_
function:
Socket-Type
Identity
Resource
Other properties may be defined based on the underlying security, see ZAP
auththenticated connection sample below.
RETURN VALUE RETURN VALUE
------------ ------------