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

   1
   2
   3 <!DOCTYPE html>
   4 <html class="writer-html5" lang="en" >
   5 <head>
   6   <meta charset="utf-8">
   7
   8   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   9
  10   <title>memcached_fetch &mdash; libmemcached 1.0.99 documentation</title>
  11
  12
  13
  14   <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  15   <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  16
  17
  18
  19
  20
  21
  22
  23   <!--[if lt IE 9]>
  24     <script src="../_static/js/html5shiv.min.js"></script>
  25   <![endif]-->
  26
  27
  28       <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
  29         <script src="../_static/jquery.js"></script>
  30         <script src="../_static/underscore.js"></script>
  31         <script src="../_static/doctools.js"></script>
  32         <script src="../_static/language_data.js"></script>
  33
  34     <script type="text/javascript" src="../_static/js/theme.js"></script>
  35
  36
  37     <link rel="index" title="Index" href="../genindex.html" />
  38     <link rel="search" title="Search" href="../search.html" />
  39     <link rel="copyright" title="Copyright" href="../copyright.html" />
  40     <link rel="next" title="Misc" href="index_misc.html" />
  41     <link rel="prev" title="Deprecated Functionality" href="index_deprecated.html" />
  42 </head>
  43
  44 <body class="wy-body-for-nav">
  45
  46
  47   <div class="wy-grid-for-nav">
  48
  49     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  50       <div class="wy-side-scroll">
  51         <div class="wy-side-nav-search" >
  52
  53
  54
  55             <a href="../index.html" class="icon icon-home" alt="Documentation Home"> libmemcached
  56
  57
  58
  59           </a>
  60
  61
  62
  63
  64               <div class="version">
  65                 1.0
  66               </div>
  67
  68
  69
  70
  71 <div role="search">
  72   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
  73     <input type="text" name="q" placeholder="Search docs" />
  74     <input type="hidden" name="check_keywords" value="yes" />
  75     <input type="hidden" name="area" value="default" />
  76   </form>
  77 </div>
  78
  79
  80         </div>
  81
  82
  83         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  84
  85
  86
  87
  88
  89
  90               <p class="caption"><span class="caption-text">libmemcached</span></p>
  91 <ul class="current">
  92 <li class="toctree-l1"><a class="reference internal" href="../libmemcached.html">Introduction</a></li>
  93 <li class="toctree-l1 current"><a class="reference internal" href="index.html">libmemcached API</a><ul class="current">
  94 <li class="toctree-l2"><a class="reference internal" href="index_basics.html">Basics</a></li>
  95 <li class="toctree-l2"><a class="reference internal" href="index_data.html">Working with Data</a></li>
  96 <li class="toctree-l2"><a class="reference internal" href="index_errors.html">Messages and Errors</a></li>
  97 <li class="toctree-l2"><a class="reference internal" href="index_advanced.html">Advanced Topics</a></li>
  98 <li class="toctree-l2 current"><a class="reference internal" href="index_deprecated.html">Deprecated Functionality</a><ul class="current">
  99 <li class="toctree-l3 current"><a class="current reference internal" href="#">memcached_fetch</a></li>
 100 </ul>
 101 </li>
 102 </ul>
 103 </li>
 104 <li class="toctree-l1"><a class="reference internal" href="index_misc.html">Misc</a></li>
 105 </ul>
 106 <p class="caption"><span class="caption-text">libmemcachedutil</span></p>
 107 <ul>
 108 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil.html">Introduction</a></li>
 109 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
 110 </ul>
 111 <p class="caption"><span class="caption-text">libhashkit</span></p>
 112 <ul>
 113 <li class="toctree-l1"><a class="reference internal" href="../libhashkit.html">Introduction</a></li>
 114 <li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a></li>
 115 </ul>
 116 <p class="caption"><span class="caption-text">Client Applications</span></p>
 117 <ul>
 118 <li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a></li>
 119 </ul>
 120 <p class="caption"><span class="caption-text">Copyright</span></p>
 121 <ul>
 122 <li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
 123 </ul>
 124
 125
 126
 127         </div>
 128
 129       </div>
 130     </nav>
 131
 132     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 133
 134
 135       <nav class="wy-nav-top" aria-label="top navigation">
 136
 137           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 138           <a href="../index.html">libmemcached</a>
 139
 140       </nav>
 141
 142
 143       <div class="wy-nav-content">
 144
 145         <div class="rst-content">
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163 <div role="navigation" aria-label="breadcrumbs navigation">
 164
 165   <ul class="wy-breadcrumbs">
 166
 167       <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
 168
 169           <li><a href="index.html">libmemcached API</a> &raquo;</li>
 170
 171           <li><a href="index_deprecated.html">Deprecated Functionality</a> &raquo;</li>
 172
 173       <li>memcached_fetch</li>
 174
 175
 176       <li class="wy-breadcrumbs-aside">
 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="memcached-fetch">
 191 <h1>memcached_fetch<a class="headerlink" href="#memcached-fetch" 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="simple">
 195 <dt>#include &lt;libmemcached/memcached.h&gt;</dt><dd><p>Compile and link with -lmemcached</p>
 196 </dd>
 197 </dl>
 198 <dl class="cpp function">
 199 <dt id="_CPPv415memcached_fetchP12memcached_stPcP6size_tP6size_tP8uint32_tP18memcached_return_t">
 200 <span id="_CPPv315memcached_fetchP12memcached_stPcP6size_tP6size_tP8uint32_tP18memcached_return_t"></span><span id="_CPPv215memcached_fetchP12memcached_stPcP6size_tP6size_tP8uint32_tP18memcached_return_t"></span><span id="memcached_fetch__memcached_stP.cP.sP.sP.uint32_tP.memcached_return_tP"></span>char *<code class="sig-name descname">memcached_fetch</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>, char *<em>key</em>, size_t *<em>key_length</em>, size_t *<em>value_length</em>, uint32_t *<em>flags</em>, <a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> *<em>error</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv415memcached_fetchP12memcached_stPcP6size_tP6size_tP8uint32_tP18memcached_return_t" title="Permalink to this definition">¶</a><br /></dt>
 201 <dd><div class="deprecated">
 202 <p><span class="versionmodified deprecated">Deprecated since version 0.50: </span>Use <a class="reference internal" href="memcached_get.html#_CPPv422memcached_fetch_resultP12memcached_stP19memcached_result_stP18memcached_return_t" title="memcached_fetch_result"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_fetch_result()</span></code></a> instead.</p>
 203 </div>
 204 </dd></dl>
 205
 206 </div>
 207 <div class="section" id="description">
 208 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
 209 <p><a class="reference internal" href="#_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> is used to fetch an individual value from the server.
 210 <a class="reference internal" href="memcached_get.html#_CPPv414memcached_mgetP12memcached_stPPCKcPK6size_t6size_t" title="memcached_mget"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_mget()</span></code></a> must always be called before using this method.
 211 You must pass in a key and its length to fetch the object.</p>
 212 <p>You must supply three pointer variables which will give you the state of the returned
 213 object:</p>
 214 <blockquote>
 215 <div><ul class="simple">
 216 <li><p>A <code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">uint32_t</span></code> pointer to contain whatever flags you stored with the value,</p></li>
 217 <li><p>a <code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">size_t</span></code> pointer which will be filled with size of of the object, and</p></li>
 218 <li><p>a <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> pointer to hold any error.</p></li>
 219 </ul>
 220 </div></blockquote>
 221 <p>The object will be returned upon success and NULL will be returned on failure.</p>
 222 <p><a class="reference internal" href="memcached_return_t.html#_CPPv4N18memcached_return_t13MEMCACHED_ENDE" title="MEMCACHED_END"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_END</span></code></a> is returned by the error value when all objects that have been found are returned.
 223 The final value upon <a class="reference internal" href="memcached_return_t.html#_CPPv4N18memcached_return_t13MEMCACHED_ENDE" title="MEMCACHED_END"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_END</span></code></a> is a NULL pointer.</p>
 224 <p>Values returned by <a class="reference internal" href="#_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> must be freed by the caller.</p>
 225 <p>All of the above functions are not tested when the
 226 <a class="reference internal" href="memcached_behavior.html#_CPPv4N20memcached_behavior_t26MEMCACHED_BEHAVIOR_USE_UDPE" title="MEMCACHED_BEHAVIOR_USE_UDP"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_BEHAVIOR_USE_UDP</span></code></a> has been set. Executing any of these
 227 functions with this behavior on will result in <a class="reference internal" href="memcached_return_t.html#_CPPv4N18memcached_return_t23MEMCACHED_NOT_SUPPORTEDE" title="MEMCACHED_NOT_SUPPORTED"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_NOT_SUPPORTED</span></code></a>
 228 being returned, or for those functions which do not return a
 229 <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>, the error function parameter will
 230 be set to <a class="reference internal" href="memcached_return_t.html#_CPPv4N18memcached_return_t23MEMCACHED_NOT_SUPPORTEDE" title="MEMCACHED_NOT_SUPPORTED"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_NOT_SUPPORTED</span></code></a>.</p>
 231 </div>
 232 <div class="section" id="return-value">
 233 <h2>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
 234 <p><a class="reference internal" href="#_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> sets error to
 235 to <a class="reference internal" href="memcached_return_t.html#_CPPv4N18memcached_return_t13MEMCACHED_ENDE" title="MEMCACHED_END"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_END</span></code></a> upon successful conclusion.</p>
 236 <p><a class="reference internal" href="memcached_return_t.html#_CPPv4N18memcached_return_t18MEMCACHED_NOTFOUNDE" title="MEMCACHED_NOTFOUND"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_NOTFOUND</span></code></a> will be return if no keys at all were found.</p>
 237 <p><a class="reference internal" href="memcached_return_t.html#_CPPv4N18memcached_return_t21MEMCACHED_KEY_TOO_BIGE" title="MEMCACHED_KEY_TOO_BIG"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_KEY_TOO_BIG</span></code></a> is set to error whenever <a class="reference internal" href="#_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> was used
 238 and the key was set larger then <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_MAX_KEY</span></code>, which was the largest
 239 key allowed for the original memcached ascii server.</p>
 240 </div>
 241 <div class="section" id="see-also">
 242 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
 243 <ul class="simple">
 244 <li><p><em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/1/memcached">memcached(1)</a></em></p></li>
 245 <li><p><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></p></li>
 246 <li><p><a class="reference internal" href="memcached_strerror.html"><span class="doc">Converting Error Codes to Messages</span></a></p></li>
 247 <li><p><a class="reference internal" href="memcached_get.html"><span class="doc">Retrieving data from the server</span></a></p></li>
 248 </ul>
 249 </div>
 250 </div>
 251
 252
 253            </div>
 254
 255           </div>
 256           <footer>
 257
 258     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 259
 260         <a href="index_misc.html" class="btn btn-neutral float-right" title="Misc" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 261
 262
 263         <a href="index_deprecated.html" class="btn btn-neutral float-left" title="Deprecated Functionality" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 264
 265     </div>
 266
 267
 268   <hr/>
 269
 270   <div role="contentinfo">
 271     <p>
 272
 273
 274         &copy; <a href="../copyright.html">Copyright</a>
 275
 276     </p>
 277   </div>
 278
 279
 280
 281     Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
 282
 283     <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
 284
 285     provided by <a href="https://readthedocs.org">Read the Docs</a>.
 286
 287 </footer>
 288
 289         </div>
 290       </div>
 291
 292     </section>
 293
 294   </div>
 295
 296
 297   <script type="text/javascript">
 298       jQuery(function () {
 299           SphinxRtdTheme.Navigation.enable(true);
 300       });
 301   </script>
 302
 303
 304
 305
 306
 307
 308 </body>
 309 </html>