From b779b71b00c5f5f8cb9f0ee7d8feeadf9e2dca48 Mon Sep 17 00:00:00 2001
From: Garrett D'Amore <garrett@damore.org>
Date: Sat, 30 Mar 2024 16:12:02 -0700
Subject: util funcs reorg

---
 docs/reference/src/util/nng_alloc.md | 46 ++++++++++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)
 create mode 100644 docs/reference/src/util/nng_alloc.md

(limited to 'docs/reference/src/util/nng_alloc.md')

diff --git a/docs/reference/src/util/nng_alloc.md b/docs/reference/src/util/nng_alloc.md
new file mode 100644
index 00000000..6f992798
--- /dev/null
+++ b/docs/reference/src/util/nng_alloc.md
@@ -0,0 +1,46 @@
+# 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] using
+the flag `NNG_FLAG_ALLOC`. Alternatively, it can be freed when no
+longer needed using [`nng_free()`][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
+
+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],
+[nng_send][nng_send]
+
+{{#include ../refs.md}}
-- 
cgit v1.2.3-70-g09d2