Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

memcached_delete (3libmemcached)

Name

memcached_delete - libmemcached Documentation

Synopsis

#include <libmemcached/memcached.h>

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 *group_key,      size_t group_key_length,     const     char *key,
size_t key_length, time_t expiration)

Compile and link with -lmemcached

Description

libmemcached                                   MEMCACHED_DELETE(3libmemcached)



NAME
       memcached_delete - libmemcached Documentation

SYNOPSIS
       #include <libmemcached/memcached.h>

       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 *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.
       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  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 tests for expiration
       in the 1.4 version.

RETURN
       A  value  of  type memcached_return_t is returned On success that value
       will be MEMCACHED_SUCCESS.  Use memcached_strerror() to translate  this
       value to a printable string.

       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: http://libmemcached.org/

AUTHOR
       Brian Aker, <brian@tangent.org>


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+----------------------+
       |ATTRIBUTE TYPE |   ATTRIBUTE VALUE    |
       +---------------+----------------------+
       |Availability   | library/libmemcached |
       +---------------+----------------------+
       |Stability      | Uncommitted          |
       +---------------+----------------------+

SEE ALSO
       memcached(1) libmemcached(3) memcached_strerror(3)

AUTHOR
       Brian Aker

COPYRIGHT
       2011-2013, Brian Aker DataDifferential, http://datadifferential.com/



NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source    was    downloaded     from      https://launchpad.net/libmem-
       cached/1.0/1.0.18/+download/libmemcached-1.0.18.tar.gz.

       Further information about this software can be found on the open source
       community website at http://libmemcached.org/libMemcached.html.



1.0.18                         February 09, 2014
                                               MEMCACHED_DELETE(3libmemcached)