zmq_msg_init(3)

zmq_msg_init(3)

ØMQ Manual - ØMQ/4.2.2

Name

zmq_msg_init - initialise empty ØMQ message

Synopsis

int zmq_msg_init (zmq_msg_t *msg);

Description

The zmq_msg_init() function shall initialise the message object referenced by msg to represent an empty message. This function is most useful when called before receiving a message with zmq_recv().

Never access zmq_msg_t members directly, instead always use the zmq_msg family of functions.

The functions zmq_msg_init(), zmq_msg_init_data() and zmq_msg_init_size() are mutually exclusive. Never initialise the same zmq_msg_t twice.

Return value

The zmq_msg_init() function always returns zero.

Errors

No errors are defined.

Example

Receiving a message from a socket

zmq_msg_t msg;
rc = zmq_msg_init (&msg);
assert (rc == 0);
int nbytes = zmq_recv (socket, &msg, 0); assert (nbytes != -1);

See also

zmq_msg_init_size(3) zmq_msg_init_data(3) zmq_msg_close(3) zmq_msg_data(3) zmq_msg_size(3) zmq(7)

Authors

This page was written by the ØMQ community. To make a change please read the ØMQ Contribution Policy at http://www.zeromq.org/docs:contributing.