Skip to content

Latest commit

 

History

History
56 lines (41 loc) · 1.49 KB

nng_alloc.3.adoc

File metadata and controls

56 lines (41 loc) · 1.49 KB
Raw

nng_alloc(3)

NAME

nng_alloc - allocate memory

SYNOPSIS

#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() 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 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 a pointer to the allocated memory on success, and NULL otherwise.

ERRORS

No errors are returned, but a NULL return value should be treated the same as NNG_ENOMEM.