← Back to branch summary

~brianaker/libmemcached/1164440

« back to all changes in this revision

Viewing changes to docs/memcached_delete.rst

  • Committer: Continuous Integration
  • Date: 2012-03-14 16:53:36 UTC
  • mfrom: (990.2.1 workspace)
  • Revision ID: ci@tangent.org-20120314165336-mjrg2hwmb6sx1er2
jenkins-promote-staging-trunk-libmemcached-3

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/memcached_delete.rst
 
1
===========================
 
2
Deleting data from a server
 
3
===========================
 
4
 
 
5
.. index:: object: memcached_st
 
6
 
 
7
--------
 
8
SYNOPSIS
 
9
--------
 
10
 
 
11
 
 
12
#include <libmemcached/memcached.h>
 
13
 
 
14
.. c:function:: memcached_return_t memcached_delete (memcached_st *ptr, const char *key, size_t key_length, time_t expiration)
 
15
 
 
16
.. c: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)
 
17
 
 
18
Compile and link with -lmemcached
 
19
 
 
20
-----------
 
21
DESCRIPTION
 
22
-----------
 
23
 
 
24
 
 
25
:c:func:`memcached_delete` is used to delete a particular key. 
 
26
:c:func:`memcached_delete_by_key` works the same, but it takes a master key 
 
27
to find the given value.
 
28
 
 
29
Expiration works by placing the item into a delete queue, which means that
 
30
it won't be possible to retrieve it by the "get" command. The "add" and 
 
31
"replace" commands with this key will also fail (the "set" command will 
 
32
succeed, however). After the time passes, the item is finally deleted from server memory.
 
33
 
 
34
Please note the the Danga memcached server removed tests for expiration in
 
35
the 1.4 version.
 
36
 
 
37
 
 
38
------
 
39
RETURN
 
40
------
 
41
 
 
42
 
 
43
A value of type :c:type:`memcached_return_t` is returned
 
44
On success that value will be :c:type:`MEMCACHED_SUCCESS`.
 
45
Use :c:func:`memcached_strerror` to translate this value to a printable 
 
46
string.
 
47
 
 
48
If you are using the non-blocking mode of the library, success only
 
49
means that the message was queued for delivery.
 
50
 
 
51
 
 
52
----
 
53
HOME
 
54
----
 
55
 
 
56
 
 
57
To find out more information please check:
 
58
`http://libmemcached.org/ <http://libmemcached.org/>`_
 
59
 
 
60
 
 
61
------
 
62
AUTHOR
 
63
------
 
64
 
 
65
 
 
66
Brian Aker, <brian@tangent.org>
 
67
 
 
68
 
 
69
--------
 
70
SEE ALSO
 
71
--------
 
72
 
 
73
:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`