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

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