git.m6w6.name Git - awesomized/libmemcached/blob - docs/source/libmemcached/memcached_user_data.rst

   1 ==============================================
   2 Storing custom user information in the client.
   3 ==============================================
   4
   5 .. index:: object: memcached_st
   6
   7 Manage user specific data
   8
   9 LIBRARY
  10 -------
  11
  12 C Client Library for memcached (libmemcached, -lmemcached)
  13
  14 SYNOPSIS
  15 --------
  16
  17 #include <libmemcached/memcached.h>
  18
  19 .. function:: void *memcached_get_user_data (memcached_st *ptr)
  20
  21 .. function:: void *memcached_set_user_data (memcached_st *ptr, void *data)
  22
  23 Compile and link with -lmemcached
  24
  25 DESCRIPTION
  26 -----------
  27
  28 libmemcached(3) allows you to store a pointer to a user specific data inside
  29 the memcached_st structure.
  30
  31 :func:`memcached_set_user_data` is used to set the user specific data in the
  32 :type:`memcached_st` structure.
  33
  34 :func:`memcached_get_user_data` is used to retrieve the user specific data in the :type:`memcached_st` structure.
  35
  36 RETURN
  37 ------
  38
  39 :func:`memcached_set_user_data` returns the previous value of the user specific data.
  40
  41 :func:`memcached_get_user_data` returns the current value uf the user specific data.
  42
  43 SEE ALSO
  44 --------
  45
  46 .. only:: man
  47
  48   :manpage:`memcached(1)` :manpage:`libmemcached(3)`
  49