1
.TH "MEMCACHED_SET_MEMORY_ALLOCATORS_CONTEXT" "3" "April 09, 2011" "0.47" "libmemcached"
3
memcached_set_memory_allocators_context \- 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>
44
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);
46
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);
48
void * memcached_get_memory_allocators_context(const memcached_st *ptr);
50
void * (*memcached_malloc_fn) (memcached_st *ptr, const size_t size, void *context);
52
void * (*memcached_realloc_fn) (memcached_st *ptr, void *mem, const size_t size, void *context);
54
void (*memcached_free_fn) (memcached_st *ptr, void *mem, void *context);
56
void * (*memcached_calloc_fn) (memcached_st *ptr, size_t nelem, const size_t elsize, void *context);
61
libmemcached(3) allows you to specify your own memory allocators optimized
62
for your application. This enables libmemcached to be used inside of applications that have their own malloc implementation.
64
memcached_set_memory_allocators() is used to set the memory allocators used
65
by the memcached instance specified by ptr. Please note that you cannot
66
override only one of the memory allocators, you have to specify a complete
67
new set if you want to override one of them. All of the memory allocation
68
functions should behave as specified in the C99 standard. Specify NULL as
69
all functions to reset them to the default values.
71
memcached_get_memory_allocators() is used to get the currently used memory
72
allocators by a mamcached handle.
74
memcached_get_memory_allocators_context() returns the void * that was
75
passed in during the call to memcached_set_memory_allocators().
77
The first argument to the memory allocator functions is a pointer to a
78
memcached structure, the is passed as const and you will need to clone
79
it in order to make use of any operation which would modify it.
82
In version 0.38 all functions were modified to have a context void pointer
83
passed to them. This was so that customer allocators could have their
87
memcached_set_memory_allocators() return MEMCACHED_SUCCESS upon success,
88
and MEMCACHED_FAILURE if you don\(aqt pass a complete set of function pointers.
91
To find out more information please check:
92
\fI\%https://launchpad.net/libmemcached\fP
95
\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
99
2011, Brian Aker DataDifferential, http://datadifferential.com/
100
.\" Generated by docutils manpage writer.
added
removed
docs/man/memcached_set_memory_allocators_context.3
