summaryrefslogtreecommitdiff
path: root/docs/reference/src/api/nng_alloc.md
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-03-24 22:19:42 -0700
committerGarrett D'Amore <garrett@damore.org>2024-03-24 22:19:42 -0700
commit331bd5a7c360083f245fe6c82afa38dd05c4a9c9 (patch)
treef7a50976a4a6a717660d1c94a9808e896c3c2059 /docs/reference/src/api/nng_alloc.md
parent962553386968a528593665e228b9424de84d7f4e (diff)
downloadnng-331bd5a7c360083f245fe6c82afa38dd05c4a9c9.tar.gz
nng-331bd5a7c360083f245fe6c82afa38dd05c4a9c9.tar.bz2
nng-331bd5a7c360083f245fe6c82afa38dd05c4a9c9.zip
More org stuff
Diffstat (limited to 'docs/reference/src/api/nng_alloc.md')
-rw-r--r--docs/reference/src/api/nng_alloc.md44
1 files changed, 0 insertions, 44 deletions
diff --git a/docs/reference/src/api/nng_alloc.md b/docs/reference/src/api/nng_alloc.md
deleted file mode 100644
index 6cc4b21f..00000000
--- a/docs/reference/src/api/nng_alloc.md
+++ /dev/null
@@ -1,44 +0,0 @@
-# nng_alloc()
-
-## NAME
-
-nng_alloc --- allocate memory
-
-## SYNOPSIS
-
-```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()`](nng_send.md) using
-the flag `NNG_FLAG_ALLOC`. Alternatively, it can be freed when no
-longer needed using [`nng_free()`](nng_free.md).
-
-> [!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
-
-This 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.
-
-## SEE ALSO
-
-[nng_free()](nng_free.md),
-[nng_send()](nng_send.md)