diff options
| author | Martin Lucina <mato@kotelna.sk> | 2010-03-09 18:47:31 +0100 |
|---|---|---|
| committer | Martin Lucina <mato@kotelna.sk> | 2010-03-09 18:47:31 +0100 |
| commit | 1aee86408d575d6572b071d7564da7f006d1757e (patch) | |
| tree | 98d54989b5961db8c458017034bfb8f981e98c8f /doc/zmq_msg_move.txt | |
| parent | d790940fd06060c8a2c624b0e41e470ad31ae0d8 (diff) | |
Documentation rewrite
Diffstat (limited to 'doc/zmq_msg_move.txt')
| -rw-r--r-- | doc/zmq_msg_move.txt | 38 |
1 files changed, 17 insertions, 21 deletions
diff --git a/doc/zmq_msg_move.txt b/doc/zmq_msg_move.txt index d8ce667..e8bde8a 100644 --- a/doc/zmq_msg_move.txt +++ b/doc/zmq_msg_move.txt @@ -4,25 +4,30 @@ zmq_msg_move(3) NAME ---- -zmq_msg_move - moves content of a message to another message +zmq_msg_move - move content of a message to another message SYNOPSIS -------- -int zmq_msg_move (zmq_msg_t *dest, zmq_msg_t *src); +*int zmq_msg_move (zmq_msg_t '*dest', zmq_msg_t '*src');* DESCRIPTION ----------- -Move the content of the message from 'src' to 'dest'. The content isn't -copied, just moved. 'src' becomes an empty message after the call. Original -content of 'dest' message is deallocated. +The _zmq_msg_move()_ function shall move the content of the message object +referenced by 'src' to the message object referenced by 'dest'. No actual +copying of message content is performed, 'dest' is simply updated to reference +the new content. 'src' becomes an empty message after calling _zmq_msg_move()_. +The original content of 'dest', if any, shall be released. + +CAUTION: Never access 'zmq_msg_t' members directly, instead always use the +_zmq_msg_ family of functions. RETURN VALUE ------------ -In case of success the function returns zero. Otherwise it returns -1 and -sets 'errno' to the appropriate value. +The _zmq_msg_move()_ function shall return zero if successful. Otherwise it +shall return -1 and set 'errno' to one of the values defined below. ERRORS @@ -30,17 +35,6 @@ ERRORS No errors are defined. -EXAMPLE -------- ----- -zmq_msg_t dest; -rc = zmq_msg_init (&dest); -assert (rc == 0); -rc = zmq_msg_move (&dest, &src); -assert (rc == 0); ----- - - SEE ALSO -------- linkzmq:zmq_msg_copy[3] @@ -48,8 +42,10 @@ linkzmq:zmq_msg_init[3] linkzmq:zmq_msg_init_size[3] linkzmq:zmq_msg_init_data[3] linkzmq:zmq_msg_close[3] +linkzmq:zmq[7] -AUTHOR ------- -Martin Sustrik <sustrik at 250bpm dot com> +AUTHORS +------- +The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and +Martin Lucina <mato@kotelna.sk>. |