git.m6w6.name Git - awesomized/libmemcached/blob - docs/source/libmemcached/memcached_memory_allocators.rst

   1 Use custom allocators for embedded usage
   2 ========================================
   3
   4 .. index:: object: memcached_st
   5
   6 Manage memory allocator functions
   7
   8 SYNOPSIS
   9 --------
  10
  11 #include <libmemcached/memcached.h>
  12
  13 .. function:: memcached_return_t memcached_set_memory_allocators (memcached_st *ptr, memcached_malloc_fn mem_malloc, memcached_free_fn mem_free, memcached_realloc_fn mem_realloc, memcached_calloc_fn mem_calloc, void *context)
  14
  15 .. function:: void memcached_get_memory_allocators (memcached_st *ptr, memcached_malloc_fn *mem_malloc, memcached_free_fn *mem_free, memcached_realloc_fn *mem_realloc, memcached_calloc_fn *mem_calloc)
  16
  17 .. function:: void * memcached_get_memory_allocators_context(const memcached_st *ptr)
  18
  19 .. function:: void * (*memcached_malloc_fn) (memcached_st *ptr, const size_t size, void *context)
  20
  21 .. function:: void * (*memcached_realloc_fn) (memcached_st *ptr, void *mem, const size_t size, void *context)
  22
  23 .. function:: void (*memcached_free_fn) (memcached_st *ptr, void *mem, void *context)
  24
  25 .. function:: void * (*memcached_calloc_fn) (memcached_st *ptr, size_t nelem, const size_t elsize, void *context)
  26
  27 Compile and link with -lmemcached
  28
  29 DESCRIPTION
  30 -----------
  31
  32 libmemcached(3) allows you to specify your own memory allocators, optimized
  33 for your application. This enables libmemcached to be used inside of applications that have their own malloc implementation.
  34
  35 :func:`memcached_set_memory_allocators` is used to set the memory
  36 allocators used by the memcached instance specified by ptr. Please note that
  37 you cannot override only one of the memory allocators, you have to specify a
  38 complete new set if you want to override one of them. All of the memory
  39 allocation functions should behave as specified in the C99 standard. Specify
  40 NULL as all functions to reset them to the default values.
  41
  42 :func:`memcached_get_memory_allocators` is used to get the currently used
  43 memory allocators by a memcached handle.
  44
  45 :func:`memcached_get_memory_allocators_context` returns the void \* that
  46 was passed in during the call to :func:`memcached_set_memory_allocators`.
  47
  48 The first argument to the memory allocator functions is a pointer to a
  49 memcached structure, the is passed as const and you will need to clone
  50 it in order to make use of any operation which would modify it.
  51
  52 NOTES
  53 -----
  54
  55 In version 0.38 all functions were modified to have a context void pointer
  56 passed to them. This was so that customer allocators could have their
  57 own space for memory.
  58
  59 RETURN
  60 ------
  61
  62 :func:`memcached_set_memory_allocators` return `MEMCACHED_SUCCESS`
  63 upon success, and `MEMCACHED_FAILURE` if you don't pass a complete set
  64 of function pointers.
  65
  66 SEE ALSO
  67 --------
  68
  69 .. only:: man
  70
  71   :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`