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]-->
9 <meta name=
"viewport" content=
"width=device-width, initial-scale=1.0">
11 <title>Disconnecting a client from a server
— libmemcached
1.0.99 documentation
</title>
20 <script type=
"text/javascript" src=
"../_static/js/modernizr.min.js"></script>
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>
29 <script type=
"text/javascript" src=
"../_static/js/theme.js"></script>
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" />
43 <body class=
"wy-body-for-nav">
46 <div class=
"wy-grid-for-nav">
48 <nav data-toggle=
"wy-nav-shift" class=
"wy-nav-side">
49 <div class=
"wy-side-scroll">
50 <div class=
"wy-side-nav-search" >
54 <a href=
"../index.html" class=
"icon icon-home"> libmemcached
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" />
81 <div class=
"wy-menu wy-menu-vertical" data-spy=
"affix" role=
"navigation" aria-label=
"main navigation">
88 <p class=
"caption"><span class=
"caption-text">libmemcached
</span></p>
90 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcached.html">Introduction
</a></li>
91 <li class=
"toctree-l1 current"><a class=
"reference internal" href=
"index.html">libmemcached API
</a><ul class=
"current">
92 <li class=
"toctree-l2 current"><a class=
"reference internal" href=
"index_basics.html">Basics
</a><ul class=
"current">
93 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_create.html">Creating and destroying a memcached_st
</a></li>
94 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_get.html">Retrieving data from the server
</a></li>
95 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_set.html">Storing data on the server
</a></li>
96 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_delete.html">Deleting data from a server
</a></li>
97 <li class=
"toctree-l3 current"><a class=
"current reference internal" href=
"#">Disconnecting a client from a server
</a></li>
100 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_data.html">Working with Data
</a></li>
101 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_errors.html">Messages and Errors
</a></li>
102 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_advanced.html">Advanced Topics
</a></li>
103 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_deprecated.html">Deprecated Functionality
</a></li>
106 <li class=
"toctree-l1"><a class=
"reference internal" href=
"index_misc.html">Misc
</a></li>
108 <p class=
"caption"><span class=
"caption-text">libmemcachedutil
</span></p>
110 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcachedutil.html">Introduction
</a></li>
111 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcachedutil/index.html">libmemcachedutil API
</a></li>
113 <p class=
"caption"><span class=
"caption-text">libhashkit
</span></p>
115 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libhashkit.html">Introduction
</a></li>
116 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libhashkit/index.html">libhashkit API
</a></li>
118 <p class=
"caption"><span class=
"caption-text">Client Applications
</span></p>
120 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../bin/index.html">Client Applications
</a></li>
122 <p class=
"caption"><span class=
"caption-text">Copyright
</span></p>
124 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../copyright.html">Copyright
</a></li>
133 <section data-toggle=
"wy-nav-shift" class=
"wy-nav-content-wrap">
136 <nav class=
"wy-nav-top" aria-label=
"top navigation">
138 <i data-toggle=
"wy-nav-top" class=
"fa fa-bars"></i>
139 <a href=
"../index.html">libmemcached
</a>
144 <div class=
"wy-nav-content">
146 <div class=
"rst-content">
164 <div role=
"navigation" aria-label=
"breadcrumbs navigation">
166 <ul class=
"wy-breadcrumbs">
168 <li><a href=
"../index.html">Docs
</a> »</li>
170 <li><a href=
"index.html">libmemcached API
</a> »</li>
172 <li><a href=
"index_basics.html">Basics
</a> »</li>
174 <li>Disconnecting a client from a server
</li>
177 <li class=
"wy-breadcrumbs-aside">
188 <div role=
"main" class=
"document" itemscope=
"itemscope" itemtype=
"http://schema.org/Article">
189 <div itemprop=
"articleBody">
191 <div class=
"section" id=
"disconnecting-a-client-from-a-server">
192 <h1>Disconnecting a client from a server
<a class=
"headerlink" href=
"#disconnecting-a-client-from-a-server" title=
"Permalink to this headline">¶
</a></h1>
193 <div class=
"section" id=
"synopsis">
194 <span id=
"index-0"></span><h2>SYNOPSIS
<a class=
"headerlink" href=
"#synopsis" title=
"Permalink to this headline">¶
</a></h2>
195 <dl class=
"docutils">
196 <dt>#include
<libmemcached/memcached.h
></dt>
197 <dd>Compile and link with -lmemcached
</dd>
199 <dl class=
"function">
200 <dt id=
"_CPPv414memcached_quitP12memcached_st">
201 <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>
202 <dd><table class=
"docutils field-list" frame=
"void" rules=
"none">
203 <col class=
"field-name" />
204 <col class=
"field-body" />
206 <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>
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>
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>
231 <div class=
"section" id=
"see-also">
232 <h2>SEE ALSO
<a class=
"headerlink" href=
"#see-also" title=
"Permalink to this headline">¶
</a></h2>
234 <li><em class=
"manpage"><a class=
"manpage reference external" href=
"https://linux.die.net/man/1/memcached">memcached(
1)
</a></em></li>
235 <li><a class=
"reference internal" href=
"../libmemcached.html"><span class=
"doc">C/C++ Client Library for memcached
</span></a></li>
236 <li><a class=
"reference internal" href=
"memcached_strerror.html"><span class=
"doc">Converting Error Codes to Messages
</span></a></li>
247 <div class=
"rst-footer-buttons" role=
"navigation" aria-label=
"footer navigation">
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>
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>
259 <div role=
"contentinfo">
261 © <a href=
"../copyright.html">Copyright
</a>
265 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>.
278 <script type=
"text/javascript">
280 SphinxRtdTheme.Navigation.enable(true);