git.m6w6.name Git - awesomized/libmemcached/blob - libmemcached/memcached_flush.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>Wiping clean the contents of a server &mdash; libmemcached 1.1.0 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="Setting the verbosity of a server" href="memcached_verbosity.html" />
  40     <link rel="prev" title="Dumping data from a server" href="memcached_dump.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
  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"><a class="reference internal" href="index_basics.html">Basics</a></li>
  92 <li class="toctree-l2"><a class="reference internal" href="index_data.html">Working with Data</a></li>
  93 <li class="toctree-l2"><a class="reference internal" href="index_errors.html">Messages and Errors</a></li>
  94 <li class="toctree-l2 current"><a class="reference internal" href="index_advanced.html">Advanced Topics</a><ul class="current">
  95 <li class="toctree-l3"><a class="reference internal" href="index_advanced_internals.html">Internal Behavior</a></li>
  96 <li class="toctree-l3"><a class="reference internal" href="index_advanced_aeh.html">Authentication, Encryption &amp; Hashing</a></li>
  97 <li class="toctree-l3"><a class="reference internal" href="index_advanced_servers.html">Servers and Server Lists</a></li>
  98 <li class="toctree-l3 current"><a class="reference internal" href="index_advanced_daemon.html">Affecting the memcached Daemon</a><ul class="current">
  99 <li class="toctree-l4"><a class="reference internal" href="memcached_dump.html">Dumping data from a server</a></li>
 100 <li class="toctree-l4 current"><a class="current reference internal" href="#">Wiping clean the contents of a server</a></li>
 101 <li class="toctree-l4"><a class="reference internal" href="memcached_verbosity.html">Setting the verbosity of a server</a></li>
 102 </ul>
 103 </li>
 104 <li class="toctree-l3"><a class="reference internal" href="index_advanced_stats.html">Statistics</a></li>
 105 </ul>
 106 </li>
 107 <li class="toctree-l2"><a class="reference internal" href="index_deprecated.html">Deprecated Functionality</a></li>
 108 </ul>
 109 </li>
 110 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
 111 <li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a></li>
 112 <li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a></li>
 113 <li class="toctree-l1"><a class="reference internal" href="index_misc.html">Miscellaneous</a></li>
 114 </ul>
 115 <ul>
 116 <li class="toctree-l1"><a class="reference internal" href="../changelogs.html">Change Logs</a></li>
 117 <li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
 118 </ul>
 119
 120
 121
 122         </div>
 123       </div>
 124     </nav>
 125
 126     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 127
 128
 129       <nav class="wy-nav-top" aria-label="top navigation">
 130
 131           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 132           <a href="../index.html">libmemcached</a>
 133
 134       </nav>
 135
 136
 137       <div class="wy-nav-content">
 138
 139         <div class="rst-content">
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157 <div role="navigation" aria-label="breadcrumbs navigation">
 158
 159   <ul class="wy-breadcrumbs">
 160
 161       <li><a href="../index.html">Docs</a> &raquo;</li>
 162
 163           <li><a href="index.html">libmemcached API</a> &raquo;</li>
 164
 165           <li><a href="index_advanced.html">Advanced Topics</a> &raquo;</li>
 166
 167           <li><a href="index_advanced_daemon.html">Affecting the memcached Daemon</a> &raquo;</li>
 168
 169       <li>Wiping clean the contents of a server</li>
 170
 171
 172       <li class="wy-breadcrumbs-aside">
 173
 174
 175
 176               <a href="https://github.com/m6w6/libmemcached/blob/v1.x/docs/source/libmemcached/memcached_flush.rst" class="fa fa-github"> Edit on GitHub</a>
 177
 178
 179
 180       </li>
 181
 182   </ul>
 183
 184
 185   <hr/>
 186 </div>
 187           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 188            <div itemprop="articleBody">
 189
 190   <div class="section" id="wiping-clean-the-contents-of-a-server">
 191 <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>
 192 <div class="section" id="synopsis">
 193 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
 194 <dl class="docutils">
 195 <dt>#include &lt;libmemcached/memcached.h&gt;</dt>
 196 <dd>Compile and link with -lmemcached</dd>
 197 </dl>
 198 <dl class="function">
 199 <dt id="_CPPv415memcached_flushP12memcached_st6time_t">
 200 <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>
 201 <dd><table class="docutils field-list" frame="void" rules="none">
 202 <col class="field-name" />
 203 <col class="field-body" />
 204 <tbody valign="top">
 205 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 206 <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>
 207 <li><strong>expiration</strong> -- expiration as a unix timestamp or as relative expiration time in seconds</li>
 208 </ul>
 209 </td>
 210 </tr>
 211 <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>
 212 </td>
 213 </tr>
 214 </tbody>
 215 </table>
 216 </dd></dl>
 217
 218 </div>
 219 <div class="section" id="description">
 220 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
 221 <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.
 222 It will either do this immediately or expire the content based on the
 223 expiration time passed to the method (a value of zero causes an immediate
 224 flush). The operation is not atomic to multiple servers, just atomic to a
 225 single server. That is, it will flush the servers in the order that they were
 226 added.</p>
 227 </div>
 228 <div class="section" id="return-value">
 229 <h2>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
 230 <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.
 231 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>.
 232 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>
 233 </div>
 234 <div class="section" id="see-also">
 235 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
 236 <ul class="simple">
 237 <li><em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/1/memcached">memcached(1)</a></em></li>
 238 <li><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></li>
 239 <li><a class="reference internal" href="memcached_strerror.html"><span class="doc">Converting Error Codes to Messages</span></a></li>
 240 </ul>
 241 </div>
 242 </div>
 243
 244
 245            </div>
 246
 247           </div>
 248           <footer>
 249
 250     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 251
 252         <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>
 253
 254
 255         <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>
 256
 257     </div>
 258
 259
 260   <hr/>
 261
 262   <div role="contentinfo">
 263     <p>
 264         &copy; <a href="../copyright.html">Copyright</a>
 265
 266     </p>
 267   </div>
 268   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>.
 269
 270 </footer>
 271
 272         </div>
 273       </div>
 274
 275     </section>
 276
 277   </div>
 278
 279
 280
 281   <script type="text/javascript">
 282       jQuery(function () {
 283           SphinxRtdTheme.Navigation.enable(true);
 284       });
 285   </script>
 286
 287
 288
 289
 290
 291
 292 </body>
 293 </html>