git.m6w6.name Git - m6w6/libmemcached/blob - docs/memcached_quit.rst

   1 ====================================
   2 Disconnecting a client from a server
   3 ====================================
   4
   5 .. index:: object: memcached_st
   6
   7 --------
   8 SYNOPSIS
   9 --------
  10
  11 #include <libmemcached/memcached.h>
  12
  13 .. c:function:: void memcached_quit (memcached_st *ptr);
  14
  15 Compile and link with -lmemcached
  16
  17 -----------
  18 DESCRIPTION
  19 -----------
  20
  21
  22 memcached_quit() will disconnect you from all currently connected servers.
  23 It will also reset the state of the connection (ie, any memcached_fetch() you
  24 are in the middle of will be terminated). This function is called
  25 automatically when you call memcached_free() on the \ ``memcached_st``\  structure.
  26
  27 You do not need to call this on your own. All operations to change server
  28 hashes and parameters will handle connections to the server for you. This
  29 function is provided mainly so that you can timeout your connections or
  30 reset connections during the middle of a memcached_fetch().
  31
  32
  33 ------
  34 RETURN
  35 ------
  36
  37
  38 A value of type \ ``memcached_return``\  is returned
  39 On success that value will be \ ``MEMCACHED_SUCCESS``\ .
  40 Use memcached_strerror() to translate this value to a printable string.
  41
  42
  43 ----
  44 HOME
  45 ----
  46
  47
  48 To find out more information please check:
  49 `http://libmemcached.org/ <http://libmemcached.org/>`_
  50
  51
  52 ------
  53 AUTHOR
  54 ------
  55
  56
  57 Brian Aker, <brian@tangent.org>
  58
  59
  60 --------
  61 SEE ALSO
  62 --------
  63
  64 :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`