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

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