X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Fmemcached_set_memory_allocators.3;h=06806a5bdb27ec173e88efa55507955d6a05418e;hb=acfcad9a8cf887b92c30eff4894dedbe8f289ff3;hp=faa98be0f03ddf30253e402dd48acc66a9f5a060;hpb=86be0943416087ba738c28ddbde8cdcbd62ad777;p=m6w6%2Flibmemcached diff --git a/docs/man/memcached_set_memory_allocators.3 b/docs/man/memcached_set_memory_allocators.3 index faa98be0..06806a5b 100644 --- a/docs/man/memcached_set_memory_allocators.3 +++ b/docs/man/memcached_set_memory_allocators.3 @@ -1,4 +1,4 @@ -.TH "MEMCACHED_SET_MEMORY_ALLOCATORS" "3" "April 13, 2011" "0.47" "libmemcached" +.TH "MEMCACHED_SET_MEMORY_ALLOCATORS" "3" "October 18, 2011" "1.01" "libmemcached" .SH NAME memcached_set_memory_allocators \- libmemcached Documentation . @@ -32,47 +32,56 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] . .sp Manage memory allocator functions -.SH LIBRARY -.sp -C Client Library for memcached (libmemcached, \-lmemcached) .SH SYNOPSIS .sp -.nf -.ft C #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); -.ft P -.fi +.INDENT 0.0 +.TP +.B 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); +.UNINDENT +.INDENT 0.0 +.TP +.B 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); +.UNINDENT +.INDENT 0.0 +.TP +.B void * memcached_get_memory_allocators_context(const memcached_st *ptr); +.UNINDENT +.INDENT 0.0 +.TP +.B void * (*memcached_malloc_fn) (memcached_st *ptr, const size_t size, void *context); +.UNINDENT +.INDENT 0.0 +.TP +.B void * (*memcached_realloc_fn) (memcached_st *ptr, void *mem, const size_t size, void *context); +.UNINDENT +.INDENT 0.0 +.TP +.B void (*memcached_free_fn) (memcached_st *ptr, void *mem, void *context); +.UNINDENT +.INDENT 0.0 +.TP +.B void * (*memcached_calloc_fn) (memcached_st *ptr, size_t nelem, const size_t elsize, void *context); +.UNINDENT +.sp +Compile and link with \-lmemcached .SH DESCRIPTION .sp -libmemcached(3) allows you to specify your own memory allocators optimized +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. .sp -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. +\fBmemcached_set_memory_allocators()\fP 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. .sp -memcached_get_memory_allocators() is used to get the currently used memory -allocators by a mamcached handle. +\fBmemcached_get_memory_allocators()\fP is used to get the currently used +memory allocators by a mamcached handle. .sp -memcached_get_memory_allocators_context() returns the void * that was -passed in during the call to memcached_set_memory_allocators(). +\fBmemcached_get_memory_allocators_context()\fP returns the void * that +was passed in during the call to \fBmemcached_set_memory_allocators()\fP. .sp 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 @@ -84,8 +93,9 @@ passed to them. This was so that customer allocators could have their own space for memory. .SH RETURN .sp -memcached_set_memory_allocators() return MEMCACHED_SUCCESS upon success, -and MEMCACHED_FAILURE if you don\(aqt pass a complete set of function pointers. +\fBmemcached_set_memory_allocators()\fP return \fBMEMCACHED_SUCCESS\fP +upon success, and \fBMEMCACHED_FAILURE\fP if you don\(aqt pass a complete set +of function pointers. .SH HOME .sp To find out more information please check: