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

   1 .. highlight:: perl
   2
   3
   4 memcached_set_memory_allocators, memcached_get_memory_allocators, memcached_set_memory_allocators_context
   5 *********************************************************************************************************
   6
   7
   8 Manage memory allocator functions
   9
  10
  11 *******
  12 LIBRARY
  13 *******
  14
  15
  16 C Client Library for memcached (libmemcached, -lmemcached)
  17
  18
  19 ********
  20 SYNOPSIS
  21 ********
  22
  23
  24
  25 .. code-block:: perl
  26
  27    #include <memcached.h>
  28
  29    memcached_return_t
  30      memcached_set_memory_allocators (memcached_st *ptr,
  31                                       memcached_malloc_fn mem_malloc,
  32                                       memcached_free_fn mem_free,
  33                                       memcached_realloc_fn mem_realloc,
  34                                       memcached_calloc_fn mem_calloc,
  35                                      void *context);
  36
  37    void
  38      memcached_get_memory_allocators (memcached_st *ptr,
  39                                       memcached_malloc_fn *mem_malloc,
  40                                       memcached_free_fn *mem_free,
  41                                       memcached_realloc_fn *mem_realloc,
  42                                       memcached_calloc_fn *mem_calloc);
  43
  44    void *
  45      memcached_get_memory_allocators_context(const memcached_st *ptr);
  46
  47    void *
  48      (*memcached_malloc_fn) (memcached_st *ptr, const size_t size,
  49                             void *context);
  50
  51    void *
  52      (*memcached_realloc_fn) (memcached_st *ptr, void *mem,
  53                               const size_t size,
  54                              void *context);
  55
  56    void
  57      (*memcached_free_fn) (memcached_st *ptr, void *mem,
  58                           void *context);
  59
  60    void *
  61    (*memcached_calloc_fn) (memcached_st *ptr,
  62                           size_t nelem,
  63                            const size_t elsize,
  64                           void *context);
  65
  66
  67
  68 ***********
  69 DESCRIPTION
  70 ***********
  71
  72
  73 libmemcached(3) allows you to specify your own memory allocators optimized
  74 for your application.
  75
  76 memcached_set_memory_allocators() is used to set the memory allocators used
  77 by the memcached instance specified by ptr. Please note that you cannot
  78 override only one of the memory allocators, you have to specify a complete
  79 new set if you want to override one of them. All of the memory allocation
  80 functions should behave as specified in the C99 standard. Specify NULL as
  81 all functions to reset them to the default values.
  82
  83 memcached_get_memory_allocators() is used to get the currently used memory
  84 allocators by a mamcached handle.
  85
  86 memcached_get_memory_allocators_context() returns the void \* that was
  87 passed in during the call to memcached_set_memory_allocators().
  88
  89 The first argument to the memory allocator functions is a pointer to a
  90 memcached structure, the is passed as const and you will need to clone
  91 it in order to make use of any operation which would modify it.
  92
  93
  94 *****
  95 NOTES
  96 *****
  97
  98
  99 In version 0.38 all functions were modified to have a context void pointer
 100 passed to them. This was so that customer allocators could have their
 101 own space for memory.
 102
 103
 104 ******
 105 RETURN
 106 ******
 107
 108
 109 memcached_set_memory_allocators() return MEMCACHED_SUCCESS upon success,
 110 and MEMCACHED_FAILURE if you don't pass a complete set of function pointers.
 111
 112
 113 ****
 114 HOME
 115 ****
 116
 117
 118 To find out more information please check:
 119 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
 120
 121
 122 ******
 123 AUTHOR
 124 ******
 125
 126
 127 Trond Norbye, <trond.norbye@gmail.com>
 128 Brian Aker, <brian@tangent.orf<gt>
 129
 130
 131 ********
 132 SEE ALSO
 133 ********
 134
 135
 136 memcached(1) libmemcached(3) memcached_get_user_data(3) memcached_set_user_data(3)
 137