aboutsummaryrefslogtreecommitdiff
path: root/docs/nng_msg_alloc.adoc
blob: 8446c358861776f20ebc1d5d009933f7684ff3d6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
= nng_msg_alloc(3)
:doctype: manpage
:manmanual: nng
:mansource: nng
:manvolnum: 3
:copyright: Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> \
            Copyright 2018 Capitar IT Group BV <info@capitar.com> \
            This software is supplied under the terms of the MIT License, a \
            copy of which should be located in the distribution where this \
            file was obtained (LICENSE.txt).  A copy of the license may also \
            be found online at https://opensource.org/licenses/MIT.

== NAME

nng_msg_alloc - allocate a message

== SYNOPSIS

[source, c]
-----------
#include <nng/nng.h>

int nng_msg_alloc(nng_msg **msgp, size_t size);
-----------


== DESCRIPTION

The `nng_msg_alloc()` function allocates a new message with body length _size_
and stores the result in __msgp__.
Messages allocated with this function contain a body and optionally a header.
They are used with receive and transmit functions.


== RETURN VALUES

This function returns 0 on success, and non-zero otherwise.


== ERRORS

`NNG_ENOMEM`:: Insufficient free memory exists to allocate a message.


== SEE ALSO

<<nng_msg_free#,nng_msg_free(3)>>,
<<nng_msg_body#,nng_msg_body(3)>>,
<<nng_msg_dup#,nng_msg_dup(3)>>,
<<nng_msg_header#,nng_msg_header(3)>>,
<<nng_msg_header_len#,nng_msg_header_len(3)>>,
<<nng_msg_len#,nng_msg_len(3)>>,
<<nng_msg_realloc#,nng_msg_realloc(3)>>,
<<nng_strerror#,nng_strerror(3)>>,
<<nng#,nng(7)>>


== COPYRIGHT

Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] +
Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV]

This document is supplied under the terms of the
https://opensource.org/licenses/MIT[MIT License].