git.m6w6.name Git - m6w6/libmemcached/blob - docs/source/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 -------
  11 LIBRARY
  12 -------
  13
  14
  15 C Client Library for memcached (libmemcached, -lmemcached)
  16
  17
  18 --------
  19 SYNOPSIS
  20 --------
  21
  22
  23 #include <libmemcached/memcached.h>
  24
  25 .. c:function:: void *memcached_get_user_data (memcached_st *ptr)
  26
  27 .. c:function:: void *memcached_set_user_data (memcached_st *ptr, void *data)
  28
  29 Compile and link with -lmemcached
  30
  31
  32
  33 -----------
  34 DESCRIPTION
  35 -----------
  36
  37
  38 libmemcached(3) allows you to store a pointer to a user specific data inside
  39 the memcached_st structure.
  40
  41 :c:func:`memcached_set_user_data` is used to set the user specific data in the
  42 :c:type:`memcached_st` structure.
  43
  44 :c:func:`memcached_get_user_data` is used to retrieve the user specific data in the :c:type:`memcached_st` structure.
  45
  46
  47 ------
  48 RETURN
  49 ------
  50
  51
  52 :c:func:`memcached_set_user_data` returns the previous value of the user specific data.
  53
  54 :c:func:`memcached_get_user_data` returns the current value uf the user specific data.
  55
  56
  57 ----
  58 HOME
  59 ----
  60
  61
  62 To find out more information please check:
  63 `http://libmemcached.org/ <http://libmemcached.org/>`_
  64
  65
  66 --------
  67 SEE ALSO
  68 --------
  69
  70
  71 :manpage:`memcached(1)` :manpage:`libmemcached(3)`
  72