generic-library/libzmq
1
0
Fork 0
mirror of https://github.com/zeromq/libzmq.git synced 2024-12-13 10:52:56 +01:00
Code Issues Projects Releases Wiki Activity

Problem: Documentation missing for ZMQ_METADATA socket option

Browse Source
This commit is contained in:
Pontus Sköldström 2018-03-15 17:24:32 +01:00
parent e388774737
commit 57422c7df1
2 changed files with 26 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/zmq_msg_gets.txt
View File

@ -20,10 +20,12 @@ the 'message' argument. Both the 'property' argument and the 'value'
shall be NULL-terminated UTF8-encoded strings. shall be NULL-terminated UTF8-encoded strings.
Metadata is defined on a per-connection basis during the ZeroMQ connection Metadata is defined on a per-connection basis during the ZeroMQ connection
handshake as specified in <rfc.zeromq.org/spec:37>. handshake as specified in <rfc.zeromq.org/spec:37>. Applications can set
metadata properties using linkzmq:zmq_setsockopt[3] option ZMQ_METADATA.
Application metadata properties must be prefixed with 'X-'.
The following ZMTP properties can be retrieved with the _zmq_msg_gets()_ In addition to application metadata, the following ZMTP properties can be
function: retrieved with the _zmq_msg_gets()_ function:
Socket-Type Socket-Type
Routing-Id Routing-Id
@ -73,7 +75,7 @@ zmq_msg_close (&msg);
SEE ALSO SEE ALSO
-------- --------
linkzmq:zmq[7] linkzmq:zmq[7]
linkzmq:zmq_setsockopt[3]
AUTHORS AUTHORS
------- -------

20
doc/zmq_setsockopt.txt
View File

@ -469,6 +469,26 @@ Default value:: -1
Applicable socket types:: all Applicable socket types:: all
ZMQ_METADATA: Add application metadata properties to a socket
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The _ZMQ_METADATA_ option shall add application metadata to the specified _socket_,
the metadata is exchanged with peers during connection setup. A metadata property is
specfied as a string, delimited by a colon, starting with the metadata _property_
followed by the metadata value, for example "X-key:value".
_Property_ names are restrited to maximum 255 characters and must be prefixed by "X-".
Multiple application metadata properties can be added to a socket by executing zmq_setsockopt()
multiple times. As the argument is a null-terminated string, binary data must be encoded
before it is added e.g. using Z85 (linkzmq:zmq_z85_encode[3]).
NOTE: in DRAFT state, not yet available in stable releases.
[horizontal]
Option value type:: character string
Option value unit:: N/A
Default value:: not set
Applicable socket types:: all
ZMQ_MULTICAST_HOPS: Maximum network hops for multicast packets ZMQ_MULTICAST_HOPS: Maximum network hops for multicast packets
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Sets the time-to-live field in every multicast packet sent from this socket. Sets the time-to-live field in every multicast packet sent from this socket.