From 018294242819ed59e708e23cf40b822e843ec3ac Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Tue, 22 Oct 2024 14:10:47 -0700 Subject: docs: add memory chapter --- docs/ref/api/util/nng_alloc.md | 47 ------------------------------------------ 1 file changed, 47 deletions(-) delete mode 100644 docs/ref/api/util/nng_alloc.md (limited to 'docs/ref/api/util/nng_alloc.md') diff --git a/docs/ref/api/util/nng_alloc.md b/docs/ref/api/util/nng_alloc.md deleted file mode 100644 index 39b7bc2c..00000000 --- a/docs/ref/api/util/nng_alloc.md +++ /dev/null @@ -1,47 +0,0 @@ -# nng_alloc - -## NAME - -nng_alloc --- allocate memory - -## SYNOPSIS - -```c -#include - -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] -- cgit v1.2.3-70-g09d2