zmq_msg_gets.txt 1.25 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11
zmq_msg_gets(3)
===============


NAME
----
zmq_msg_gets - get message metadata property


SYNOPSIS
--------
12
*const char *zmq_msg_gets (zmq_msg_t '*message', const char *'property');*
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39


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
-------
Pieter Hintjens's avatar
Pieter Hintjens committed
40
.Getting the ZAP authenticated user id for a message:
41
----
Pieter Hintjens's avatar
Pieter Hintjens committed
42 43 44 45
zmq_msg_t msg;
zmq_msg_init (&msg);
rc = zmq_msg_recv (&msg, dealer, 0);
assert (rc != -1);
Pieter Hintjens's avatar
Pieter Hintjens committed
46
const char *user_id = zmq_msg_gets (&msg, "User-Id");
Pieter Hintjens's avatar
Pieter Hintjens committed
47
zmq_msg_close (&msg);
48 49 50 51 52 53 54 55 56 57 58 59
----


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>.