diff options
Diffstat (limited to 'docs/man/nng_alloc.3.adoc')
| -rw-r--r-- | docs/man/nng_alloc.3.adoc | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/docs/man/nng_alloc.3.adoc b/docs/man/nng_alloc.3.adoc new file mode 100644 index 00000000..7d7adf07 --- /dev/null +++ b/docs/man/nng_alloc.3.adoc @@ -0,0 +1,53 @@ += nng_alloc(3) +// +// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2018 Capitar IT Group BV <info@capitar.com> +// +// This document 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_alloc - allocate memory + +== SYNOPSIS + +[source, c] +---- +#include <nng/nng.h> + +void *nng_alloc(size_t size); +---- + +== DESCRIPTION + +The `nng_alloc()` function allocates a contiguous memory region of +at least _size_ bytes. +The memory will be 64-bit aligned. + +The returned memory can be used to hold message buffers, in which +case it can be directly passed to <<nng_send.3#,`nng_send()`>> using +the flag `NNG_FLAG_ALLOC`. Alternatively, it can be freed when no +longer needed using <<nng_free.3#,`nng_free()`>>. + +WARNING: Do not use the system `free()` function to release this memory. +On some platforms this may work, but it is not guaranteed and may lead +to a crash or other undesirable and unpredictable behavior. + +== RETURN VALUES + +This function returns 0 on success, and non-zero otherwise. + +== ERRORS + +`NNG_ENOMEM`:: Insufficient free memory exists. + +== SEE ALSO + +<<nng_free.3#,nng_free(3)>>, +<<nng_send.3#,nng_send(3)>>, +<<nng_strerror.3#,nng_strerror(3)>>, +<<nng.7#,nng(7)>> |
