summaryrefslogtreecommitdiff
path: root/man/man3/zmq_msg_init_size.3
diff options
context:
space:
mode:
authorMartin Hurton <hurtonm@gmail.com>2010-02-10 17:14:21 +0100
committerMartin Hurton <hurtonm@gmail.com>2010-02-10 17:14:21 +0100
commit7cab423fc20e46f54fa561e51b566cc8a63ca5c1 (patch)
treefa926432b8392e7717b7fbc1ecaf973ba60cb970 /man/man3/zmq_msg_init_size.3
parentbc9b7f1f54b9dcf754021f1f7eb766d71cc97f29 (diff)
parent354efc513fdb4096f8830e6c2e3e8f1311303e61 (diff)
Merge branch 'master' of github.com:sustrik/zeromq2
Diffstat (limited to 'man/man3/zmq_msg_init_size.3')
-rw-r--r--man/man3/zmq_msg_init_size.344
1 files changed, 0 insertions, 44 deletions
diff --git a/man/man3/zmq_msg_init_size.3 b/man/man3/zmq_msg_init_size.3
deleted file mode 100644
index cc7a71e..0000000
--- a/man/man3/zmq_msg_init_size.3
+++ /dev/null
@@ -1,44 +0,0 @@
-.TH zmq_msg_init_size 3 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals"
-.SH NAME
-zmq_msg_init \- initialises 0MQ message of a specified size
-.SH SYNOPSIS
-.B int zmq_msg_init_size (zmq_msg_t *msg, size_t size);
-.SH DESCRIPTION
-Initialises 0MQ message
-.IR size
-bytes long. The implementation chooses whether it is more efficient to store
-message content on the stack (small messages) or on the heap (large messages).
-Therefore, never access message data directly via
-.IR zmq_msg_t
-members, rather use
-.IR zmq_msg_data
-and
-.IR zmq_msg_size
-functions to get message data and size. Note that the message data are not
-nullified to avoid the associated performance impact. Thus you
-should expect your message to contain bogus data after this call.
-.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
-.IP "\fBENOMEM\fP"
-memory to hold the message cannot be allocated.
-.SH EXAMPLE
-.nf
-zmq_msg_t msg;
-rc = zmq_msg_init_size (&msg, 6);
-assert (rc == 0);
-memcpy (zmq_msg_data (&msg), "ABCDEF", 6);
-rc = zmq_send (s, &msg, 0);
-assert (rc == 0);
-.fi
-.SH SEE ALSO
-.BR zmq_msg_close (3)
-.BR zmq_msg_init (3)
-.BR zmq_msg_init_data (3)
-.BR zmq_msg_data (3)
-.BR zmq_msg_size (3)
-.SH AUTHOR
-Martin Sustrik <sustrik at 250bpm dot com>