← Back to branch summary

~trond-norbye/libmemcached/fragment-read-write

« back to all changes in this revision

Viewing changes to docs/memcached_memory_allocators.rst

  • Committer: Brian Aker
  • Date: 2011-06-24 20:09:30 UTC
  • mfrom: (929.1.155 libmemcached-build)
  • Revision ID: brian@tangent.org-20110624200930-m268yogmnpyzs3qj
Merge in trunk. Updates to manual/update to latest libtest.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/memcached_memory_allocators.rst
39
39
libmemcached(3) allows you to specify your own memory allocators, optimized
40
40
for your application. This enables libmemcached to be used inside of applications that have their own malloc implementation.
41
41
 
42
 
memcached_set_memory_allocators() is used to set the memory allocators used
43
 
by the memcached instance specified by ptr. Please note that you cannot
44
 
override only one of the memory allocators, you have to specify a complete
45
 
new set if you want to override one of them. All of the memory allocation
46
 
functions should behave as specified in the C99 standard. Specify NULL as
47
 
all functions to reset them to the default values.
48
 
 
49
 
memcached_get_memory_allocators() is used to get the currently used memory
50
 
allocators by a mamcached handle.
51
 
 
52
 
memcached_get_memory_allocators_context() returns the void \* that was
53
 
passed in during the call to memcached_set_memory_allocators().
 
42
:c:func:`memcached_set_memory_allocators()` is used to set the memory 
 
43
allocators used by the memcached instance specified by ptr. Please note that 
 
44
you cannot override only one of the memory allocators, you have to specify a 
 
45
complete new set if you want to override one of them. All of the memory 
 
46
allocation functions should behave as specified in the C99 standard. Specify 
 
47
NULL as all functions to reset them to the default values.
 
48
 
 
49
:c:func:`memcached_get_memory_allocators()` is used to get the currently used 
 
50
memory allocators by a mamcached handle.
 
51
 
 
52
:c:func:`memcached_get_memory_allocators_context()` returns the void \* that 
 
53
was passed in during the call to :c:func:`memcached_set_memory_allocators()`.
54
54
 
55
55
The first argument to the memory allocator functions is a pointer to a
56
56
memcached structure, the is passed as const and you will need to clone
72
72
------
73
73
 
74
74
 
75
 
memcached_set_memory_allocators() return MEMCACHED_SUCCESS upon success,
76
 
and MEMCACHED_FAILURE if you don't pass a complete set of function pointers.
 
75
:c:func:`memcached_set_memory_allocators()` return :c:type:`MEMCACHED_SUCCESS` 
 
76
upon success, and :c:type:`MEMCACHED_FAILURE` if you don't pass a complete set 
 
77
of function pointers.
77
78
 
78
79
 
79
80
----