GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
ZMQ_MSG_GETS(3) 0MQ Manual ZMQ_MSG_GETS(3)

zmq_msg_gets - get message metadata property

const char *zmq_msg_gets (zmq_msg_t *message, const char * property);

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. Both the property argument and the value shall be NULL-terminated UTF8-encoded strings.
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
Routing-Id
Note: Identity is a deprecated alias for Routing-Id.
Additionally, when available for the underlying transport, the Peer-Address property will return the IP address of the remote endpoint as returned by getnameinfo(2).
The names of these properties are also defined in zmq.h as ZMQ_MSG_PROPERTY_SOCKET_TYPE ZMQ_MSG_PROPERTY_ROUTING_ID, and ZMQ_MSG_PROPERTY_PEER_ADDRESS. Currently, these definitions are only available as a DRAFT API.
Other properties may be defined based on the underlying security mechanism, see ZAP authenticated connection sample below.

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. The encoding of the property and value shall be UTF8.

EINVAL
The requested property is unknown.

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);
const char *user_id = zmq_msg_gets (&msg, ZMQ_MSG_PROPERTY_USER_ID);
zmq_msg_close (&msg);

zmq(7)

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.
12/13/2017 0MQ 4.2.3

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.