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>Wiping clean the contents of 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=
"Setting the verbosity of a server" href=
"memcached_verbosity.html" />
40 <link rel=
"prev" title=
"Dumping data from a server" href=
"memcached_dump.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"><a class=
"reference internal" href=
"index_basics.html">Basics
</a></li>
93 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_data.html">Working with Data
</a></li>
94 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_errors.html">Messages and Errors
</a></li>
95 <li class=
"toctree-l2 current"><a class=
"reference internal" href=
"index_advanced.html">Advanced Topics
</a><ul class=
"current">
96 <li class=
"toctree-l3"><a class=
"reference internal" href=
"index_advanced_internals.html">Internal Behavior
</a></li>
97 <li class=
"toctree-l3"><a class=
"reference internal" href=
"index_advanced_aeh.html">Authentication, Encryption
& Hashing
</a></li>
98 <li class=
"toctree-l3"><a class=
"reference internal" href=
"index_advanced_servers.html">Servers and Server Lists
</a></li>
99 <li class=
"toctree-l3 current"><a class=
"reference internal" href=
"index_advanced_daemon.html">Affecting the memcached Daemon
</a><ul class=
"current">
100 <li class=
"toctree-l4"><a class=
"reference internal" href=
"memcached_dump.html">Dumping data from a server
</a></li>
101 <li class=
"toctree-l4 current"><a class=
"current reference internal" href=
"#">Wiping clean the contents of a server
</a></li>
102 <li class=
"toctree-l4"><a class=
"reference internal" href=
"memcached_verbosity.html">Setting the verbosity of a server
</a></li>
105 <li class=
"toctree-l3"><a class=
"reference internal" href=
"index_advanced_stats.html">Statistics
</a></li>
108 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_deprecated.html">Deprecated Functionality
</a></li>
111 <li class=
"toctree-l1"><a class=
"reference internal" href=
"index_misc.html">Misc
</a></li>
113 <p class=
"caption"><span class=
"caption-text">libmemcachedutil
</span></p>
115 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcachedutil.html">Introduction
</a></li>
116 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcachedutil/index.html">libmemcachedutil API
</a></li>
118 <p class=
"caption"><span class=
"caption-text">libhashkit
</span></p>
120 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libhashkit.html">Introduction
</a></li>
121 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libhashkit/index.html">libhashkit API
</a></li>
123 <p class=
"caption"><span class=
"caption-text">Client Applications
</span></p>
125 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../bin/index.html">Client Applications
</a></li>
127 <p class=
"caption"><span class=
"caption-text">Copyright
</span></p>
129 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../copyright.html">Copyright
</a></li>
138 <section data-toggle=
"wy-nav-shift" class=
"wy-nav-content-wrap">
141 <nav class=
"wy-nav-top" aria-label=
"top navigation">
143 <i data-toggle=
"wy-nav-top" class=
"fa fa-bars"></i>
144 <a href=
"../index.html">libmemcached
</a>
149 <div class=
"wy-nav-content">
151 <div class=
"rst-content">
169 <div role=
"navigation" aria-label=
"breadcrumbs navigation">
171 <ul class=
"wy-breadcrumbs">
173 <li><a href=
"../index.html">Docs
</a> »</li>
175 <li><a href=
"index.html">libmemcached API
</a> »</li>
177 <li><a href=
"index_advanced.html">Advanced Topics
</a> »</li>
179 <li><a href=
"index_advanced_daemon.html">Affecting the memcached Daemon
</a> »</li>
181 <li>Wiping clean the contents of a server
</li>
184 <li class=
"wy-breadcrumbs-aside">
195 <div role=
"main" class=
"document" itemscope=
"itemscope" itemtype=
"http://schema.org/Article">
196 <div itemprop=
"articleBody">
198 <div class=
"section" id=
"wiping-clean-the-contents-of-a-server">
199 <h1>Wiping clean the contents of a server
<a class=
"headerlink" href=
"#wiping-clean-the-contents-of-a-server" title=
"Permalink to this headline">¶
</a></h1>
200 <div class=
"section" id=
"synopsis">
201 <h2>SYNOPSIS
<a class=
"headerlink" href=
"#synopsis" title=
"Permalink to this headline">¶
</a></h2>
202 <dl class=
"docutils">
203 <dt>#include
<libmemcached/memcached.h
></dt>
204 <dd>Compile and link with -lmemcached
</dd>
206 <dl class=
"function">
207 <dt id=
"_CPPv415memcached_flushP12memcached_st6time_t">
208 <span id=
"_CPPv315memcached_flushP12memcached_st6time_t"></span><span id=
"_CPPv215memcached_flushP12memcached_st6time_t"></span><span id=
"memcached_flush__memcached_stP.time_t"></span><a class=
"reference internal" href=
"memcached_return_t.html#_CPPv418memcached_return_t" title=
"memcached_return_t">memcached_return_t
</a> <code class=
"descname">memcached_flush
</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>, time_t
<em>expiration
</em><span class=
"sig-paren">)
</span><a class=
"headerlink" href=
"#_CPPv415memcached_flushP12memcached_st6time_t" title=
"Permalink to this definition">¶
</a><br /></dt>
209 <dd><table class=
"docutils field-list" frame=
"void" rules=
"none">
210 <col class=
"field-name" />
211 <col class=
"field-body" />
213 <tr class=
"field-odd field"><th class=
"field-name">Parameters:
</th><td class=
"field-body"><ul class=
"first simple">
214 <li><strong>ptr
</strong> -- pointer to an 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
</li>
215 <li><strong>expiration
</strong> -- expiration as a unix timestamp or as relative expiration time in seconds
</li>
219 <tr class=
"field-even field"><th class=
"field-name">Returns:
</th><td class=
"field-body"><p class=
"first last"><a class=
"reference internal" href=
"memcached_return_t.html#_CPPv418memcached_return_t" title=
"memcached_return_t"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_return_t
</span></code></a> indicating success
</p>
227 <div class=
"section" id=
"description">
228 <h2>DESCRIPTION
<a class=
"headerlink" href=
"#description" title=
"Permalink to this headline">¶
</a></h2>
229 <p><a class=
"reference internal" href=
"#_CPPv415memcached_flushP12memcached_st6time_t" title=
"memcached_flush"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_flush()
</span></code></a> is used to wipe clean the contents of
<em class=
"manpage"><a class=
"manpage reference external" href=
"https://linux.die.net/man/1/memcached">memcached(
1)
</a></em> servers.
230 It will either do this immediately or expire the content based on the
231 expiration time passed to the method (a value of zero causes an immediate
232 flush). The operation is not atomic to multiple servers, just atomic to a
233 single server. That is, it will flush the servers in the order that they were
236 <div class=
"section" id=
"return-value">
237 <h2>RETURN VALUE
<a class=
"headerlink" href=
"#return-value" title=
"Permalink to this headline">¶
</a></h2>
238 <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.
239 On success that value 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>.
240 Use
<a class=
"reference internal" href=
"memcached_strerror.html#_CPPv418memcached_strerrorP12memcached_st18memcached_return_t" title=
"memcached_strerror"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_strerror()
</span></code></a> to translate this value to a printable string.
</p>
242 <div class=
"section" id=
"see-also">
243 <h2>SEE ALSO
<a class=
"headerlink" href=
"#see-also" title=
"Permalink to this headline">¶
</a></h2>
245 <li><em class=
"manpage"><a class=
"manpage reference external" href=
"https://linux.die.net/man/1/memcached">memcached(
1)
</a></em></li>
246 <li><a class=
"reference internal" href=
"../libmemcached.html"><span class=
"doc">C/C++ Client Library for memcached
</span></a></li>
247 <li><a class=
"reference internal" href=
"memcached_strerror.html"><span class=
"doc">Converting Error Codes to Messages
</span></a></li>
258 <div class=
"rst-footer-buttons" role=
"navigation" aria-label=
"footer navigation">
260 <a href=
"memcached_verbosity.html" class=
"btn btn-neutral float-right" title=
"Setting the verbosity of a server" accesskey=
"n" rel=
"next">Next
<span class=
"fa fa-arrow-circle-right"></span></a>
263 <a href=
"memcached_dump.html" class=
"btn btn-neutral float-left" title=
"Dumping data from a server" accesskey=
"p" rel=
"prev"><span class=
"fa fa-arrow-circle-left"></span> Previous
</a>
270 <div role=
"contentinfo">
272 © <a href=
"../copyright.html">Copyright
</a>
276 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>.
289 <script type=
"text/javascript">
291 SphinxRtdTheme.Navigation.enable(true);