zmq_msg_set_routing_id.txt 1.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. zmq_msg_set_routing_id(3)
  2. =========================
  3. NAME
  4. ----
  5. zmq_msg_set_routing_id - set routing ID property on message
  6. SYNOPSIS
  7. --------
  8. *int zmq_msg_set_routing_id (zmq_msg_t '*message', uint32_t 'routing_id');*
  9. DESCRIPTION
  10. -----------
  11. The _zmq_msg_set_routing_id()_ function sets the 'routing_id' specified, on the
  12. the message pointed to by the 'message' argument. The 'routing_id' must be
  13. greater than zero. To get a valid routing ID, you must receive a message
  14. from a 'ZMQ_SERVER' socket, and use the libzmq:zmq_msg_routing_id method.
  15. Routing IDs are transient.
  16. RETURN VALUE
  17. ------------
  18. The _zmq_msg_set_routing_id()_ function shall return zero if successful. Otherwise it
  19. shall return `-1` and set 'errno' to one of the values defined below.
  20. ERRORS
  21. ------
  22. *EINVAL*::
  23. The provided 'routing_id' is zero.
  24. SEE ALSO
  25. --------
  26. linkzmq:zmq_msg_routing_id[3]
  27. linkzmq:zmq[7]
  28. AUTHORS
  29. -------
  30. This page was written by the 0MQ community. To make a change please
  31. read the 0MQ Contribution Policy at <http://www.zeromq.org/docs:contributing>.