mirror of
https://github.com/zeromq/libzmq.git
synced 2024-12-12 10:33:52 +01:00
52 lines
1.5 KiB
Plaintext
52 lines
1.5 KiB
Plaintext
= zmq_msg_init_size(3)
|
|
|
|
|
|
== NAME
|
|
zmq_msg_init_size - initialise 0MQ message of a specified size
|
|
|
|
|
|
== SYNOPSIS
|
|
*int zmq_msg_init_size (zmq_msg_t '*msg', size_t 'size');*
|
|
|
|
|
|
== DESCRIPTION
|
|
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.
|
|
|
|
CAUTION: The functions _zmq_msg_init()_, _zmq_msg_init_data()_,
|
|
_zmq_msg_init_size()_ and _zmq_msg_init_buffer()_ are mutually exclusive.
|
|
Never initialise the same 'zmq_msg_t' twice.
|
|
|
|
|
|
== RETURN VALUE
|
|
The _zmq_msg_init_size()_ function shall return zero if successful. Otherwise
|
|
it shall return `-1` and set 'errno' to one of the values defined below.
|
|
|
|
|
|
== ERRORS
|
|
*ENOMEM*::
|
|
Insufficient storage space is available.
|
|
|
|
|
|
== SEE ALSO
|
|
* xref:zmq_msg_init_data.adoc[zmq_msg_init_data]
|
|
* xref:zmq_msg_init_buffer.adoc[zmq_msg_init_buffer]
|
|
* xref:zmq_msg_init.adoc[zmq_msg_init]
|
|
* xref:zmq_msg_close.adoc[zmq_msg_close]
|
|
* xref:zmq_msg_data.adoc[zmq_msg_data]
|
|
* xref:zmq_msg_size.adoc[zmq_msg_size]
|
|
* xref:zmq.adoc[zmq]
|
|
|
|
|
|
== AUTHORS
|
|
This page was written by the 0MQ community. To make a change please
|
|
read the 0MQ Contribution Policy at <https://zeromq.org/how-to-contribute/>.
|