1 .TH "MEMCACHED_MEMORY_ALLOCATORS" "3" "April 08, 2011" "0.47" "libmemcached"
3 memcached_memory_allocators \- libmemcached Documentation
5 .nr rst2man-indent-level 0
9 level \\n[rst2man-indent-level]
10 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
17 .\" .rstReportMargin pre:
19 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
20 . nr rst2man-indent-level +1
21 .\" .rstReportMargin post:
25 .\" indent \\n[an-margin]
26 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
27 .nr rst2man-indent-level -1
28 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
29 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
31 .\" Man page generated from reStructeredText.
34 Manage memory allocator functions
37 C Client Library for memcached (libmemcached, \-lmemcached)
42 #include <libmemcached/memcached.h>
45 memcached_set_memory_allocators (memcached_st *ptr,
46 memcached_malloc_fn mem_malloc,
47 memcached_free_fn mem_free,
48 memcached_realloc_fn mem_realloc,
49 memcached_calloc_fn mem_calloc,
53 memcached_get_memory_allocators (memcached_st *ptr,
54 memcached_malloc_fn *mem_malloc,
55 memcached_free_fn *mem_free,
56 memcached_realloc_fn *mem_realloc,
57 memcached_calloc_fn *mem_calloc);
60 memcached_get_memory_allocators_context(const memcached_st *ptr);
63 (*memcached_malloc_fn) (memcached_st *ptr, const size_t size,
67 (*memcached_realloc_fn) (memcached_st *ptr, void *mem,
72 (*memcached_free_fn) (memcached_st *ptr, void *mem,
76 (*memcached_calloc_fn) (memcached_st *ptr,
84 libmemcached(3) allows you to specify your own memory allocators optimized
87 memcached_set_memory_allocators() is used to set the memory allocators used
88 by the memcached instance specified by ptr. Please note that you cannot
89 override only one of the memory allocators, you have to specify a complete
90 new set if you want to override one of them. All of the memory allocation
91 functions should behave as specified in the C99 standard. Specify NULL as
92 all functions to reset them to the default values.
94 memcached_get_memory_allocators() is used to get the currently used memory
95 allocators by a mamcached handle.
97 memcached_get_memory_allocators_context() returns the void * that was
98 passed in during the call to memcached_set_memory_allocators().
100 The first argument to the memory allocator functions is a pointer to a
101 memcached structure, the is passed as const and you will need to clone
102 it in order to make use of any operation which would modify it.
105 In version 0.38 all functions were modified to have a context void pointer
106 passed to them. This was so that customer allocators could have their
107 own space for memory.
110 memcached_set_memory_allocators() return MEMCACHED_SUCCESS upon success,
111 and MEMCACHED_FAILURE if you don\(aqt pass a complete set of function pointers.
114 To find out more information please check:
115 \fI\%https://launchpad.net/libmemcached\fP
118 Trond Norbye, <\fI\%trond.norbye@gmail.com\fP>
119 Brian Aker, <\fI\%brian@tangent\fP.orf<gt>
122 memcached(1) libmemcached(3) memcached_get_user_data(3) memcached_set_user_data(3)
127 .\" Generated by docutils manpage writer.