summaryrefslogtreecommitdiff
path: root/docs/memcached_user_data.rst
blob: a0bc602bb0629d4e084f09a28ee2e24969e049db (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
==============================================
Storing custom user information in the client.
==============================================

.. index:: object: memcached_st

Manage user specific data


-------
LIBRARY
-------


C Client Library for memcached (libmemcached, -lmemcached)


--------
SYNOPSIS
--------



.. code-block:: c

#include <libmemcached/memcached.h>

.. c:function:: void *memcached_get_user_data (memcached_st *ptr)

.. c:function:: void *memcached_set_user_data (memcached_st *ptr, void *data)

Compile and link with -lmemcached



-----------
DESCRIPTION
-----------


libmemcached(3) allows you to store a pointer to a user specific data inside
the memcached_st structure.

:c:func:`memcached_set_user_data` is used to set the user specific data in the
:c:type:`memcached_st` structure.

:c:func:`memcached_get_user_data` is used to retrieve the user specific data in the :c:type:`memcached_st` structure.


------
RETURN
------


:c:func:`memcached_set_user_data` returns the previous value of the user specific data.

:c:func:`memcached_get_user_data` returns the current value uf the user specific data.


----
HOME
----


To find out more information please check:
`http://libmemcached.org/ <http://libmemcached.org/>`_


--------
SEE ALSO
--------


:manpage:`memcached(1)` :manpage:`libmemcached(3)`