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

   1 .TH "MEMCACHED_QUIT" "3" "October 24, 2011" "1.01" "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 .SH SYNOPSIS
  34 .sp
  35 #include <libmemcached/memcached.h>
  36 .INDENT 0.0
  37 .TP
  38 .B void memcached_quit (memcached_st *ptr);
  39 .UNINDENT
  40 .sp
  41 Compile and link with \-lmemcached
  42 .SH DESCRIPTION
  43 .sp
  44 \fBmemcached_quit()\fP will disconnect you from all currently connected
  45 servers. It will also reset the state of the connection (ie, any \fBmemcached_fetch()\fP you are in the middle of will be terminated). This function is
  46 called automatically when you call \fBmemcached_free()\fP on the \fBmemcached_st\fP structure.
  47 .sp
  48 You do not need to call this on your own. All operations to change server
  49 hashes and parameters will handle connections to the server for you. This
  50 function is provided mainly so that you can timeout your connections or
  51 reset connections during the middle of a \fBmemcached_fetch()\fP.
  52 .SH RETURN
  53 .sp
  54 A value of type \fBmemcached_return\fP is returned
  55 On success that value will be \fBMEMCACHED_SUCCESS\fP.
  56 Use \fBmemcached_strerror()\fP to translate this value to a printable string.
  57 .SH HOME
  58 .sp
  59 To find out more information please check:
  60 \fI\%http://libmemcached.org/\fP
  61 .SH AUTHOR
  62 .sp
  63 Brian Aker, <\fI\%brian@tangent.org\fP>
  64 .SH SEE ALSO
  65 .sp
  66 \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
  67 .SH AUTHOR
  68 Brian Aker
  69 .SH COPYRIGHT
  70 2011, Brian Aker DataDifferential, http://datadifferential.com/
  71 .\" Generated by docutils manpage writer.
  72 .\"
  73 .