diff options
| author | Martin Lucina <mato@kotelna.sk> | 2010-06-02 18:36:34 +0200 |
|---|---|---|
| committer | Martin Lucina <mato@kotelna.sk> | 2010-06-02 18:36:34 +0200 |
| commit | 7c9b09bc511236c8cc5f6cea7623a8b98fedf302 (patch) | |
| tree | 1a2f6be6ef87fb4a21c4ace9b36df0f3c06d0e6c /doc/zmq_recv.txt | |
| parent | 9d00d300b0d6b45d2954792540cc95a0c3fb6a01 (diff) | |
Documentation: Flow control, zmq_socket(3)
Mostly Flow control and additions to zmq_socket(3)
Removed/changed lots of text regarding message queues
More fixes for 2.0.7 changes
Diffstat (limited to 'doc/zmq_recv.txt')
| -rw-r--r-- | doc/zmq_recv.txt | 22 |
1 files changed, 10 insertions, 12 deletions
diff --git a/doc/zmq_recv.txt b/doc/zmq_recv.txt index 42df99a..79d3dc1 100644 --- a/doc/zmq_recv.txt +++ b/doc/zmq_recv.txt @@ -14,19 +14,17 @@ SYNOPSIS 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: +The _zmq_recv()_ function shall receive a message from 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 on the specified '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. +are no messages available on the specified 'socket', the _zmq_recv()_ function +shall fail with 'errno' set to EAGAIN. Multi-part messages @@ -75,7 +73,7 @@ EXAMPLE zmq_msg_t msg; int rc = zmq_msg_init (&msg); assert (rc == 0); -/* Block until a message is available to be dequeued from socket */ +/* Block until a message is available to be received from socket */ rc = zmq_recv (socket, &msg, 0); assert (rc == 0); ---- @@ -89,7 +87,7 @@ do { zmq_msg_t part; int rc = zmq_msg_init (&part); assert (rc == 0); - /* Block until a message is available to be dequeued from socket */ + /* Block until a message is available to be received from socket */ rc = zmq_recv (socket, &part, 0); assert (rc == 0); /* Determine if more message parts are to follow */ |