zmq_msg_init_size.txt 1.44 KB
Newer Older
1 2 3 4 5 6
zmq_msg_init_size(3)
====================


NAME
----
Martin Lucina's avatar
Martin Lucina committed
7
zmq_msg_init_size - initialise 0MQ message of a specified size
8 9 10 11


SYNOPSIS
--------
Martin Lucina's avatar
Martin Lucina committed
12
*int zmq_msg_init_size (zmq_msg_t '*msg', size_t 'size');*
13 14 15 16


DESCRIPTION
-----------
Martin Lucina's avatar
Martin Lucina committed
17 18 19 20 21 22 23 24 25 26
The _zmq_msg_init_size()_ function shall allocate any resources required to
store a message 'size' bytes long and initialise the message object referenced
by 'msg' to represent the newly allocated message.

The implementation shall choose whether to store message content on the stack
(small messages) or on the heap (large messages). For performance reasons
_zmq_msg_init_size()_ shall not clear the message data.

CAUTION: Never access 'zmq_msg_t' members directly, instead always use the
_zmq_msg_ family of functions.
27

28
CAUTION: The functions _zmq_msg_init()_, _zmq_msg_init_data()_ and
29
_zmq_msg_init_size()_ are mutually exclusive. Never initialise the same
30 31
'zmq_msg_t' twice.

32 33 34

RETURN VALUE
------------
Martin Lucina's avatar
Martin Lucina committed
35
The _zmq_msg_init_size()_ function shall return zero if successful. Otherwise
Martin Lucina's avatar
Martin Lucina committed
36
it shall return `-1` and set 'errno' to one of the values defined below.
37 38 39 40 41


ERRORS
------
*ENOMEM*::
Martin Lucina's avatar
Martin Lucina committed
42
Insufficient storage space is available.
43 44 45 46 47


SEE ALSO
--------
linkzmq:zmq_msg_init_data[3]
Martin Lucina's avatar
Martin Lucina committed
48 49
linkzmq:zmq_msg_init[3]
linkzmq:zmq_msg_close[3]
50 51
linkzmq:zmq_msg_data[3]
linkzmq:zmq_msg_size[3]
Martin Lucina's avatar
Martin Lucina committed
52
linkzmq:zmq[7]
53 54


55 56
AUTHORS
-------
57 58
This page was written by the 0MQ community. To make a change please
read the 0MQ Contribution Policy at <http://www.zeromq.org/docs:contributing>.