X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_delete.pod;h=e104eab560a0062c6efece63858b1bb5b55b28af;hb=b175c6025c67cb8fa756750d53fb96fd888076de;hp=4a4c76e562572a75555ffa35e6bb41df8598a505;hpb=4c8d96d66ed97bf25db6afbd14abfbeb42661371;p=m6w6%2Flibmemcached diff --git a/docs/memcached_delete.pod b/docs/memcached_delete.pod index 4a4c76e5..e104eab5 100644 --- a/docs/memcached_delete.pod +++ b/docs/memcached_delete.pod @@ -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,18 +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, but this -will only work if you are using a 1.2.x server. If you are using a 1.2.x -server and you want to use the expiration value, please call memcached_version -one time for the memcached_st instance. If you don't do this no-reply and -buffered mode will be disabled to avoid getting out of sync with the server. +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. @@ -44,7 +47,7 @@ means that the message was queued for delivery. =head1 HOME To find out more information please check: -L +L =head1 AUTHOR