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

   1 ==============================================
   2 Storing custom user information in the client.
   3 ==============================================
   4
   5
   6 Manage user specific data
   7
   8
   9 *******
  10 LIBRARY
  11 *******
  12
  13
  14 C Client Library for memcached (libmemcached, -lmemcached)
  15
  16
  17 --------
  18 SYNOPSIS
  19 --------
  20
  21
  22
  23 .. code-block:: perl
  24
  25    #include <libmemcached/memcached.h>
  26
  27    void *memcached_get_user_data (memcached_st *ptr);
  28
  29    void *memcached_set_user_data (memcached_st *ptr, void *data);
  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 memcached_set_user_data() is used to set the user specific data in the
  42 memcached_st structure.
  43
  44 memcached_get_user_data() is used to retrieve the user specific data in
  45 the memcached_st structure.
  46
  47
  48 ******
  49 RETURN
  50 ******
  51
  52
  53 memcached_set_user_data() returns the previous value of the user specific
  54 data.
  55
  56 memcached_get_user_data() returns the current value uf the user specific
  57 data.
  58
  59
  60 ****
  61 HOME
  62 ****
  63
  64
  65 To find out more information please check:
  66 `http://libmemcached.org/ <http://libmemcached.org/>`_
  67
  68
  69 ******
  70 AUTHOR
  71 ******
  72
  73
  74 Trond Norbye, <trond.norbye@gmail.com>
  75
  76
  77 --------
  78 SEE ALSO
  79 --------
  80
  81
  82 memcached(1) libmemcached(3)
  83