X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_delete.rst;h=f628f69e96a68e887f15bc4880c8961aacb15a8d;hb=088eed04d829b8cf6591201564118c356d3cf935;hp=9d9d77840ba019d0efc908aa37e32855a7ddecbb;hpb=f0a568f40ab283bb0be08bd0d930c70386418b97;p=m6w6%2Flibmemcached diff --git a/docs/memcached_delete.rst b/docs/memcached_delete.rst index 9d9d7784..f628f69e 100644 --- a/docs/memcached_delete.rst +++ b/docs/memcached_delete.rst @@ -1,47 +1,23 @@ -.. highlight:: perl +=========================== +Deleting data from a server +=========================== - -memcached_delete -**************** - - -Delete a key - - -******* -LIBRARY -******* - - -C Client Library for memcached (libmemcached, -lmemcached) - - -******** +-------- SYNOPSIS -******** - - +-------- -.. code-block:: perl - #include +#include - memcached_return_t - memcached_delete (memcached_st *ptr, - 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); +.. c:function:: memcached_return_t memcached_delete (memcached_st *ptr, const char *key, size_t key_length, time_t expiration); +.. 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); +Compile and link with -lmemcached -*********** +----------- DESCRIPTION -*********** +----------- memcached_delete() is used to delete a particular key. @@ -49,17 +25,17 @@ 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 +it won't be possible to retrieve it by the "get" command. The "add" and +"replace" commands 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 +Please note the the Danga memcached server removed tests for expiration in the 1.4 version. -****** +------ RETURN -****** +------ A value of type \ ``memcached_return_t``\ is returned @@ -70,27 +46,25 @@ If you are using the non-blocking mode of the library, success only means that the message was queued for delivery. -**** +---- HOME -**** +---- To find out more information please check: -`https://launchpad.net/libmemcached `_ +`http://libmemcached.org/ `_ -****** +------ AUTHOR -****** +------ Brian Aker, -******** +-------- SEE ALSO -******** - - -memcached(1) libmemcached(3) memcached_strerror(3) +-------- +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`