git.m6w6.name Git - m6w6/libmemcached/blob - docs/memcached_flush.pod

   1 =head1 NAME
   2
   3 memcached_flush
   4
   5 =head1 LIBRARY
   6
   7 C Client Library for memcached (libmemcached, -lmemcached)
   8
   9 =head1 SYNOPSIS
  10
  11 #include <memcached.h>
  12 memcached_return memcached_flush(memcached_st *ptr, time_t expiration);
  13
  14 =head1 DESCRIPTION
  15
  16
  17 memcached_flush() is used to wipe clean the contents of memcached servers.
  18 It will either do this immediatly or expire the content based on the
  19 expiration time passed to the method (a value of zero causes an immediate
  20 flush). The operation is not atomic to multiple servers, just atomic to a
  21 single server. Aka it will flush the servers in the order that they were
  22 added.
  23
  24 =head1 RETURN
  25
  26 memcached_flush() returns memcached_return. The value on success will be MEMCACHED_SUCCESS. For all errors check with memcached_strerror().
  27
  28 =head1 HOME
  29
  30 To find out more information please check: http://tangent.org/552/libmemcached.html
  31
  32 =head1 AUTHOR
  33
  34 Brian Aker, brian@tangent.org
  35
  36 =head1 SEE ALSO
  37
  38 memcached(1) libmemcached(3) memcached_strerror(3)
  39
  40 =cut
  41