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

   1 =head1 NAME
   2
   3 memcached_quit
   4
   5 =head1 LIBRARY
   6
   7 C Client Library for memcached (libmemcached, -lmemcached)
   8
   9 =head1 SYNOPSIS
  10
  11 #include <memcached.h>
  12 void memcached_quit(memcached_st *ptr);
  13
  14 =head1 DESCRIPTION
  15
  16
  17 memcached_quit() will disconnect you from all currently connected servers.
  18 It will also reset the state of the connection (aka any memcached_fetch you
  19 are in the middle of will be terminated). This function is called
  20 automatically when you call memcached_free() on the 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 memcached_fetch().
  26
  27 =head1 RETURN
  28
  29 memcached_quit() returns memcached_return. The value on success will be MEMCACHED_SUCCESS. For all errors check with memcached_strerror().
  30
  31 =head1 HOME
  32
  33 To find out more information please check: http://tangent.org/552/libmemcached.html
  34
  35 =head1 AUTHOR
  36
  37 Brian Aker, brian@tangent.org
  38
  39 =head1 SEE ALSO
  40
  41 memcached(1) libmemcached(3) memcached_strerror(3)
  42
  43 =cut
  44