Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

memcached_get_memory_allocators(3) [debian man page]

MEMCACHED_GET_MEMORY_ALLOCATORS(3)				   libmemcached 				MEMCACHED_GET_MEMORY_ALLOCATORS(3)

NAME

       memcached_get_memory_allocators - libmemcached Documentation

       Manage memory allocator functions

SYNOPSIS

       #include <libmemcached/memcached.h>

       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

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.

       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().

       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 it in order to make use of any operation which would modify it.

NOTES

       In version 0.38 all functions were modified to have a context void pointer passed to them. This was so that customer allocators could  have
       their own space for memory.

RETURN

       memcached_set_memory_allocators() return MEMCACHED_SUCCESS upon success, and MEMCACHED_FAILURE if you don't pass a complete set of function
       pointers.

HOME

       To find out more information please check: http://libmemcached.org/

SEE ALSO

       memcached(1) libmemcached(3) memcached_strerror(3)

AUTHOR

       Brian Aker

COPYRIGHT

       2011, Brian Aker DataDifferential, http://datadifferential.com/

1.0.8								   May 22, 2012 				MEMCACHED_GET_MEMORY_ALLOCATORS(3)

Check Out this Related Man Page

MEMCACHED_CREATE(3)						   libmemcached 					       MEMCACHED_CREATE(3)

NAME

       memcached_create - libmemcached Documentation

SYNOPSIS

       #include <libmemcached/memcached.h>

       memcached_st

       memcached_st* memcached_create(memcached_st *ptr)

       void memcached_free(memcached_st *ptr)

       memcached_st* memcached_clone(memcached_st *destination, memcached_st *source)

       void memcached_servers_reset(memcached_st)

       Compile and link with -lmemcached

DESCRIPTION

       memcached_create() is used to create a memcached_st structure that will then be used by other libmemcached(3) functions to communicate with
       the server. You should either pass a statically declared memcached_st to memcached_create() or a NULL. If a NULL passed in then a structure
       is allocated for you.

       Please note, when you write new application use memcached() over memcached_create().

       memcached_clone() is similar to memcached_create() but it copies the defaults and list of servers from the source memcached_st. If you pass
       a null as the argument for the source to clone, it is the same as a call to memcached_create().	If the	destination  argument  is  NULL  a
       memcached_st will be allocated for you.

       memcached_servers_reset() allows you to zero out the list of servers that the memcached_st has.

       To  clean  up  memory  associated  with	a  memcached_st  structure  you should pass it to memcached_free() when you are finished using it.
       memcached_free() is the only way to make sure all memory is deallocated when you finish using the structure.

       You may wish to avoid using memcached_create(3) or memcached_clone(3) with a stack based allocation. The most common issues related to  ABI
       safety involve heap allocated structures.

RETURN

       memcached_create() returns a pointer to the memcached_st that was created (or initialized). On an allocation failure, it returns NULL.

       memcached_clone() returns a pointer to the memcached_st that was created (or initialized). On an allocation failure, it returns NULL.

HOME

       To find out more information please check: http://libmemcached.org/

SEE ALSO

       memcached(1) libmemcached(3) memcached_strerror(3)

AUTHOR

       Brian Aker

COPYRIGHT

       2011-2013, Brian Aker DataDifferential, http://datadifferential.com/

1.0.16								 January 31, 2013					       MEMCACHED_CREATE(3)
Man Page