projects
/
m6w6
/
libmemcached
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
|
github
raw
|
inline
| side by side
Update all docs!
[m6w6/libmemcached]
/
docs
/
memcached_callback.rst
diff --git
a/docs/memcached_callback.rst
b/docs/memcached_callback.rst
index a4b4b3d3081548a430ab7583f5bf6dea496edfc0..258fa697ceb3c5157ed31327b8db17fdb7efd328 100644
(file)
--- a/
docs/memcached_callback.rst
+++ b/
docs/memcached_callback.rst
@@
-6,9
+6,9
@@
Setting callbacks
Get and set a callback
Get and set a callback
-*******
+-------
LIBRARY
LIBRARY
-*******
+-------
C Client Library for memcached (libmemcached, -lmemcached)
C Client Library for memcached (libmemcached, -lmemcached)
@@
-18,21
+18,11
@@
C Client Library for memcached (libmemcached, -lmemcached)
SYNOPSIS
--------
SYNOPSIS
--------
-
-
-.. code-block:: perl
-
- #include <libmemcached/memcached.h>
+#include <libmemcached/memcached.h>
- memcached_return_t
- memcached_callback_set (memcached_st *ptr,
- memcached_callback_t flag,
- void *data);
+.. c:function:: memcached_return_t memcached_callback_set (memcached_st *ptr, memcached_callback_t flag, void *data);
- void *
- memcached_callback_get (memcached_st *ptr,
- memcached_callback_t flag,
- memcached_return_t *error);
+.. c:function:: void * memcached_callback_get (memcached_st *ptr, memcached_callback_t flag, memcached_return_t *error);
@@
-55,21
+45,21
@@
You can use MEMCACHED_CALLBACK_USER_DATA to provide custom context if required f
of the callbacks
of the callbacks
-MEMCACHED_CALLBACK_CLEANUP_FUNCTION
+
.. c:var::
MEMCACHED_CALLBACK_CLEANUP_FUNCTION
When memcached_delete() is called this function will be excuted. At the
point of its execution all connections have been closed.
When memcached_delete() is called this function will be excuted. At the
point of its execution all connections have been closed.
-MEMCACHED_CALLBACK_CLONE_FUNCTION
+
.. c:var::
MEMCACHED_CALLBACK_CLONE_FUNCTION
When memcached_delete() is called this function will be excuted. At the
point of its execution all connections have been closed.
When memcached_delete() is called this function will be excuted. At the
point of its execution all connections have been closed.
-MEMCACHED_CALLBACK_PREFIX_KEY
+
.. c:var::
MEMCACHED_CALLBACK_PREFIX_KEY
You can set a value which will be used to create a domain for your keys.
The value specified here will be prefixed to each of your keys. The value can not
You can set a value which will be used to create a domain for your keys.
The value specified here will be prefixed to each of your keys. The value can not
@@
-81,7
+71,7
@@
MEMCACHED_CALLBACK_PREFIX_KEY
If you set a value with the value being NULL then the prefix key is disabled.
If you set a value with the value being NULL then the prefix key is disabled.
-MEMCACHED_CALLBACK_USER_DATA
+
.. c:var::
MEMCACHED_CALLBACK_USER_DATA
This allows you to store a pointer to a specifc piece of data. This can be
retrieved from inside of memcached_fetch_execute(). Cloning a memcached_st
This allows you to store a pointer to a specifc piece of data. This can be
retrieved from inside of memcached_fetch_execute(). Cloning a memcached_st
@@
-89,25
+79,25
@@
MEMCACHED_CALLBACK_USER_DATA
-MEMCACHED_CALLBACK_MALLOC_FUNCTION
+
.. c:var::
MEMCACHED_CALLBACK_MALLOC_FUNCTION
DEPRECATED: use memcached_set_memory_allocators instead.
DEPRECATED: use memcached_set_memory_allocators instead.
-MEMCACHED_CALLBACK_REALLOC_FUNCTION
+
.. c:var::
MEMCACHED_CALLBACK_REALLOC_FUNCTION
DEPRECATED: use memcached_set_memory_allocators instead.
DEPRECATED: use memcached_set_memory_allocators instead.
-MEMCACHED_CALLBACK_FREE_FUNCTION
+
.. c:var::
MEMCACHED_CALLBACK_FREE_FUNCTION
DEPRECATED: use memcached_set_memory_allocators instead.
DEPRECATED: use memcached_set_memory_allocators instead.
-MEMCACHED_CALLBACK_GET_FAILURE
+
.. c:var::
MEMCACHED_CALLBACK_GET_FAILURE
This function implements the read through cache behavior. On failure of retrieval this callback will be called.
You are responsible for populating the result object provided. This result object will then be stored in the server and
This function implements the read through cache behavior. On failure of retrieval this callback will be called.
You are responsible for populating the result object provided. This result object will then be stored in the server and
@@
-121,20
+111,18
@@
MEMCACHED_CALLBACK_GET_FAILURE
-MEMCACHED_CALLBACK_DELETE_TRIGGER
+
.. c:var::
MEMCACHED_CALLBACK_DELETE_TRIGGER
- This function implements a trigger upon successful deletion of a key. The memcached_st structure will need to be cloned
- in order to make use of it.
+This function implements a trigger upon successful deletion of a key. The memcached_st structure will need to be cloned in order to make use of it.
- The prototype for this is:
- typedef memcached_return_t (\*memcached_trigger_delete_key)(memcached_st \*ptr, char \*key, size_t key_length);
+The prototype for this is: typedef memcached_return_t (\*memcached_trigger_delete_key)(memcached_st \*ptr, char \*key, size_t key_length);
-******
+------
RETURN
RETURN
-******
+------
memcached_callback_get() return the function or structure that was provided.
memcached_callback_get() return the function or structure that was provided.
@@
-145,18
+133,18
@@
memcached_callback_set() returns MEMCACHED_SUCCESS upon successful setting,
otherwise MEMCACHED_FAILURE on error.
otherwise MEMCACHED_FAILURE on error.
-****
+----
HOME
HOME
-****
+----
To find out more information please check:
`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
To find out more information please check:
`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
-******
+------
AUTHOR
AUTHOR
-******
+------
Brian Aker, <brian@tangent.org>
Brian Aker, <brian@tangent.org>