← Back to branch summary

~brianaker/libmemcached/1164440

« back to all changes in this revision

Viewing changes to docs/memcached_user_data.rst

Merging bzr://gaz.tangent.org/libmemcached/build/ to Build branch

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/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
 
 
24
.. code-block:: c
 
25
 
 
26
#include <libmemcached/memcached.h>
 
27
 
 
28
.. c:function:: void *memcached_get_user_data (memcached_st *ptr)
 
29
 
 
30
.. c:function:: void *memcached_set_user_data (memcached_st *ptr, void *data)
 
31
 
 
32
Compile and link with -lmemcached
 
33
 
 
34
 
 
35
 
 
36
-----------
 
37
DESCRIPTION
 
38
-----------
 
39
 
 
40
 
 
41
libmemcached(3) allows you to store a pointer to a user specific data inside
 
42
the memcached_st structure.
 
43
 
 
44
:c:func:`memcached_set_user_data` is used to set the user specific data in the
 
45
:c:type:`memcached_st` structure.
 
46
 
 
47
:c:func:`memcached_get_user_data` is used to retrieve the user specific data in the :c:type:`memcached_st` structure.
 
48
 
 
49
 
 
50
------
 
51
RETURN
 
52
------
 
53
 
 
54
 
 
55
:c:func:`memcached_set_user_data` returns the previous value of the user specific data.
 
56
 
 
57
:c:func:`memcached_get_user_data` returns the current value uf the user specific 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
SEE ALSO
 
71
--------
 
72
 
 
73
 
 
74
:manpage:`memcached(1)` :manpage:`libmemcached(3)`
 
75