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