Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

ne_oom_callback (3)

Name

ne_oom_callback - ne_malloc, ne_calloc, ne_realloc, ne_strdup, ne_strndup, memory allocation wrappers

Synopsis

#include <ne_alloc.h>

void *ne_malloc(size_t size);

void *ne_calloc(size_t size);

void *ne_realloc(void *size, size_t len);

char *ne_strdup(const char *s);

char *ne_strndup(const char *s, size_t size);

void ne_oom_callback(void (*callback)(void));

Description

NE_MALLOC(3)                  neon API reference                  NE_MALLOC(3)



NAME
       ne_malloc, ne_calloc, ne_realloc, ne_strdup, ne_strndup,
       ne_oom_callback - memory allocation wrappers

SYNOPSIS
       #include <ne_alloc.h>

       void *ne_malloc(size_t size);

       void *ne_calloc(size_t size);

       void *ne_realloc(void *size, size_t len);

       char *ne_strdup(const char *s);

       char *ne_strndup(const char *s, size_t size);

       void ne_oom_callback(void (*callback)(void));

DESCRIPTION
       The functions ne_malloc, ne_calloc, ne_realloc, ne_strdup and
       ne_strdnup provide wrappers for the equivalent functions in the
       standard C library. The wrappers provide the extra guarantee that if
       the C library equivalent returns NULL when no memory is available, an
       optional callback will be called, and the library will then call
       abort().

       ne_oom_callback registers a callback which will be invoked if an out of
       memory error is detected.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/neon     |
       +---------------+------------------+
       |Stability      | Volatile         |
       +---------------+------------------+
NOTES
       If the operating system uses optimistic memory allocation, the C
       library memory allocation routines will not return NULL, so it is not
       possible to gracefully handle memory allocation failures.

AUTHOR
       Joe Orton <neon@lists.manyfish.co.uk>
           Author.

COPYRIGHT
       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       http://www.webdav.org/neon/neon-0.30.1.tar.gz

       Further information about this software can be found on the open source
       community website at http://www.webdav.org/neon/.



neon 0.30.1                    23 September 2014                  NE_MALLOC(3)