X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_delete.pod;h=89bff56a28bb05cf97b08a1e7403a8f384b333e9;hb=c67da677fe0944d3d2d3ff46e65fc3bc775404ae;hp=82e25f21235e32c69073c210814fde0e601a939c;hpb=7d9255c986d5e9a395bd510ca7b01519736f33e1;p=awesomized%2Flibmemcached diff --git a/docs/memcached_delete.pod b/docs/memcached_delete.pod old mode 100755 new mode 100644 index 82e25f21..89bff56a --- 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,19 +10,31 @@ C Client Library for memcached (libmemcached, -lmemcached) #include - memcached_return + memcached_return_t memcached_delete (memcached_st *ptr, - char *key, size_t key_length, + const char *key, size_t key_length, time_t expiration); + 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, + time_t expiration); + =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. +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_by_key() works the same, but it takes a master key to +find the given value. =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. @@ -32,7 +44,7 @@ means that the message was queued for delivery. =head1 HOME To find out more information please check: -L +L =head1 AUTHOR