blob: 39b7bc2c914c745ea029a2608c0895d9d7b702b8 (
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
|
# nng_alloc
## NAME
nng_alloc --- allocate memory
## SYNOPSIS
```c
#include <nng/nng.h>
void *nng_alloc(size_t size);
void nng_free(void *ptr, size_t size);
```
## DESCRIPTION
The {{i:`nng_alloc`}} function allocates a contiguous memory region of
at least _size_ bytes.
The memory will be 64-bit aligned.
The {{i:`nng_free`}} function deallocates {{i:memory}} previously allocated by `nng_alloc`.
Memory returned by `nng_alloc` can be used to hold message buffers, in which
case it can be directly passed to [`nng_send`][nng_send] using the flag `NNG_FLAG_ALLOC`.
Alternatively, it can be freed when no longer needed using `nng_free`.
> [!IMPORTANT]
> Do not use the system `free` function (or the C++ `delete` operator) to release this memory.
> On some configurations this may work, but on others it will lead to a crash or
> other unpredictable behavior.
## RETURN VALUES
The `nng_alloc` function returns a pointer to the allocated memory on success,
and `NULL` otherwise.
## ERRORS
No errors are returned, but if memory cannot be allocated then `NULL` is returned.
This can reasonably be treated as if an `NNG_ENOMEM` error occurred.
## SEE ALSO
[nng_send][nng_send]
[nng_send]: [TODO.md]
|
