...

...

@@ -1,6 +1,5 @@

1

1

<?xml version="1.0" encoding="utf-8"?>

2

2

<!-- $Revision$ -->

3

-

4

3

<refentry xml:id="memcached.delete" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">

5

4

<refnamediv>

6

5

<refname>Memcached::delete</refname>

...

...

@@ -9,25 +8,13 @@

9

8

10

9

<refsect1 role="description">

11

10

&reftitle.description;

12

-

<methodsynopsis>

11

+

<methodsynopsis role="Memcached">

13

12

<modifier>public</modifier> <type>bool</type><methodname>Memcached::delete</methodname>

14

13

<methodparam><type>string</type><parameter>key</parameter></methodparam>

15

14

<methodparam choice="opt"><type>int</type><parameter>time</parameter><initializer>0</initializer></methodparam>

16

15

</methodsynopsis>

17

16

<para>

18

-

<function>Memcached::delete</function> deletes the

19

-

<parameter>key</parameter> from the server. The <parameter>time</parameter>

20

-

parameter is the amount of time in seconds (or Unix time until which) the

21

-

client wishes the server to refuse <literal>add</literal> and

22

-

<literal>replace</literal> commands for this key. For this amount of time,

23

-

the item is put into a delete queue, which means that it won't possible to

24

-

retrieve it by the <literal>get</literal> command, but

25

-

<literal>add</literal> and <literal>replace</literal> command with this key

26

-

will also fail (the <literal>set</literal> command will succeed, however).

27

-

After the time passes, the item is finally deleted from server memory. The

28

-

parameter <parameter>time</parameter> defaults to 0 (which means that the

29

-

item will be deleted immediately and further storage commands with this key

30

-

will succeed).

17

+

Delete the <parameter>key</parameter> from the server.

31

18

</para>

32

19

</refsect1>

33

20

...

...

@@ -49,6 +36,7 @@

49

36

<para>

50

37

The amount of time the server will wait to delete the item.

51

38

</para>

39

+

&memcached.note.delete-time;

52

40

</listitem>

53

41

</varlistentry>

54

42

</variablelist>

...

...

@@ -94,7 +82,6 @@ $m->delete('key1');

94

82

</refsect1>

95

83

96

84

</refentry>

97

-

98

85

<!-- Keep this comment at the end of the file

99

86

Local variables:

100

87

mode: sgml

101

88