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

   1 Disconnecting a client from a server
   2 ====================================
   3
   4 .. index:: object: memcached_st
   5
   6 SYNOPSIS
   7 --------
   8
   9 #include <libmemcached/memcached.h>
  10
  11 .. function:: void memcached_quit (memcached_st *ptr)
  12
  13 Compile and link with -lmemcached
  14
  15 DESCRIPTION
  16 -----------
  17
  18 :func:`memcached_quit` will disconnect you from all currently connected
  19 servers. It will also reset the state of the connection (ie, any :func:`memcached_fetch` you are in the middle of will be terminated). This function is
  20 called automatically when you call :func:`memcached_free` on the :type:`memcached_st` structure.
  21
  22 You do not need to call this on your own. All operations to change server
  23 hashes and parameters will handle connections to the server for you. This
  24 function is provided mainly so that you can timeout your connections or
  25 reset connections during the middle of a :func:`memcached_fetch`.
  26
  27 RETURN
  28 ------
  29
  30 A value of type :type:`memcached_return_t` is returned On success that value
  31 will be `MEMCACHED_SUCCESS`.  Use :func:`memcached_strerror` to
  32 translate this value to a printable string.
  33
  34 SEE ALSO
  35 --------
  36
  37 .. only:: man
  38
  39   :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`