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

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