X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_memory_allocators.rst;h=33f3d3a72596ae6b6fa045af7594aae3ea4fb135;hb=da3714e6dc31ab2f9d115707ab79a838420c7b5a;hp=40219079d9f4281b79c4fee0352cb199515c9c3a;hpb=0f16555031c7f44d1acd034ff74e628c51a72dac;p=m6w6%2Flibmemcached diff --git a/docs/memcached_memory_allocators.rst b/docs/memcached_memory_allocators.rst index 40219079..33f3d3a7 100644 --- a/docs/memcached_memory_allocators.rst +++ b/docs/memcached_memory_allocators.rst @@ -2,41 +2,32 @@ Use custom allocators for embedded usage ======================================== +.. index:: object: memcached_st Manage memory allocator functions +-------- +SYNOPSIS +-------- -------- -LIBRARY -------- +#include -C Client Library for memcached (libmemcached, -lmemcached) +.. c: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); +.. c: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); --------- -SYNOPSIS --------- +.. c:function:: void * memcached_get_memory_allocators_context(const memcached_st *ptr); + +.. c:function:: void * (*memcached_malloc_fn) (memcached_st *ptr, const size_t size, void *context); + +.. c:function:: void * (*memcached_realloc_fn) (memcached_st *ptr, void *mem, const size_t size, void *context); +.. c:function:: void (*memcached_free_fn) (memcached_st *ptr, void *mem, void *context); +.. c:function:: void * (*memcached_calloc_fn) (memcached_st *ptr, size_t nelem, const size_t elsize, void *context); -.. code-block:: perl - - #include - - 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); - - 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); - - void * memcached_get_memory_allocators_context(const memcached_st *ptr); - - void * (*memcached_malloc_fn) (memcached_st *ptr, const size_t size, void *context); - - void * (*memcached_realloc_fn) (memcached_st *ptr, void *mem, const size_t size, void *context); - - void (*memcached_free_fn) (memcached_st *ptr, void *mem, void *context); - - void * (*memcached_calloc_fn) (memcached_st *ptr, size_t nelem, const size_t elsize, void *context); +Compile and link with -lmemcached