7
zmq_recvmsg - receive a message part from a socket
12
*int zmq_recvmsg (void '*socket', zmq_msg_t '*msg', int 'flags');*
17
The _zmq_recvmsg()_ function shall receive a message part from the socket
18
referenced by the 'socket' argument and store it in the message referenced by
19
the 'msg' argument. Any content previously stored in 'msg' shall be properly
20
deallocated. If there are no message parts available on the specified 'socket'
21
the _zmq_recvmsg()_ function shall block until the request can be satisfied.
22
The 'flags' argument is a combination of the flags defined below:
25
Specifies that the operation should be performed in non-blocking mode. If there
26
are no messages available on the specified 'socket', the _zmq_recvmsg()_
27
function shall fail with 'errno' set to EAGAIN.
32
A 0MQ message is composed of 1 or more message parts. Each message
33
part is an independent 'zmq_msg_t' in its own right. 0MQ ensures atomic
34
delivery of messages; peers shall receive either all _message parts_ of a
35
message or none at all. The total number of message parts is unlimited except
38
An application that processes multipart messages must use the _ZMQ_RCVMORE_
39
linkzmq:zmq_getsockopt[3] option after calling _zmq_recvmsg()_ to determine if
40
there are further parts to receive.
45
The _zmq_recvmsg()_ function shall return number of bytes in the message
46
if successful. Otherwise it shall return `-1` and set 'errno' to one of the
53
Non-blocking mode was requested and no messages are available at the moment.
55
The _zmq_recvmsg()_ operation is not supported by this socket type.
57
The _zmq_recvmsg()_ operation cannot be performed on this socket at the moment
58
due to the socket not being in the appropriate state. This error may occur with
59
socket types that switch between several states, such as ZMQ_REP. See the
60
_messaging patterns_ section of linkzmq:zmq_socket[3] for more information.
62
The 0MQ 'context' associated with the specified 'socket' was terminated.
64
The provided 'socket' was invalid.
66
The operation was interrupted by delivery of a signal before a message was
69
The message passed to the function was invalid.
74
.Receiving a message from a socket
76
/* Create an empty 0MQ message */
78
int rc = zmq_msg_init (&msg);
80
/* Block until a message is available to be received from socket */
81
rc = zmq_recvmsg (socket, &msg, 0);
87
.Receiving a multi-part message
90
size_t more_size = sizeof more;
92
/* Create an empty 0MQ message to hold the message part */
94
int rc = zmq_msg_init (&part);
96
/* Block until a message is available to be received from socket */
97
rc = zmq_recvmsg (socket, &part, 0);
99
/* Determine if more message parts are to follow */
100
rc = zmq_getsockopt (socket, ZMQ_RCVMORE, &more, &more_size);
102
zmq_msg_close (&part);
111
linkzmq:zmq_sendmsg[3]
112
linkzmq:zmq_getsockopt[3]
113
linkzmq:zmq_socket[7]
119
This man page was written by Martin Sustrik <sustrik@250bpm.com>, Martin
120
Lucina <martin@lucina.net> and Pieter Hintjens <ph@imatix.com>.
added
removed
doc/zmq_recvmsg.txt
