zmq_recv

Langue: en

Autres versions - même langue

Version: 03/16/2010 (ubuntu - 24/10/10)

Section: 3 (Bibliothèques de fonctions)

NAME

zmq_recv - receive a message from a socket

SYNOPSIS

int zmq_recv (void *socket, zmq_msg_t *msg, int flags);

DESCRIPTION

The zmq_recv() function shall dequeue a message from the underlying message queue associated with the socket referenced by the socket argument and store it in the message referenced by the msg argument. Any content previously stored in msg shall be properly deallocated. If there are no messages available to be dequeued from the underlying message queue associated with socket the zmq_recv() function shall block until the request can be satisfied. The flags argument is a combination of the flags defined below:

ZMQ_NOBLOCK

Specifies that the operation should be performed in non-blocking mode. If there are no messages available to be dequeued from the underlying message queue associated with socket, the zmq_recv() function shall fail with errno set to EAGAIN.

RETURN VALUE

The zmq_recv() function shall return zero if successful. Otherwise it shall return -1 and set errno to one of the values defined below.

ERRORS

EAGAIN

Non-blocking mode was requested and no messages are available at the moment.

ENOTSUP

The zmq_recv() operation is not supported by this socket type.

EFSM

The zmq_recv() operation cannot be performed on this socket at the moment due to the socket not being in the appropriate state. This error may occur with socket types that switch between several states, such as ZMQ_REP. See the messaging patterns section of zmq_socket(3) for more information.

EXAMPLE

Example 1. Receiving a message from a socket

 /* Create an empty 0MQ message */
 zmq_msg_t msg;
 int rc = zmq_msg_init (&msg);
 assert (rc == 0);
 /* Block until a message is available to be dequeued from socket */
 rc = zmq_recv (socket, &msg, 0);
 assert (rc == 0);
 

SEE ALSO

zmq_send(3) zmq_socket(7) zmq(7)

AUTHORS

The 0MQ documentation was written by Martin Sustrik <m[blue]sustrik@250bpm.comm[][1]> and Martin Lucina <m[blue]mato@kotelna.skm[][2]>.

NOTES

1.
sustrik@250bpm.com
mailto:sustrik@250bpm.com
2.
mato@kotelna.sk
mailto:mato@kotelna.sk