libzmq/doc/zmq_msg_more.adoc

58 lines
1.4 KiB
Plaintext
Raw Normal View History

= zmq_msg_more(3)
== NAME
zmq_msg_more - indicate if there are more message parts to receive
== SYNOPSIS
*int zmq_msg_more (zmq_msg_t '*message');*
== DESCRIPTION
The _zmq_msg_more()_ function indicates whether this is part of a multi-part
message, and there are further parts to receive. This method can safely be
2012-12-23 17:59:34 +01:00
called after _zmq_msg_close()_. This method is identical to _zmq_msg_get()_
with an argument of ZMQ_MORE.
== RETURN VALUE
The _zmq_msg_more()_ function shall return zero if this is the final part of
a multi-part message, or the only part of a single-part message. It shall
return 1 if there are further parts to receive.
== EXAMPLE
.Receiving a multi-part message
----
zmq_msg_t part;
while (true) {
// Create an empty 0MQ message to hold the message part
int rc = zmq_msg_init (&part);
assert (rc == 0);
// Block until a message is available to be received from socket
2012-12-23 17:47:32 +01:00
rc = zmq_msg_recv (socket, &part, 0);
assert (rc != -1);
if (zmq_msg_more (&part))
fprintf (stderr, "more\n");
else {
fprintf (stderr, "end\n");
break;
}
zmq_msg_close (&part);
}
----
== SEE ALSO
xref:zmq_msg_get.adoc[zmq_msg_get]
xref:zmq_msg_set.adoc[zmq_msg_set]
xref:zmq_msg_init.adoc[zmq_msg_init]
xref:zmq_msg_close.adoc[zmq_msg_close]
xref:zmq.adoc[zmq]
== AUTHORS
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>.