libzmq/doc/zmq_msg_set_routing_id.adoc

39 lines
1011 B
Plaintext

= zmq_msg_set_routing_id(3)
== NAME
zmq_msg_set_routing_id - set routing ID property on message
== SYNOPSIS
*int zmq_msg_set_routing_id (zmq_msg_t '*message', uint32_t 'routing_id');*
== DESCRIPTION
The _zmq_msg_set_routing_id()_ function sets the 'routing_id' specified, on the
the message pointed to by the 'message' argument. The 'routing_id' must be
greater than zero. To get a valid routing ID, you must receive a message
from a 'ZMQ_SERVER' socket, and use the libzmq:zmq_msg_routing_id method.
Routing IDs are transient.
== RETURN VALUE
The _zmq_msg_set_routing_id()_ function shall return zero if successful. Otherwise it
shall return `-1` and set 'errno' to one of the values defined below.
== ERRORS
*EINVAL*::
The provided 'routing_id' is zero.
== SEE ALSO
* xref:zmq_msg_routing_id.adoc[zmq_msg_routing_id]
* xref:zmq.adoc[zmq]
== AUTHORS
This page was written by the 0MQ community. To make a change please
read the 0MQ Contribution Policy at <https://zeromq.org/how-to-contribute/>.