libzmq/doc/zmq_msg_init.adoc

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

57 lines
1.4 KiB
Plaintext
Raw Permalink Normal View History

= zmq_msg_init(3)
2010-02-10 16:18:46 +01:00
== NAME
2010-03-09 18:47:31 +01:00
zmq_msg_init - initialise empty 0MQ message
2010-02-10 16:18:46 +01:00
== SYNOPSIS
2010-03-09 18:47:31 +01:00
*int zmq_msg_init (zmq_msg_t '*msg');*
2010-02-10 16:18:46 +01:00
== DESCRIPTION
2010-03-09 18:47:31 +01:00
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_msg_recv()_.
2010-03-09 18:47:31 +01:00
CAUTION: Never access 'zmq_msg_t' members directly, instead always use the
_zmq_msg_ family of functions.
2010-02-10 16:18:46 +01:00
CAUTION: The functions _zmq_msg_init()_, _zmq_msg_init_data()_,
_zmq_msg_init_size()_ and _zmq_msg_init_buffer()_ are mutually exclusive.
Never initialise the same 'zmq_msg_t' twice.
2010-02-10 16:18:46 +01:00
== RETURN VALUE
The _zmq_msg_init()_ function always returns zero.
2010-02-10 16:18:46 +01:00
== ERRORS
2010-02-10 16:18:46 +01:00
No errors are defined.
== EXAMPLE
2010-03-09 18:47:31 +01:00
.Receiving a message from a socket
2010-02-10 16:18:46 +01:00
----
zmq_msg_t msg;
rc = zmq_msg_init (&msg);
assert (rc == 0);
int nbytes = zmq_msg_recv (socket, &msg, 0);
assert (nbytes != -1);
2010-02-10 16:18:46 +01:00
----
== SEE ALSO
* xref:zmq_msg_init_size.adoc[zmq_msg_init_size]
* xref:zmq_msg_init_buffer.adoc[zmq_msg_init_buffer]
* xref:zmq_msg_init_data.adoc[zmq_msg_init_data]
* xref:zmq_msg_close.adoc[zmq_msg_close]
* xref:zmq_msg_data.adoc[zmq_msg_data]
* xref:zmq_msg_size.adoc[zmq_msg_size]
* xref:zmq.adoc[zmq]
2010-02-10 16:18:46 +01:00
== 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/>.