git.m6w6.name Git - awesomized/libmemcached/blob - libmemcached/memcached_user_data.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>Storing custom information in the client &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="Authentication, Encryption &amp; Hashing" href="index_advanced_aeh.html" />
  40     <link rel="prev" title="Use custom allocators for embedded usage" href="memcached_memory_allocators.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 current"><a class="reference internal" href="index_advanced_internals.html">Internal Behavior</a><ul class="current">
  96 <li class="toctree-l4"><a class="reference internal" href="memcached_behavior.html">Behaviors of the library</a></li>
  97 <li class="toctree-l4"><a class="reference internal" href="memcached_callback.html">Library callbacks</a></li>
  98 <li class="toctree-l4"><a class="reference internal" href="memcached_memory_allocators.html">Use custom allocators for embedded usage</a></li>
  99 <li class="toctree-l4 current"><a class="current reference internal" href="#">Storing custom information in the client</a></li>
 100 </ul>
 101 </li>
 102 <li class="toctree-l3"><a class="reference internal" href="index_advanced_aeh.html">Authentication, Encryption &amp; Hashing</a></li>
 103 <li class="toctree-l3"><a class="reference internal" href="index_advanced_servers.html">Servers and Server Lists</a></li>
 104 <li class="toctree-l3"><a class="reference internal" href="index_advanced_daemon.html">Affecting the memcached Daemon</a></li>
 105 <li class="toctree-l3"><a class="reference internal" href="index_advanced_stats.html">Statistics</a></li>
 106 </ul>
 107 </li>
 108 <li class="toctree-l2"><a class="reference internal" href="index_deprecated.html">Deprecated Functionality</a></li>
 109 </ul>
 110 </li>
 111 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
 112 <li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a></li>
 113 <li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a></li>
 114 <li class="toctree-l1"><a class="reference internal" href="index_misc.html">Miscellaneous</a></li>
 115 </ul>
 116 <ul>
 117 <li class="toctree-l1"><a class="reference internal" href="../changelogs.html">Change Logs</a></li>
 118 <li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
 119 </ul>
 120
 121
 122
 123         </div>
 124       </div>
 125     </nav>
 126
 127     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 128
 129
 130       <nav class="wy-nav-top" aria-label="top navigation">
 131
 132           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 133           <a href="../index.html">libmemcached</a>
 134
 135       </nav>
 136
 137
 138       <div class="wy-nav-content">
 139
 140         <div class="rst-content">
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158 <div role="navigation" aria-label="breadcrumbs navigation">
 159
 160   <ul class="wy-breadcrumbs">
 161
 162       <li><a href="../index.html">Docs</a> &raquo;</li>
 163
 164           <li><a href="index.html">libmemcached API</a> &raquo;</li>
 165
 166           <li><a href="index_advanced.html">Advanced Topics</a> &raquo;</li>
 167
 168           <li><a href="index_advanced_internals.html">Internal Behavior</a> &raquo;</li>
 169
 170       <li>Storing custom information in the client</li>
 171
 172
 173       <li class="wy-breadcrumbs-aside">
 174
 175
 176
 177               <a href="https://github.com/m6w6/libmemcached/blob/v1.x/docs/source/libmemcached/memcached_user_data.rst" class="fa fa-github"> Edit on GitHub</a>
 178
 179
 180
 181       </li>
 182
 183   </ul>
 184
 185
 186   <hr/>
 187 </div>
 188           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 189            <div itemprop="articleBody">
 190
 191   <div class="section" id="storing-custom-information-in-the-client">
 192 <h1>Storing custom information in the client<a class="headerlink" href="#storing-custom-information-in-the-client" title="Permalink to this headline">¶</a></h1>
 193 <div class="section" id="synopsis">
 194 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
 195 <dl class="docutils">
 196 <dt>#include &lt;libmemcached/memcached.h&gt;</dt>
 197 <dd>Compile and link with -lmemcached</dd>
 198 </dl>
 199 <dl class="function">
 200 <dt id="_CPPv423memcached_get_user_dataP12memcached_st">
 201 <span id="_CPPv323memcached_get_user_dataP12memcached_st"></span><span id="_CPPv223memcached_get_user_dataP12memcached_st"></span><span id="memcached_get_user_data__memcached_stP"></span>void *<code class="descname">memcached_get_user_data</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="#_CPPv423memcached_get_user_dataP12memcached_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" />
 205 <tbody valign="top">
 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>
 207 </tr>
 208 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">opaque pointer to the user supplied data</td>
 209 </tr>
 210 </tbody>
 211 </table>
 212 </dd></dl>
 213
 214 <dl class="function">
 215 <dt id="_CPPv423memcached_set_user_dataP12memcached_stPv">
 216 <span id="_CPPv323memcached_set_user_dataP12memcached_stPv"></span><span id="_CPPv223memcached_set_user_dataP12memcached_stPv"></span><span id="memcached_set_user_data__memcached_stP.voidP"></span>void *<code class="descname">memcached_set_user_data</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>, void *<em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv423memcached_set_user_dataP12memcached_stPv" title="Permalink to this definition">¶</a><br /></dt>
 217 <dd><table class="docutils field-list" frame="void" rules="none">
 218 <col class="field-name" />
 219 <col class="field-body" />
 220 <tbody valign="top">
 221 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 222 <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>
 223 <li><strong>data</strong> -- opaque pointer to user supplied data</li>
 224 </ul>
 225 </td>
 226 </tr>
 227 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">opaque pointer to the previously set <a class="reference internal" href="#_CPPv423memcached_set_user_dataP12memcached_stPv" title="memcached_set_user_data::data"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">data</span></code></a></p>
 228 </td>
 229 </tr>
 230 </tbody>
 231 </table>
 232 </dd></dl>
 233
 234 </div>
 235 <div class="section" id="description">
 236 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
 237 <p><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">libmemcached</span></code> allows you to store a pointer to a user specific data inside
 238 the memcached_st structure.</p>
 239 <p><a class="reference internal" href="#_CPPv423memcached_set_user_dataP12memcached_stPv" title="memcached_set_user_data"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_set_user_data()</span></code></a> is used to set the user specific data in the
 240 <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>
 241 <p><a class="reference internal" href="#_CPPv423memcached_get_user_dataP12memcached_st" title="memcached_get_user_data"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_get_user_data()</span></code></a> is used to retrieve the user specific data in
 242 the <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>
 243 </div>
 244 <div class="section" id="return-value">
 245 <h2>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
 246 <p><a class="reference internal" href="#_CPPv423memcached_set_user_dataP12memcached_stPv" title="memcached_set_user_data"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_set_user_data()</span></code></a> returns the previous value of the user specific data.</p>
 247 <p><a class="reference internal" href="#_CPPv423memcached_get_user_dataP12memcached_st" title="memcached_get_user_data"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_get_user_data()</span></code></a> returns the current value of the user specific data.</p>
 248 </div>
 249 <div class="section" id="see-also">
 250 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
 251 <ul class="simple">
 252 <li><em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/1/memcached">memcached(1)</a></em></li>
 253 <li><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></li>
 254 </ul>
 255 </div>
 256 </div>
 257
 258
 259            </div>
 260
 261           </div>
 262           <footer>
 263
 264     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 265
 266         <a href="index_advanced_aeh.html" class="btn btn-neutral float-right" title="Authentication, Encryption &amp; Hashing" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 267
 268
 269         <a href="memcached_memory_allocators.html" class="btn btn-neutral float-left" title="Use custom allocators for embedded usage" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 270
 271     </div>
 272
 273
 274   <hr/>
 275
 276   <div role="contentinfo">
 277     <p>
 278         &copy; <a href="../copyright.html">Copyright</a>
 279
 280     </p>
 281   </div>
 282   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>.
 283
 284 </footer>
 285
 286         </div>
 287       </div>
 288
 289     </section>
 290
 291   </div>
 292
 293
 294
 295   <script type="text/javascript">
 296       jQuery(function () {
 297           SphinxRtdTheme.Navigation.enable(true);
 298       });
 299   </script>
 300
 301
 302
 303
 304
 305
 306 </body>
 307 </html>