git.m6w6.name Git - m6w6/libmemcached/blob - docs/man/memcached_quit.3

   1 .TH "MEMCACHED_QUIT" "3" "April 09, 2011" "0.47" "libmemcached"
   2 .SH NAME
   3 memcached_quit \- libmemcached Documentation
   4 .
   5 .nr rst2man-indent-level 0
   6 .
   7 .de1 rstReportMargin
   8 \\$1 \\n[an-margin]
   9 level \\n[rst2man-indent-level]
  10 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  11 -
  12 \\n[rst2man-indent0]
  13 \\n[rst2man-indent1]
  14 \\n[rst2man-indent2]
  15 ..
  16 .de1 INDENT
  17 .\" .rstReportMargin pre:
  18 . RS \\$1
  19 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  20 . nr rst2man-indent-level +1
  21 .\" .rstReportMargin post:
  22 ..
  23 .de UNINDENT
  24 . RE
  25 .\" indent \\n[an-margin]
  26 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  27 .nr rst2man-indent-level -1
  28 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  29 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  30 ..
  31 .\" Man page generated from reStructeredText.
  32 .
  33 .sp
  34 Disconnect from all servers
  35 .SH LIBRARY
  36 .sp
  37 C Client Library for memcached (libmemcached, \-lmemcached)
  38 .SH SYNOPSIS
  39 .sp
  40 .nf
  41 .ft C
  42 #include <libmemcached/memcached.h>
  43
  44 void memcached_quit (memcached_st *ptr);
  45 .ft P
  46 .fi
  47 .SH DESCRIPTION
  48 .sp
  49 memcached_quit() will disconnect you from all currently connected servers.
  50 It will also reset the state of the connection (ie, any memcached_fetch() you
  51 are in the middle of will be terminated). This function is called
  52 automatically when you call memcached_free() on the \fBmemcached_st\fP structure.
  53 .sp
  54 You do not need to call this on your own. All operations to change server
  55 hashes and parameters will handle connections to the server for you. This
  56 function is provided mainly so that you can timeout your connections or
  57 reset connections during the middle of a memcached_fetch().
  58 .SH RETURN
  59 .sp
  60 A value of type \fBmemcached_return\fP is returned
  61 On success that value will be \fBMEMCACHED_SUCCESS\fP.
  62 Use memcached_strerror() to translate this value to a printable string.
  63 .SH HOME
  64 .sp
  65 To find out more information please check:
  66 \fI\%https://launchpad.net/libmemcached\fP
  67 .SH AUTHOR
  68 .sp
  69 Brian Aker, <\fI\%brian@tangent.org\fP>
  70 .SH SEE ALSO
  71 .sp
  72 \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
  73 .SH AUTHOR
  74 Brian Aker
  75 .SH COPYRIGHT
  76 2011, Brian Aker DataDifferential, http://datadifferential.com/
  77 .\" Generated by docutils manpage writer.
  78 .\"
  79 .