diff options
author | Martin Hurton <hurtonm@gmail.com> | 2010-02-10 17:14:21 +0100 |
---|---|---|
committer | Martin Hurton <hurtonm@gmail.com> | 2010-02-10 17:14:21 +0100 |
commit | 7cab423fc20e46f54fa561e51b566cc8a63ca5c1 (patch) | |
tree | fa926432b8392e7717b7fbc1ecaf973ba60cb970 /doc/zmq_msg_copy.txt | |
parent | bc9b7f1f54b9dcf754021f1f7eb766d71cc97f29 (diff) | |
parent | 354efc513fdb4096f8830e6c2e3e8f1311303e61 (diff) |
Merge branch 'master' of github.com:sustrik/zeromq2
Diffstat (limited to 'doc/zmq_msg_copy.txt')
-rw-r--r-- | doc/zmq_msg_copy.txt | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/doc/zmq_msg_copy.txt b/doc/zmq_msg_copy.txt new file mode 100644 index 0000000..b31897a --- /dev/null +++ b/doc/zmq_msg_copy.txt @@ -0,0 +1,60 @@ +zmq_msg_copy(3) +=============== + + +NAME +---- +zmq_msg_copy - copies content of a message to another message + + +SYNOPSIS +-------- +'int zmq_msg_copy (zmq_msg_t *dest, zmq_msg_t *src);' + + +DESCRIPTION +----------- +Copy the 'src' message to 'dest'. The original content of +'dest' is orderly deallocated. + +CAUTION: The implementation may choose not to physically copy the data, rather +to share the buffer between two messages. Thus avoid modifying message data +after the message was copied. Doing so can modify multiple message instances. +If what you need is actual hard copy, allocate new message using +'zmq_msg_size' and copy the data using 'memcpy'. + + +RETURN VALUE +------------ +In case of success the function returns zero. Otherwise it returns -1 and +sets 'errno' to the appropriate value. + + +ERRORS +------ +No errors are defined. + + +EXAMPLE +------- +---- +zmq_msg_t dest; +rc = zmq_msg_init (&dest); +assert (rc == 0); +rc = zmq_msg_copy (&dest, &src); +assert (rc == 0); +---- + + +SEE ALSO +-------- +linkzmq:zmq_msg_move[3] +linkzmq:zmq_msg_init[3] +linkzmq:zmq_msg_init_size[3] +linkzmq:zmq_msg_init_data[3] +linkzmq:zmq_msg_close[3] + + +AUTHOR +------ +Martin Sustrik <sustrik at 250bpm dot com> |