git.m6w6.name Git - awesomized/libmemcached/blob - libmemcached/memcached_dump.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>Dumping data from 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="Wiping clean the contents of a server" href="memcached_flush.html" />
  40     <link rel="prev" title="Affecting the memcached Daemon" href="index_advanced_daemon.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 current"><a class="current reference internal" href="#">Dumping data from a server</a></li>
 100 <li class="toctree-l4"><a class="reference internal" href="memcached_flush.html">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>Dumping data from 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_dump.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="dumping-data-from-a-server">
 191 <h1>Dumping data from a server<a class="headerlink" href="#dumping-data-from-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="type">
 199 <dt id="_CPPv417memcached_dump_fn">
 200 <span id="_CPPv317memcached_dump_fn"></span><span id="_CPPv217memcached_dump_fn"></span><span id="memcached_dump_fn"></span><em class="property">typedef </em><a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> (*<code class="descname">memcached_dump_fn</code>)<span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *ptr, <em class="property">const</em> char *key, size_t key_length, void *context<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv417memcached_dump_fn" 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 <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> object</li>
 207 <li><strong>key</strong> -- key string being dumped</li>
 208 <li><strong>key_length</strong> -- length of the key without any terminating zero</li>
 209 <li><strong>context</strong> -- pointer to the user supplied context</li>
 210 </ul>
 211 </td>
 212 </tr>
 213 <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>
 214 </td>
 215 </tr>
 216 </tbody>
 217 </table>
 218 </dd></dl>
 219
 220 <dl class="function">
 221 <dt id="_CPPv414memcached_dumpP12memcached_stP17memcached_dump_fnPv8uint32_t">
 222 <span id="_CPPv314memcached_dumpP12memcached_stP17memcached_dump_fnPv8uint32_t"></span><span id="_CPPv214memcached_dumpP12memcached_stP17memcached_dump_fnPv8uint32_t"></span><span id="memcached_dump__memcached_stP.memcached_dump_fnP.voidP.uint32_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_dump</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>, <a class="reference internal" href="#_CPPv417memcached_dump_fn" title="memcached_dump_fn">memcached_dump_fn</a> *<em>function</em>, void *<em>context</em>, uint32_t <em>number_of_callbacks</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv414memcached_dumpP12memcached_stP17memcached_dump_fnPv8uint32_t" title="Permalink to this definition">¶</a><br /></dt>
 223 <dd><table class="docutils field-list" frame="void" rules="none">
 224 <col class="field-name" />
 225 <col class="field-body" />
 226 <tbody valign="top">
 227 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 228 <li><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</li>
 229 <li><strong>function</strong> -- pointer to <a class="reference internal" href="#_CPPv414memcached_dumpP12memcached_stP17memcached_dump_fnPv8uint32_t" title="memcached_dump::number_of_callbacks"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">number_of_callbacks</span></code></a> <a class="reference internal" href="#_CPPv417memcached_dump_fn" title="memcached_dump_fn"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_dump_fn</span></code></a> callbacks</li>
 230 <li><strong>context</strong> -- pointer to a user managed context</li>
 231 <li><strong>number_of_callbacks</strong> -- number of callbacks in the <a class="reference internal" href="#_CPPv414memcached_dumpP12memcached_stP17memcached_dump_fnPv8uint32_t" title="memcached_dump::function"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">function</span></code></a> array</li>
 232 </ul>
 233 </td>
 234 </tr>
 235 <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>
 236 </td>
 237 </tr>
 238 </tbody>
 239 </table>
 240 </dd></dl>
 241
 242 </div>
 243 <div class="section" id="description">
 244 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
 245 <p><a class="reference internal" href="#_CPPv414memcached_dumpP12memcached_stP17memcached_dump_fnPv8uint32_t" title="memcached_dump"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_dump()</span></code></a> is used to get a list of keys found in <em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/1/memcached">memcached(1)</a></em>
 246 servers. Because memcached does not guarantee to dump all keys you can not
 247 assume you have fetched all keys from the server. The function takes an array
 248 of callbacks that it will use to execute on keys as they are found.</p>
 249 <p>Currently the binary protocol is not tested.</p>
 250 </div>
 251 <div class="section" id="return-value">
 252 <h2>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
 253 <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.
 254 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>.
 255 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 translate this value to a printable
 256 string.</p>
 257 </div>
 258 <div class="section" id="see-also">
 259 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
 260 <ul class="simple">
 261 <li><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></li>
 262 <li><a class="reference internal" href="memcached_strerror.html"><span class="doc">Converting Error Codes to Messages</span></a></li>
 263 </ul>
 264 </div>
 265 </div>
 266
 267
 268            </div>
 269
 270           </div>
 271           <footer>
 272
 273     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 274
 275         <a href="memcached_flush.html" class="btn btn-neutral float-right" title="Wiping clean the contents of a server" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 276
 277
 278         <a href="index_advanced_daemon.html" class="btn btn-neutral float-left" title="Affecting the memcached Daemon" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 279
 280     </div>
 281
 282
 283   <hr/>
 284
 285   <div role="contentinfo">
 286     <p>
 287         &copy; <a href="../copyright.html">Copyright</a>
 288
 289     </p>
 290   </div>
 291   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>.
 292
 293 </footer>
 294
 295         </div>
 296       </div>
 297
 298     </section>
 299
 300   </div>
 301
 302
 303
 304   <script type="text/javascript">
 305       jQuery(function () {
 306           SphinxRtdTheme.Navigation.enable(true);
 307       });
 308   </script>
 309
 310
 311
 312
 313
 314
 315 </body>
 316 </html>