git.m6w6.name Git - m6w6/libmemcached/blob - libmemcached/memcached_quit.html

   1
   2
   3 <!DOCTYPE html>
   4 <html class="writer-html5" lang="en" >
   5 <head>
   6   <meta charset="utf-8">
   7
   8   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   9
  10   <title>Disconnecting a client from a server &mdash; libmemcached 1.0.99 documentation</title>
  11
  12
  13
  14   <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  15   <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  16
  17
  18
  19
  20
  21
  22
  23   <!--[if lt IE 9]>
  24     <script src="../_static/js/html5shiv.min.js"></script>
  25   <![endif]-->
  26
  27
  28       <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
  29         <script src="../_static/jquery.js"></script>
  30         <script src="../_static/underscore.js"></script>
  31         <script src="../_static/doctools.js"></script>
  32         <script src="../_static/language_data.js"></script>
  33
  34     <script type="text/javascript" src="../_static/js/theme.js"></script>
  35
  36
  37     <link rel="index" title="Index" href="../genindex.html" />
  38     <link rel="search" title="Search" href="../search.html" />
  39     <link rel="copyright" title="Copyright" href="../copyright.html" />
  40     <link rel="next" title="Working with Data" href="index_data.html" />
  41     <link rel="prev" title="Deleting data from a server" href="memcached_delete.html" />
  42 </head>
  43
  44 <body class="wy-body-for-nav">
  45
  46
  47   <div class="wy-grid-for-nav">
  48
  49     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  50       <div class="wy-side-scroll">
  51         <div class="wy-side-nav-search" >
  52
  53
  54
  55             <a href="../index.html" class="icon icon-home" alt="Documentation Home"> libmemcached
  56
  57
  58
  59           </a>
  60
  61
  62
  63
  64               <div class="version">
  65                 1.0
  66               </div>
  67
  68
  69
  70
  71 <div role="search">
  72   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
  73     <input type="text" name="q" placeholder="Search docs" />
  74     <input type="hidden" name="check_keywords" value="yes" />
  75     <input type="hidden" name="area" value="default" />
  76   </form>
  77 </div>
  78
  79
  80         </div>
  81
  82
  83         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  84
  85
  86
  87
  88
  89
  90               <p class="caption"><span class="caption-text">libmemcached</span></p>
  91 <ul class="current">
  92 <li class="toctree-l1"><a class="reference internal" href="../libmemcached.html">Introduction</a></li>
  93 <li class="toctree-l1 current"><a class="reference internal" href="index.html">libmemcached API</a><ul class="current">
  94 <li class="toctree-l2 current"><a class="reference internal" href="index_basics.html">Basics</a><ul class="current">
  95 <li class="toctree-l3"><a class="reference internal" href="memcached_create.html">Creating and destroying a memcached_st</a></li>
  96 <li class="toctree-l3"><a class="reference internal" href="memcached_get.html">Retrieving data from the server</a></li>
  97 <li class="toctree-l3"><a class="reference internal" href="memcached_set.html">Storing data on the server</a></li>
  98 <li class="toctree-l3"><a class="reference internal" href="memcached_delete.html">Deleting data from a server</a></li>
  99 <li class="toctree-l3 current"><a class="current reference internal" href="#">Disconnecting a client from a server</a></li>
 100 </ul>
 101 </li>
 102 <li class="toctree-l2"><a class="reference internal" href="index_data.html">Working with Data</a></li>
 103 <li class="toctree-l2"><a class="reference internal" href="index_errors.html">Messages and Errors</a></li>
 104 <li class="toctree-l2"><a class="reference internal" href="index_advanced.html">Advanced Topics</a></li>
 105 <li class="toctree-l2"><a class="reference internal" href="index_deprecated.html">Deprecated Functionality</a></li>
 106 </ul>
 107 </li>
 108 <li class="toctree-l1"><a class="reference internal" href="index_misc.html">Misc</a></li>
 109 </ul>
 110 <p class="caption"><span class="caption-text">libmemcachedutil</span></p>
 111 <ul>
 112 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil.html">Introduction</a></li>
 113 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
 114 </ul>
 115 <p class="caption"><span class="caption-text">libhashkit</span></p>
 116 <ul>
 117 <li class="toctree-l1"><a class="reference internal" href="../libhashkit.html">Introduction</a></li>
 118 <li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a></li>
 119 </ul>
 120 <p class="caption"><span class="caption-text">Client Applications</span></p>
 121 <ul>
 122 <li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a></li>
 123 </ul>
 124 <p class="caption"><span class="caption-text">Copyright</span></p>
 125 <ul>
 126 <li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
 127 </ul>
 128
 129
 130
 131         </div>
 132
 133       </div>
 134     </nav>
 135
 136     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 137
 138
 139       <nav class="wy-nav-top" aria-label="top navigation">
 140
 141           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 142           <a href="../index.html">libmemcached</a>
 143
 144       </nav>
 145
 146
 147       <div class="wy-nav-content">
 148
 149         <div class="rst-content">
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167 <div role="navigation" aria-label="breadcrumbs navigation">
 168
 169   <ul class="wy-breadcrumbs">
 170
 171       <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
 172
 173           <li><a href="index.html">libmemcached API</a> &raquo;</li>
 174
 175           <li><a href="index_basics.html">Basics</a> &raquo;</li>
 176
 177       <li>Disconnecting a client from a server</li>
 178
 179
 180       <li class="wy-breadcrumbs-aside">
 181
 182
 183
 184       </li>
 185
 186   </ul>
 187
 188
 189   <hr/>
 190 </div>
 191           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 192            <div itemprop="articleBody">
 193
 194   <div class="section" id="disconnecting-a-client-from-a-server">
 195 <h1>Disconnecting a client from a server<a class="headerlink" href="#disconnecting-a-client-from-a-server" title="Permalink to this headline">¶</a></h1>
 196 <div class="section" id="synopsis">
 197 <span id="index-0"></span><h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
 198 <dl class="simple">
 199 <dt>#include &lt;libmemcached/memcached.h&gt;</dt><dd><p>Compile and link with -lmemcached</p>
 200 </dd>
 201 </dl>
 202 <dl class="cpp function">
 203 <dt id="_CPPv414memcached_quitP12memcached_st">
 204 <span id="_CPPv314memcached_quitP12memcached_st"></span><span id="_CPPv214memcached_quitP12memcached_st"></span><span id="memcached_quit__memcached_stP"></span>void <code class="sig-name descname">memcached_quit</code><span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<em>ptr</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv414memcached_quitP12memcached_st" title="Permalink to this definition">¶</a><br /></dt>
 205 <dd><dl class="field-list simple">
 206 <dt class="field-odd">Parameters</dt>
 207 <dd class="field-odd"><p><strong>ptr</strong> -- pointer to initialized <a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_st</span></code></a> struct</p>
 208 </dd>
 209 </dl>
 210 </dd></dl>
 211
 212 </div>
 213 <div class="section" id="description">
 214 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
 215 <p><a class="reference internal" href="#_CPPv414memcached_quitP12memcached_st" title="memcached_quit"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_quit()</span></code></a> will disconnect you from all currently connected
 216 servers. It will also reset the state of the connection (i.e., any
 217 <a class="reference internal" href="memcached_fetch.html#_CPPv415memcached_fetchP12memcached_stPcP6size_tP6size_tP8uint32_tP18memcached_return_t" title="memcached_fetch"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_fetch()</span></code></a> you are in the middle of will be terminated). This
 218 function is called automatically when you call <a class="reference internal" href="memcached_create.html#_CPPv414memcached_freeP12memcached_st" title="memcached_free"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_free()</span></code></a> on the
 219 <a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_st</span></code></a> structure.</p>
 220 <p>You do not need to call this on your own. All operations to change server
 221 hashes and parameters will handle connections to the server for you. This
 222 function is provided mainly so that you can timeout your connections or
 223 reset connections during the middle of a <a class="reference internal" href="memcached_fetch.html#_CPPv415memcached_fetchP12memcached_stPcP6size_tP6size_tP8uint32_tP18memcached_return_t" title="memcached_fetch"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_fetch()</span></code></a>.</p>
 224 </div>
 225 <div class="section" id="return-value">
 226 <h2>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
 227 <p>A value of type <a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_return_t</span></code></a> is returned On success that value
 228 will be <a class="reference internal" href="memcached_return_t.html#_CPPv4N18memcached_return_t17MEMCACHED_SUCCESSE" title="MEMCACHED_SUCCESS"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_SUCCESS</span></code></a>.  Use <a class="reference internal" href="memcached_strerror.html#_CPPv418memcached_strerrorP12memcached_st18memcached_return_t" title="memcached_strerror"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_strerror()</span></code></a> to
 229 translate this value to a printable string.</p>
 230 </div>
 231 <div class="section" id="see-also">
 232 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
 233 <ul class="simple">
 234 <li><p><em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/1/memcached">memcached(1)</a></em></p></li>
 235 <li><p><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></p></li>
 236 <li><p><a class="reference internal" href="memcached_strerror.html"><span class="doc">Converting Error Codes to Messages</span></a></p></li>
 237 </ul>
 238 </div>
 239 </div>
 240
 241
 242            </div>
 243
 244           </div>
 245           <footer>
 246
 247     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 248
 249         <a href="index_data.html" class="btn btn-neutral float-right" title="Working with Data" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 250
 251
 252         <a href="memcached_delete.html" class="btn btn-neutral float-left" title="Deleting data from a server" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 253
 254     </div>
 255
 256
 257   <hr/>
 258
 259   <div role="contentinfo">
 260     <p>
 261
 262
 263         &copy; <a href="../copyright.html">Copyright</a>
 264
 265     </p>
 266   </div>
 267
 268
 269
 270     Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
 271
 272     <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
 273
 274     provided by <a href="https://readthedocs.org">Read the Docs</a>.
 275
 276 </footer>
 277
 278         </div>
 279       </div>
 280
 281     </section>
 282
 283   </div>
 284
 285
 286   <script type="text/javascript">
 287       jQuery(function () {
 288           SphinxRtdTheme.Navigation.enable(true);
 289       });
 290   </script>
 291
 292
 293
 294
 295
 296
 297 </body>
 298 </html>