mirror of
https://github.com/zeromq/libzmq.git
synced 2024-12-14 11:06:59 +01:00
60 lines
1.2 KiB
Plaintext
60 lines
1.2 KiB
Plaintext
zmq_msg_gets(3)
|
|
===============
|
|
|
|
|
|
NAME
|
|
----
|
|
zmq_msg_gets - get message metadata property
|
|
|
|
|
|
SYNOPSIS
|
|
--------
|
|
*const char *zmq_msg_gets (zmq_msg_t '*message', const char *'property');*
|
|
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
The _zmq_msg_gets()_ function shall return the string value for the metadata
|
|
property specified by the 'property' argument for the message pointed to by
|
|
the 'message' argument.
|
|
|
|
The following properties can be retrieved with the _zmq_msg_get()_ function:
|
|
|
|
|
|
RETURN VALUE
|
|
------------
|
|
The _zmq_msg_gets()_ function shall return the string value for the property
|
|
if successful. Otherwise it shall return NULL and set 'errno' to one of the
|
|
values defined below. The caller shall not modify or free the returned value,
|
|
which shall be owned by the message.
|
|
|
|
|
|
ERRORS
|
|
------
|
|
*EINVAL*::
|
|
The requested _property_ is unknown.
|
|
|
|
|
|
EXAMPLE
|
|
-------
|
|
.Getting the ZAP authenticated user id for a message:
|
|
----
|
|
zmq_msg_t msg;
|
|
zmq_msg_init (&msg);
|
|
rc = zmq_msg_recv (&msg, dealer, 0);
|
|
assert (rc != -1);
|
|
char *user_id = zmq_msg_gets (&msg, "User-Id");
|
|
zmq_msg_close (&msg);
|
|
----
|
|
|
|
|
|
SEE ALSO
|
|
--------
|
|
linkzmq:zmq[7]
|
|
|
|
|
|
AUTHORS
|
|
-------
|
|
This page was written by the 0MQ community. To make a change please
|
|
read the 0MQ Contribution Policy at <http://www.zeromq.org/docs:contributing>.
|