X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_delete.pod;h=e104eab560a0062c6efece63858b1bb5b55b28af;hb=5ba395ad3a28f000bdabc7312dcee483c14d996e;hp=41a55df976d6e08101ba444633027ef1946d015e;hpb=24342b1919b6aaa26c33aae50974b449f95a737a;p=m6w6%2Flibmemcached diff --git a/docs/memcached_delete.pod b/docs/memcached_delete.pod index 41a55df9..e104eab5 100644 --- a/docs/memcached_delete.pod +++ b/docs/memcached_delete.pod @@ -1,6 +1,6 @@ =head1 NAME -memcached_delete +memcached_delete - Delete a key =head1 LIBRARY @@ -10,12 +10,12 @@ C Client Library for memcached (libmemcached, -lmemcached) #include - memcached_return + memcached_return_t memcached_delete (memcached_st *ptr, const char *key, size_t key_length, time_t expiration); - memcached_return + memcached_return_t memcached_delete_by_key (memcached_st *ptr, const char *master_key, size_t master_key_length, const char *key, size_t key_length, @@ -23,14 +23,21 @@ C Client Library for memcached (libmemcached, -lmemcached) =head1 DESCRIPTION -memcached_delete() is used to delete a particular key. An expiration value -can be applied so that the key is deleted after that many seconds. -memcached_delete_by_key() works the same, but it takes a master key to +memcached_delete() is used to delete a particular key. +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 possible to retrieve it by the "get" command, but "add" and +"replace" command 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 Danga memcached server removed support for expiration in +the 1.4 version. + =head1 RETURN -A value of type C is returned +A value of type C is returned On success that value will be C. Use memcached_strerror() to translate this value to a printable string. @@ -40,7 +47,7 @@ means that the message was queued for delivery. =head1 HOME To find out more information please check: -L +L =head1 AUTHOR