git.m6w6.name Git - awesomized/libmemcached/blob - docs/source/libmemcached/memcached_flush_buffers.rst

   1 =======================
   2 Flushing client buffers
   3 =======================
   4
   5 .. index:: object: memcached_st
   6
   7 Flush and send buffered commands
   8
   9 --------
  10 SYNOPSIS
  11 --------
  12
  13 #include <libmemcached/memcached.h>
  14
  15 .. function:: memcached_return_t memcached_flush_buffers (memcached_st *ptr)
  16
  17 Compile and link with -lmemcached
  18
  19 -----------
  20 DESCRIPTION
  21 -----------
  22
  23 :func:`memcached_flush_buffers` is used in conjunction with
  24 `MEMCACHED_BEHAVIOR_BUFFER_REQUESTS` (see memcached_behavior(3)) to flush all buffers by sending the buffered commands to the server for processing.
  25
  26 ------
  27 RETURN
  28 ------
  29
  30 A value of type :type:`memcached_return_t` is returned
  31 On success that value will be `MEMCACHED_SUCCESS`.
  32 Use :func:`memcached_strerror` to translate this value to a printable
  33 string.
  34
  35 --------
  36 SEE ALSO
  37 --------
  38
  39 .. only:: man
  40
  41   :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`