X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_memory_allocators.rst;h=12a4ce5e0a77a9b16852093d8fc8dcfcd2615559;hb=09835f1c7f9e00ed3561968d496aa1dd6061f7ac;hp=33f3d3a72596ae6b6fa045af7594aae3ea4fb135;hpb=da3714e6dc31ab2f9d115707ab79a838420c7b5a;p=m6w6%2Flibmemcached diff --git a/docs/memcached_memory_allocators.rst b/docs/memcached_memory_allocators.rst index 33f3d3a7..12a4ce5e 100644 --- a/docs/memcached_memory_allocators.rst +++ b/docs/memcached_memory_allocators.rst @@ -13,19 +13,19 @@ SYNOPSIS #include -.. 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:: 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); +.. 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) -.. c:function:: void * memcached_get_memory_allocators_context(const memcached_st *ptr); +.. 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_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_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_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); +.. c:function:: void * (*memcached_calloc_fn) (memcached_st *ptr, size_t nelem, const size_t elsize, void *context) Compile and link with -lmemcached @@ -39,18 +39,18 @@ DESCRIPTION libmemcached(3) allows you to specify your own memory allocators, optimized for your application. This enables libmemcached to be used inside of applications that have their own malloc implementation. -memcached_set_memory_allocators() is used to set the memory allocators used -by the memcached instance specified by ptr. Please note that you cannot -override only one of the memory allocators, you have to specify a complete -new set if you want to override one of them. All of the memory allocation -functions should behave as specified in the C99 standard. Specify NULL as -all functions to reset them to the default values. +:c:func:`memcached_set_memory_allocators` is used to set the memory +allocators used by the memcached instance specified by ptr. Please note that +you cannot override only one of the memory allocators, you have to specify a +complete new set if you want to override one of them. All of the memory +allocation functions should behave as specified in the C99 standard. Specify +NULL as all functions to reset them to the default values. -memcached_get_memory_allocators() is used to get the currently used memory -allocators by a mamcached handle. +:c:func:`memcached_get_memory_allocators` is used to get the currently used +memory allocators by a mamcached handle. -memcached_get_memory_allocators_context() returns the void \* that was -passed in during the call to memcached_set_memory_allocators(). +:c:func:`memcached_get_memory_allocators_context` returns the void \* that +was passed in during the call to :c:func:`memcached_set_memory_allocators`. The first argument to the memory allocator functions is a pointer to a memcached structure, the is passed as const and you will need to clone @@ -72,8 +72,9 @@ RETURN ------ -memcached_set_memory_allocators() return MEMCACHED_SUCCESS upon success, -and MEMCACHED_FAILURE if you don't pass a complete set of function pointers. +:c:func:`memcached_set_memory_allocators` return :c:type:`MEMCACHED_SUCCESS` +upon success, and :c:type:`MEMCACHED_FAILURE` if you don't pass a complete set +of function pointers. ----