projects
/
awesomized
/
libmemcached
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
|
github
raw
|
inline
| side by side
testing: limit random port range to probably unused ports
[awesomized/libmemcached]
/
docs
/
source
/
libmemcached
/
memcached_user_data.rst
diff --git
a/docs/source/libmemcached/memcached_user_data.rst
b/docs/source/libmemcached/memcached_user_data.rst
index 9f62f8903b4d7ff4252a09f2b94007075835d13f..7d9e01799dddd8cf54677fd65ee0c95a0f198e32 100644
(file)
--- a/
docs/source/libmemcached/memcached_user_data.rst
+++ b/
docs/source/libmemcached/memcached_user_data.rst
@@
-1,65
+1,51
@@
-==============================================
-Storing custom user information in the client.
-==============================================
+Storing custom information in the client
+========================================
-.. index:: object: memcached_st
-
-Manage user specific data
-
-
--------
-LIBRARY
--------
-
-
-C Client Library for memcached (libmemcached, -lmemcached)
-
-
---------
SYNOPSIS
--------
SYNOPSIS
--------
-
#include <libmemcached/memcached.h>
#include <libmemcached/memcached.h>
+ Compile and link with -lmemcached
.. function:: void *memcached_get_user_data (memcached_st *ptr)
.. function:: void *memcached_get_user_data (memcached_st *ptr)
-.. function:: void *memcached_set_user_data (memcached_st *ptr, void *data)
-
-Compile and link with -lmemcached
+ :param ptr: pointer to initialized `memcached_st` struct
+ :returns: opaque pointer to the user supplied data
+.. function:: void *memcached_set_user_data (memcached_st *ptr, void *data)
+ :param ptr: pointer to initialized `memcached_st` struct
+ :param data: opaque pointer to user supplied data
+ :returns: opaque pointer to the previously set `data`
------------
DESCRIPTION
-----------
DESCRIPTION
-----------
-
-libmemcached(3) allows you to store a pointer to a user specific data inside
+`libmemcached` allows you to store a pointer to a user specific data inside
the memcached_st structure.
:func:`memcached_set_user_data` is used to set the user specific data in the
:type:`memcached_st` structure.
the memcached_st structure.
:func:`memcached_set_user_data` is used to set the user specific data in the
:type:`memcached_st` structure.
-:func:`memcached_get_user_data` is used to retrieve the user specific data in the :type:`memcached_st` structure.
-
-
-------
-RETURN
-------
+:func:`memcached_get_user_data` is used to retrieve the user specific data in
+the :type:`memcached_st` structure.
+RETURN VALUE
+------------
:func:`memcached_set_user_data` returns the previous value of the user specific data.
:func:`memcached_set_user_data` returns the previous value of the user specific data.
-:func:`memcached_get_user_data` returns the current value uf the user specific data.
-
-
+:func:`memcached_get_user_data` returns the current value of the user specific data.
---------
SEE ALSO
--------
.. only:: man
SEE ALSO
--------
.. only:: man
- :manpage:`memcached(1)` :manpage:`libmemcached(3)`
+ :manpage:`memcached(1)`
+ :manpage:`libmemcached(3)`
+
+.. only:: html
+ * :manpage:`memcached(1)`
+ * :doc:`../libmemcached`