summaryrefslogtreecommitdiff
path: root/man/man3/zmq_msg_copy.3
diff options
context:
space:
mode:
Diffstat (limited to 'man/man3/zmq_msg_copy.3')
-rw-r--r--man/man3/zmq_msg_copy.331
1 files changed, 31 insertions, 0 deletions
diff --git a/man/man3/zmq_msg_copy.3 b/man/man3/zmq_msg_copy.3
index 239203b..2f70400 100644
--- a/man/man3/zmq_msg_copy.3
+++ b/man/man3/zmq_msg_copy.3
@@ -4,9 +4,40 @@ zmq_msg_copy \- copies content of a message to another message
.SH SYNOPSIS
.B int zmq_msg_copy (zmq_msg_t *dest, zmq_msg_t *src);
.SH DESCRIPTION
+Copy the
+.IR src
+message to
+.IR dest .
+The original content of
+.IR 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
+.IR zmq_msg_size
+and copy the data using
+.IR memcpy .
.SH RETURN VALUE
+In case of success the function returns zero. Otherwise it returns -1 and
+sets
+.IR errno
+to the appropriate value.
.SH ERRORS
+No errors are defined.
.SH EXAMPLE
+.nf
+zmq_msg_t dest;
+rc = zmq_msg_init (&dest);
+assert (rc == 0);
+rc = zmq_msg_copy (&dest, &src);
+assert (rc == 0);
+.fi
.SH SEE ALSO
+.BR zmq_msg_move (3)
+.BR zmq_msg_init (3)
+.BR zmq_msg_init_size (3)
+.BR zmq_msg_init_data (3)
+.BR zmq_msg_close (3)
.SH AUTHOR
Martin Sustrik <sustrik at 250bpm dot com>