docs: sanitize

[awesomized/libmemcached] / docs / source / libmemcached / memcached_delete.rst

diff --git a/docs/source/libmemcached/memcached_delete.rst b/docs/source/libmemcached/memcached_delete.rst
new file mode 100644 (file)
index 0000000..8c67e15
--- /dev/null
+++ b/docs/source/libmemcached/memcached_delete.rst
@@ -0,0 +1,59 @@
+===========================
+Deleting data from a server
+===========================
+
+.. index:: object: memcached_st
+
+--------
+SYNOPSIS
+--------
+
+
+#include <libmemcached/memcached.h>
+ 
+.. function:: memcached_return_t memcached_delete (memcached_st *ptr, const char *key, size_t key_length, time_t expiration)
+
+.. function:: memcached_return_t memcached_delete_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, time_t expiration)
+
+Compile and link with -lmemcached
+
+-----------
+DESCRIPTION
+-----------
+
+
+:func:`memcached_delete` is used to delete a particular key. 
+:func:`memcached_delete_by_key` works the same, but it takes a master key 
+to find the given value.
+
+Expiration works by placing the item into a delete queue, which means that
+it won't be possible to retrieve it by the "get" command. The "add" and 
+"replace" commands with this key will also fail (the "set" command will 
+succeed, however). After the time passes, the item is finally deleted from server memory.
+
+Please note the the memcached server removed tests for expiration in
+the 1.4 version.
+
+
+------
+RETURN
+------
+
+
+A value of type :type:`memcached_return_t` is returned
+On success that value will be `MEMCACHED_SUCCESS`.
+Use :func:`memcached_strerror` to translate this value to a printable 
+string.
+
+If you are using the non-blocking mode of the library, success only
+means that the message was queued for delivery.
+
+
+
+--------
+SEE ALSO
+--------
+
+.. only:: man
+
+  :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`