diff options
| author | Jinkun Jang <jinkun.jang@samsung.com> | 2013-03-13 01:45:41 +0900 |
|---|---|---|
| committer | Jinkun Jang <jinkun.jang@samsung.com> | 2013-03-13 01:45:41 +0900 |
| commit | 67c02c905ff2e2abbb1659d8a04c4ae31b9a1741 (patch) | |
| tree | 44f6c4cce4e317e5e82ca7091f359bb70cf2f6be /doc/zmq_msg_more.3 | |
| parent | 7d28425f8b4adc73acf9c16dd3e7f9ba7a793a9a (diff) | |
| download | zeromq-accepted/tizen_2.1/20130425.040527.tar.gz zeromq-accepted/tizen_2.1/20130425.040527.tar.bz2 zeromq-accepted/tizen_2.1/20130425.040527.zip | |
Diffstat (limited to 'doc/zmq_msg_more.3')
| -rw-r--r-- | doc/zmq_msg_more.3 | 86 |
1 files changed, 86 insertions, 0 deletions
diff --git a/doc/zmq_msg_more.3 b/doc/zmq_msg_more.3 new file mode 100644 index 0000000..d084afc --- /dev/null +++ b/doc/zmq_msg_more.3 @@ -0,0 +1,86 @@ +'\" t +.\" Title: zmq_msg_more +.\" Author: [see the "AUTHORS" section] +.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/> +.\" Date: 11/23/2012 +.\" Manual: 0MQ Manual +.\" Source: 0MQ 3.2.1 +.\" Language: English +.\" +.TH "ZMQ_MSG_MORE" "3" "11/23/2012" "0MQ 3\&.2\&.1" "0MQ Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +zmq_msg_more \- indicate if there are more message parts to receive +.SH "SYNOPSIS" +.sp +\fBint zmq_msg_more (zmq_msg_t \fR\fB\fI*message\fR\fR\fB);\fR +.SH "DESCRIPTION" +.sp +The \fIzmq_msg_more()\fR function indicates whether this is part of a multi\-part message, and there are further parts to receive\&. +.SH "RETURN VALUE" +.sp +The \fIzmq_msg_more()\fR 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\&. +.SH "EXAMPLE" +.PP +\fBReceiving a multi-part message\fR. +.sp +.if n \{\ +.RS 4 +.\} +.nf +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 + rc = zmq_recvmsg (socket, &part, 0); + assert (rc != \-1); + if (zmq_msg_more (&part)) + fprintf (stderr, "more\en"); + else { + fprintf (stderr, "end\en"); + break; + } + zmq_msg_close (part); +} +.fi +.if n \{\ +.RE +.\} +.sp +.SH "SEE ALSO" +.sp +\fBzmq_msg_get\fR(3) \fBzmq_msg_set\fR(3) \fBzmq_msg_init\fR(3) \fBzmq_msg_close\fR(3) \fBzmq\fR(7) +.SH "AUTHORS" +.sp +This 0MQ manual page was written by Chuck Remes <\m[blue]\fBcremes@mac\&.com\fR\m[]\&\s-2\u[1]\d\s+2> and Pieter Hintjens <\m[blue]\fBph@imatix\&.com\fR\m[]\&\s-2\u[2]\d\s+2>\&. +.SH "NOTES" +.IP " 1." 4 +cremes@mac.com +.RS 4 +\%mailto:cremes@mac.com +.RE +.IP " 2." 4 +ph@imatix.com +.RS 4 +\%mailto:ph@imatix.com +.RE |