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 :c:func:`memcached_quit()` will disconnect you from all currently connected
  23 servers. It will also reset the state of the connection (ie, any :c:func:`memcached_fetch()` you are in the middle of will be terminated). This function is
  24 called automatically when you call :c:func:`memcached_free()` on the :c:type:`memcached_st` structure.
  25
  26 You do not need to call this on your own. All operations to change server
  27 hashes and parameters will handle connections to the server for you. This
  28 function is provided mainly so that you can timeout your connections or
  29 reset connections during the middle of a :c:func:`memcached_fetch()`.
  30
  31
  32 ------
  33 RETURN
  34 ------
  35
  36
  37 A value of type :c:type:`memcached_return` is returned
  38 On success that value will be :c:type:`MEMCACHED_SUCCESS`.
  39 Use :c:func:`memcached_strerror()` to translate this value to a printable string.
  40
  41
  42 ----
  43 HOME
  44 ----
  45
  46
  47 To find out more information please check:
  48 `http://libmemcached.org/ <http://libmemcached.org/>`_
  49
  50
  51 ------
  52 AUTHOR
  53 ------
  54
  55
  56 Brian Aker, <brian@tangent.org>
  57
  58
  59 --------
  60 SEE ALSO
  61 --------
  62
  63 :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`