git.m6w6.name Git - m6w6/libmemcached/blob - libmemcached/memcached_callback.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>Library callbacks &mdash; libmemcached 1.0.99 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="Use custom allocators for embedded usage" href="memcached_memory_allocators.html" />
  40     <link rel="prev" title="Behaviors of the library" href="memcached_behavior.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.0
  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               <p class="caption"><span class="caption-text">libmemcached</span></p>
  89 <ul class="current">
  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 current"><a class="reference internal" href="index_advanced_internals.html">Internal Behavior</a><ul class="current">
  97 <li class="toctree-l4"><a class="reference internal" href="memcached_behavior.html">Behaviors of the library</a></li>
  98 <li class="toctree-l4 current"><a class="current reference internal" href="#">Library callbacks</a></li>
  99 <li class="toctree-l4"><a class="reference internal" href="memcached_memory_allocators.html">Use custom allocators for embedded usage</a></li>
 100 <li class="toctree-l4"><a class="reference internal" href="memcached_user_data.html">Storing custom information in the client</a></li>
 101 </ul>
 102 </li>
 103 <li class="toctree-l3"><a class="reference internal" href="index_advanced_aeh.html">Authentication, Encryption &amp; Hashing</a></li>
 104 <li class="toctree-l3"><a class="reference internal" href="index_advanced_servers.html">Servers and Server Lists</a></li>
 105 <li class="toctree-l3"><a class="reference internal" href="index_advanced_daemon.html">Affecting the memcached Daemon</a></li>
 106 <li class="toctree-l3"><a class="reference internal" href="index_advanced_stats.html">Statistics</a></li>
 107 </ul>
 108 </li>
 109 <li class="toctree-l2"><a class="reference internal" href="index_deprecated.html">Deprecated Functionality</a></li>
 110 </ul>
 111 </li>
 112 <li class="toctree-l1"><a class="reference internal" href="index_misc.html">Misc</a></li>
 113 </ul>
 114 <p class="caption"><span class="caption-text">libmemcachedutil</span></p>
 115 <ul>
 116 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil.html">Introduction</a></li>
 117 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
 118 </ul>
 119 <p class="caption"><span class="caption-text">libhashkit</span></p>
 120 <ul>
 121 <li class="toctree-l1"><a class="reference internal" href="../libhashkit.html">Introduction</a></li>
 122 <li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a></li>
 123 </ul>
 124 <p class="caption"><span class="caption-text">Client Applications</span></p>
 125 <ul>
 126 <li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a></li>
 127 </ul>
 128 <p class="caption"><span class="caption-text">Copyright</span></p>
 129 <ul>
 130 <li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
 131 </ul>
 132
 133
 134
 135         </div>
 136       </div>
 137     </nav>
 138
 139     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 140
 141
 142       <nav class="wy-nav-top" aria-label="top navigation">
 143
 144           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 145           <a href="../index.html">libmemcached</a>
 146
 147       </nav>
 148
 149
 150       <div class="wy-nav-content">
 151
 152         <div class="rst-content">
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170 <div role="navigation" aria-label="breadcrumbs navigation">
 171
 172   <ul class="wy-breadcrumbs">
 173
 174       <li><a href="../index.html">Docs</a> &raquo;</li>
 175
 176           <li><a href="index.html">libmemcached API</a> &raquo;</li>
 177
 178           <li><a href="index_advanced.html">Advanced Topics</a> &raquo;</li>
 179
 180           <li><a href="index_advanced_internals.html">Internal Behavior</a> &raquo;</li>
 181
 182       <li>Library callbacks</li>
 183
 184
 185       <li class="wy-breadcrumbs-aside">
 186
 187
 188
 189       </li>
 190
 191   </ul>
 192
 193
 194   <hr/>
 195 </div>
 196           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 197            <div itemprop="articleBody">
 198
 199   <div class="section" id="library-callbacks">
 200 <h1>Library callbacks<a class="headerlink" href="#library-callbacks" title="Permalink to this headline">¶</a></h1>
 201 <div class="section" id="synopsis">
 202 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
 203 <dl class="docutils">
 204 <dt>#include &lt;libmemcached/memcached.h&gt;</dt>
 205 <dd>Compile and link with -lmemcached</dd>
 206 </dl>
 207 <dl class="function">
 208 <dt id="_CPPv422memcached_callback_setP12memcached_st20memcached_callback_tPKv">
 209 <span id="_CPPv322memcached_callback_setP12memcached_st20memcached_callback_tPKv"></span><span id="_CPPv222memcached_callback_setP12memcached_st20memcached_callback_tPKv"></span><span id="memcached_callback_set__memcached_stP.memcached_callback_t.voidCP"></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_callback_set</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="#_CPPv420memcached_callback_t" title="memcached_callback_t">memcached_callback_t</a> <em>flag</em>, <em class="property">const</em> void *<em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv422memcached_callback_setP12memcached_st20memcached_callback_tPKv" title="Permalink to this definition">¶</a><br /></dt>
 210 <dd><table class="docutils field-list" frame="void" rules="none">
 211 <col class="field-name" />
 212 <col class="field-body" />
 213 <tbody valign="top">
 214 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 215 <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>
 216 <li><strong>flag</strong> -- <a class="reference internal" href="#_CPPv420memcached_callback_t" title="memcached_callback_t"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_callback_t</span></code></a> flag to set</li>
 217 <li><strong>data</strong> -- data corresponding to <a class="reference internal" href="#_CPPv422memcached_callback_setP12memcached_st20memcached_callback_tPKv" title="memcached_callback_set::flag"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">flag</span></code></a></li>
 218 </ul>
 219 </td>
 220 </tr>
 221 <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>
 222 </td>
 223 </tr>
 224 </tbody>
 225 </table>
 226 </dd></dl>
 227
 228 <dl class="function">
 229 <dt id="_CPPv422memcached_callback_getP12memcached_st20memcached_callback_tP18memcached_return_t">
 230 <span id="_CPPv322memcached_callback_getP12memcached_st20memcached_callback_tP18memcached_return_t"></span><span id="_CPPv222memcached_callback_getP12memcached_st20memcached_callback_tP18memcached_return_t"></span><span id="memcached_callback_get__memcached_stP.memcached_callback_t.memcached_return_tP"></span>void *<code class="descname">memcached_callback_get</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="#_CPPv420memcached_callback_t" title="memcached_callback_t">memcached_callback_t</a> <em>flag</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="#_CPPv422memcached_callback_getP12memcached_st20memcached_callback_tP18memcached_return_t" title="Permalink to this definition">¶</a><br /></dt>
 231 <dd><table class="docutils field-list" frame="void" rules="none">
 232 <col class="field-name" />
 233 <col class="field-body" />
 234 <tbody valign="top">
 235 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 236 <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>
 237 <li><strong>flag</strong> -- <a class="reference internal" href="#_CPPv420memcached_callback_t" title="memcached_callback_t"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_callback_t</span></code></a> flag to query</li>
 238 <li><strong>error</strong> -- pointer to <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</li>
 239 </ul>
 240 </td>
 241 </tr>
 242 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">data</span></code> previously set</p>
 243 </td>
 244 </tr>
 245 </tbody>
 246 </table>
 247 </dd></dl>
 248
 249 <dl class="type">
 250 <dt id="c.memcached_callback_t">
 251 enum <a class="reference internal" href="#c.memcached_callback_t" title="memcached_callback_t">memcached_callback_t</a> <code class="descname">memcached_callback_t</code><a class="headerlink" href="#c.memcached_callback_t" title="Permalink to this definition">¶</a></dt>
 252 <dd></dd></dl>
 253
 254 <dl class="enum">
 255 <dt id="_CPPv420memcached_callback_t">
 256 <span id="_CPPv320memcached_callback_t"></span><span id="_CPPv220memcached_callback_t"></span><em class="property">enum </em><code class="descname">memcached_callback_t</code><a class="headerlink" href="#_CPPv420memcached_callback_t" title="Permalink to this definition">¶</a><br /></dt>
 257 <dd><dl class="enumerator">
 258 <dt id="_CPPv4N20memcached_callback_t35MEMCACHED_CALLBACK_CLEANUP_FUNCTIONE">
 259 <span id="_CPPv3N20memcached_callback_t35MEMCACHED_CALLBACK_CLEANUP_FUNCTIONE"></span><span id="_CPPv2N20memcached_callback_t35MEMCACHED_CALLBACK_CLEANUP_FUNCTIONE"></span><em class="property">enumerator </em><code class="descname">MEMCACHED_CALLBACK_CLEANUP_FUNCTION</code><a class="headerlink" href="#_CPPv4N20memcached_callback_t35MEMCACHED_CALLBACK_CLEANUP_FUNCTIONE" title="Permalink to this definition">¶</a><br /></dt>
 260 <dd><p>When <a class="reference internal" href="memcached_create.html#_CPPv414memcached_freeP12memcached_st" title="memcached_free"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_free()</span></code></a> or <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_reset</span></code> is called this function
 261 will be executed. At the point of its execution all connections are closed.</p>
 262 <p>Its signature is:</p>
 263 <dl class="type">
 264 <dt id="_CPPv4N20memcached_callback_t35MEMCACHED_CALLBACK_CLEANUP_FUNCTION20memcached_cleanup_fnE">
 265 <span id="_CPPv3N20memcached_callback_t35MEMCACHED_CALLBACK_CLEANUP_FUNCTION20memcached_cleanup_fnE"></span><span id="_CPPv2N20memcached_callback_t35MEMCACHED_CALLBACK_CLEANUP_FUNCTION20memcached_cleanup_fnE"></span><span id="memcached_callback_t::MEMCACHED_CALLBACK_CLEANUP_FUNCTION::memcached_cleanup_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_cleanup_fn</code>)<span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *ptr<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N20memcached_callback_t35MEMCACHED_CALLBACK_CLEANUP_FUNCTION20memcached_cleanup_fnE" title="Permalink to this definition">¶</a><br /></dt>
 266 <dd></dd></dl>
 267
 268 </dd></dl>
 269
 270 <dl class="enumerator">
 271 <dt id="_CPPv4N20memcached_callback_t33MEMCACHED_CALLBACK_CLONE_FUNCTIONE">
 272 <span id="_CPPv3N20memcached_callback_t33MEMCACHED_CALLBACK_CLONE_FUNCTIONE"></span><span id="_CPPv2N20memcached_callback_t33MEMCACHED_CALLBACK_CLONE_FUNCTIONE"></span><em class="property">enumerator </em><code class="descname">MEMCACHED_CALLBACK_CLONE_FUNCTION</code><a class="headerlink" href="#_CPPv4N20memcached_callback_t33MEMCACHED_CALLBACK_CLONE_FUNCTIONE" title="Permalink to this definition">¶</a><br /></dt>
 273 <dd><p>When <a class="reference internal" href="memcached_create.html#_CPPv415memcached_cloneP12memcached_stP12memcached_st" title="memcached_clone"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_clone()</span></code></a> is called this function will be executed.</p>
 274 <p>Its signature is:</p>
 275 <dl class="type">
 276 <dt id="_CPPv4N20memcached_callback_t33MEMCACHED_CALLBACK_CLONE_FUNCTION18memcached_clone_fnE">
 277 <span id="_CPPv3N20memcached_callback_t33MEMCACHED_CALLBACK_CLONE_FUNCTION18memcached_clone_fnE"></span><span id="_CPPv2N20memcached_callback_t33MEMCACHED_CALLBACK_CLONE_FUNCTION18memcached_clone_fnE"></span><span id="memcached_callback_t::MEMCACHED_CALLBACK_CLONE_FUNCTION::memcached_clone_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_clone_fn</code>)<span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *destination, <em class="property">const</em> <a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *source<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N20memcached_callback_t33MEMCACHED_CALLBACK_CLONE_FUNCTION18memcached_clone_fnE" title="Permalink to this definition">¶</a><br /></dt>
 278 <dd></dd></dl>
 279
 280 </dd></dl>
 281
 282 <dl class="enumerator">
 283 <dt id="_CPPv4N20memcached_callback_t29MEMCACHED_CALLBACK_PREFIX_KEYE">
 284 <span id="_CPPv3N20memcached_callback_t29MEMCACHED_CALLBACK_PREFIX_KEYE"></span><span id="_CPPv2N20memcached_callback_t29MEMCACHED_CALLBACK_PREFIX_KEYE"></span><em class="property">enumerator </em><code class="descname">MEMCACHED_CALLBACK_PREFIX_KEY</code><a class="headerlink" href="#_CPPv4N20memcached_callback_t29MEMCACHED_CALLBACK_PREFIX_KEYE" title="Permalink to this definition">¶</a><br /></dt>
 285 <dd><p>See <a class="reference internal" href="#_CPPv4N20memcached_callback_t28MEMCACHED_CALLBACK_NAMESPACEE" title="memcached_callback_t::MEMCACHED_CALLBACK_NAMESPACE"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_CALLBACK_NAMESPACE</span></code></a>.</p>
 286 </dd></dl>
 287
 288 <dl class="enumerator">
 289 <dt id="_CPPv4N20memcached_callback_t28MEMCACHED_CALLBACK_NAMESPACEE">
 290 <span id="_CPPv3N20memcached_callback_t28MEMCACHED_CALLBACK_NAMESPACEE"></span><span id="_CPPv2N20memcached_callback_t28MEMCACHED_CALLBACK_NAMESPACEE"></span><em class="property">enumerator </em><code class="descname">MEMCACHED_CALLBACK_NAMESPACE</code><a class="headerlink" href="#_CPPv4N20memcached_callback_t28MEMCACHED_CALLBACK_NAMESPACEE" title="Permalink to this definition">¶</a><br /></dt>
 291 <dd><p>You can set a value which will be used to create a domain for your keys.
 292 The value specified here will be prefixed to each of your keys. The
 293 value can not be greater then <a class="reference internal" href="constants.html#c.MEMCACHED_MAX_NAMESPACE" title="MEMCACHED_MAX_NAMESPACE"><code class="xref c c-macro docutils literal notranslate"><span class="pre">MEMCACHED_MAX_NAMESPACE</span></code></a> - 1 and
 294 will reduce <a class="reference internal" href="constants.html#c.MEMCACHED_MAX_KEY" title="MEMCACHED_MAX_KEY"><code class="xref c c-macro docutils literal notranslate"><span class="pre">MEMCACHED_MAX_KEY</span></code></a> by the value of your key.</p>
 295 <p>The prefix key is only applied to the primary key, not the master key.
 296 <a class="reference internal" href="memcached_return_t.html#_CPPv4N18memcached_return_t17MEMCACHED_FAILUREE" title="MEMCACHED_FAILURE"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_FAILURE</span></code></a> will be returned if no key is set. In the case of a
 297 key which is too long, <a class="reference internal" href="memcached_return_t.html#_CPPv4N18memcached_return_t26MEMCACHED_BAD_KEY_PROVIDEDE" title="MEMCACHED_BAD_KEY_PROVIDED"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_BAD_KEY_PROVIDED</span></code></a> will be returned.</p>
 298 <p>If you set a value with the value being NULL then the prefix key is
 299 disabled.</p>
 300 </dd></dl>
 301
 302 <dl class="enumerator">
 303 <dt id="_CPPv4N20memcached_callback_t28MEMCACHED_CALLBACK_USER_DATAE">
 304 <span id="_CPPv3N20memcached_callback_t28MEMCACHED_CALLBACK_USER_DATAE"></span><span id="_CPPv2N20memcached_callback_t28MEMCACHED_CALLBACK_USER_DATAE"></span><em class="property">enumerator </em><code class="descname">MEMCACHED_CALLBACK_USER_DATA</code><a class="headerlink" href="#_CPPv4N20memcached_callback_t28MEMCACHED_CALLBACK_USER_DATAE" title="Permalink to this definition">¶</a><br /></dt>
 305 <dd><p>This allows you to store a pointer to a specific piece of data. This can
 306 be retrieved from inside of <a class="reference internal" href="memcached_get.html#_CPPv423memcached_fetch_executeP12memcached_stP20memcached_execute_fnPv8uint32_t" title="memcached_fetch_execute"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_fetch_execute()</span></code></a>. Cloning a
 307 <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> will copy the pointer to the clone.</p>
 308 </dd></dl>
 309
 310 <dl class="enumerator">
 311 <dt id="_CPPv4N20memcached_callback_t34MEMCACHED_CALLBACK_MALLOC_FUNCTIONE">
 312 <span id="_CPPv3N20memcached_callback_t34MEMCACHED_CALLBACK_MALLOC_FUNCTIONE"></span><span id="_CPPv2N20memcached_callback_t34MEMCACHED_CALLBACK_MALLOC_FUNCTIONE"></span><em class="property">enumerator </em><code class="descname">MEMCACHED_CALLBACK_MALLOC_FUNCTION</code><a class="headerlink" href="#_CPPv4N20memcached_callback_t34MEMCACHED_CALLBACK_MALLOC_FUNCTIONE" title="Permalink to this definition">¶</a><br /></dt>
 313 <dd><div class="deprecated">
 314 <p><span class="versionmodified">Deprecated since version &lt;0.32: </span>Use <a class="reference internal" href="memcached_memory_allocators.html#_CPPv431memcached_set_memory_allocatorsP12memcached_st19memcached_malloc_fn17memcached_free_fn20memcached_realloc_fn19memcached_calloc_fnPv" title="memcached_set_memory_allocators"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_set_memory_allocators()</span></code></a> instead.</p>
 315 </div>
 316 </dd></dl>
 317
 318 <dl class="enumerator">
 319 <dt id="_CPPv4N20memcached_callback_t35MEMCACHED_CALLBACK_REALLOC_FUNCTIONE">
 320 <span id="_CPPv3N20memcached_callback_t35MEMCACHED_CALLBACK_REALLOC_FUNCTIONE"></span><span id="_CPPv2N20memcached_callback_t35MEMCACHED_CALLBACK_REALLOC_FUNCTIONE"></span><em class="property">enumerator </em><code class="descname">MEMCACHED_CALLBACK_REALLOC_FUNCTION</code><a class="headerlink" href="#_CPPv4N20memcached_callback_t35MEMCACHED_CALLBACK_REALLOC_FUNCTIONE" title="Permalink to this definition">¶</a><br /></dt>
 321 <dd><div class="deprecated">
 322 <p><span class="versionmodified">Deprecated since version &lt;0.32: </span>Use <a class="reference internal" href="memcached_memory_allocators.html#_CPPv431memcached_set_memory_allocatorsP12memcached_st19memcached_malloc_fn17memcached_free_fn20memcached_realloc_fn19memcached_calloc_fnPv" title="memcached_set_memory_allocators"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_set_memory_allocators()</span></code></a> instead.</p>
 323 </div>
 324 </dd></dl>
 325
 326 <dl class="enumerator">
 327 <dt id="_CPPv4N20memcached_callback_t32MEMCACHED_CALLBACK_FREE_FUNCTIONE">
 328 <span id="_CPPv3N20memcached_callback_t32MEMCACHED_CALLBACK_FREE_FUNCTIONE"></span><span id="_CPPv2N20memcached_callback_t32MEMCACHED_CALLBACK_FREE_FUNCTIONE"></span><em class="property">enumerator </em><code class="descname">MEMCACHED_CALLBACK_FREE_FUNCTION</code><a class="headerlink" href="#_CPPv4N20memcached_callback_t32MEMCACHED_CALLBACK_FREE_FUNCTIONE" title="Permalink to this definition">¶</a><br /></dt>
 329 <dd><div class="deprecated">
 330 <p><span class="versionmodified">Deprecated since version &lt;0.32: </span>Use <a class="reference internal" href="memcached_memory_allocators.html#_CPPv431memcached_set_memory_allocatorsP12memcached_st19memcached_malloc_fn17memcached_free_fn20memcached_realloc_fn19memcached_calloc_fnPv" title="memcached_set_memory_allocators"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_set_memory_allocators()</span></code></a> instead.</p>
 331 </div>
 332 </dd></dl>
 333
 334 <dl class="enumerator">
 335 <dt id="_CPPv4N20memcached_callback_t30MEMCACHED_CALLBACK_GET_FAILUREE">
 336 <span id="_CPPv3N20memcached_callback_t30MEMCACHED_CALLBACK_GET_FAILUREE"></span><span id="_CPPv2N20memcached_callback_t30MEMCACHED_CALLBACK_GET_FAILUREE"></span><em class="property">enumerator </em><code class="descname">MEMCACHED_CALLBACK_GET_FAILURE</code><a class="headerlink" href="#_CPPv4N20memcached_callback_t30MEMCACHED_CALLBACK_GET_FAILUREE" title="Permalink to this definition">¶</a><br /></dt>
 337 <dd><p>This function implements the read through cache behavior. On failure of
 338 retrieval this callback will be called.</p>
 339 <p>You are responsible for populating the result object provided. This
 340 result object will then be stored in the server and returned to the
 341 calling process.</p>
 342 <p>You must clone the <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> in order to make use of it. The value
 343 will be stored only if you return <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> or
 344 <a class="reference internal" href="memcached_return_t.html#_CPPv4N18memcached_return_t18MEMCACHED_BUFFEREDE" title="MEMCACHED_BUFFERED"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_BUFFERED</span></code></a>. Returning <a class="reference internal" href="memcached_return_t.html#_CPPv4N18memcached_return_t18MEMCACHED_BUFFEREDE" title="MEMCACHED_BUFFERED"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_BUFFERED</span></code></a> will cause the
 345 object to be buffered and not sent immediately (if this is the default
 346 behavior based on your connection setup this will happen automatically).</p>
 347 <p>The prototype for this is:</p>
 348 <dl class="type">
 349 <dt id="_CPPv4N20memcached_callback_t30MEMCACHED_CALLBACK_GET_FAILURE21memcached_trigger_keyE">
 350 <span id="_CPPv3N20memcached_callback_t30MEMCACHED_CALLBACK_GET_FAILURE21memcached_trigger_keyE"></span><span id="_CPPv2N20memcached_callback_t30MEMCACHED_CALLBACK_GET_FAILURE21memcached_trigger_keyE"></span><span id="memcached_callback_t::MEMCACHED_CALLBACK_GET_FAILURE::memcached_trigger_key"></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_trigger_key</code>)<span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *ptr, char *key, size_t key_length, <a class="reference internal" href="memcached_result_st.html#_CPPv419memcached_result_st" title="memcached_result_st">memcached_result_st</a> *result<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N20memcached_callback_t30MEMCACHED_CALLBACK_GET_FAILURE21memcached_trigger_keyE" title="Permalink to this definition">¶</a><br /></dt>
 351 <dd></dd></dl>
 352
 353 </dd></dl>
 354
 355 <dl class="enumerator">
 356 <dt id="_CPPv4N20memcached_callback_t33MEMCACHED_CALLBACK_DELETE_TRIGGERE">
 357 <span id="_CPPv3N20memcached_callback_t33MEMCACHED_CALLBACK_DELETE_TRIGGERE"></span><span id="_CPPv2N20memcached_callback_t33MEMCACHED_CALLBACK_DELETE_TRIGGERE"></span><em class="property">enumerator </em><code class="descname">MEMCACHED_CALLBACK_DELETE_TRIGGER</code><a class="headerlink" href="#_CPPv4N20memcached_callback_t33MEMCACHED_CALLBACK_DELETE_TRIGGERE" title="Permalink to this definition">¶</a><br /></dt>
 358 <dd><p>This function implements a trigger upon successful deletion of a key.
 359 The <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> structure will need to be cloned in order to make use
 360 of it.</p>
 361 <p>The prototype for this is:</p>
 362 <dl class="type">
 363 <dt id="_CPPv4N20memcached_callback_t33MEMCACHED_CALLBACK_DELETE_TRIGGER28memcached_trigger_delete_keyE">
 364 <span id="_CPPv3N20memcached_callback_t33MEMCACHED_CALLBACK_DELETE_TRIGGER28memcached_trigger_delete_keyE"></span><span id="_CPPv2N20memcached_callback_t33MEMCACHED_CALLBACK_DELETE_TRIGGER28memcached_trigger_delete_keyE"></span><span id="memcached_callback_t::MEMCACHED_CALLBACK_DELETE_TRIGGER::memcached_trigger_delete_key"></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_trigger_delete_key</code>)<span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *ptr, char *key, size_t key_length<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N20memcached_callback_t33MEMCACHED_CALLBACK_DELETE_TRIGGER28memcached_trigger_delete_keyE" title="Permalink to this definition">¶</a><br /></dt>
 365 <dd></dd></dl>
 366
 367 </dd></dl>
 368
 369 </dd></dl>
 370
 371 </div>
 372 <div class="section" id="description">
 373 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
 374 <p><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">libmemcached</span></code> can have callbacks set key execution points. These either provide
 375 function calls at points in the code, or return pointers to structures for
 376 particular usages.</p>
 377 <p><a class="reference internal" href="#_CPPv422memcached_callback_getP12memcached_st20memcached_callback_tP18memcached_return_t" title="memcached_callback_get"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_callback_get()</span></code></a> takes a callback flag and returns the structure or
 378 function set by <a class="reference internal" href="#_CPPv422memcached_callback_setP12memcached_st20memcached_callback_tPKv" title="memcached_callback_set"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_callback_set()</span></code></a>.</p>
 379 <p><a class="reference internal" href="#_CPPv422memcached_callback_setP12memcached_st20memcached_callback_tPKv" title="memcached_callback_set"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_callback_set()</span></code></a> changes the function/structure assigned by a callback
 380 flag. No connections are reset.</p>
 381 <p>You can use <a class="reference internal" href="#_CPPv4N20memcached_callback_t28MEMCACHED_CALLBACK_USER_DATAE" title="MEMCACHED_CALLBACK_USER_DATA"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_CALLBACK_USER_DATA</span></code></a> to provide custom context if required
 382 for any of the callbacks.</p>
 383 </div>
 384 <div class="section" id="return-value">
 385 <h2>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
 386 <p><a class="reference internal" href="#_CPPv422memcached_callback_getP12memcached_st20memcached_callback_tP18memcached_return_t" title="memcached_callback_get"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_callback_get()</span></code></a> returns the function or structure that was provided.
 387 Upon error, nothing is set, NULL is returned, and the <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>
 388 argument is set to <a class="reference internal" href="memcached_return_t.html#_CPPv4N18memcached_return_t17MEMCACHED_FAILUREE" title="MEMCACHED_FAILURE"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_FAILURE</span></code></a>.</p>
 389 <p><a class="reference internal" href="#_CPPv422memcached_callback_setP12memcached_st20memcached_callback_tPKv" title="memcached_callback_set"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_callback_set()</span></code></a> returns <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> upon successful setting,
 390 otherwise <a class="reference internal" href="memcached_return_t.html#_CPPv4N18memcached_return_t17MEMCACHED_FAILUREE" title="MEMCACHED_FAILURE"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_FAILURE</span></code></a> on error.</p>
 391 </div>
 392 <div class="section" id="see-also">
 393 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
 394 <ul class="simple">
 395 <li><em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/1/memcached">memcached(1)</a></em></li>
 396 <li><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></li>
 397 <li><a class="reference internal" href="memcached_strerror.html"><span class="doc">Converting Error Codes to Messages</span></a></li>
 398 </ul>
 399 </div>
 400 </div>
 401
 402
 403            </div>
 404
 405           </div>
 406           <footer>
 407
 408     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 409
 410         <a href="memcached_memory_allocators.html" class="btn btn-neutral float-right" title="Use custom allocators for embedded usage" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 411
 412
 413         <a href="memcached_behavior.html" class="btn btn-neutral float-left" title="Behaviors of the library" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 414
 415     </div>
 416
 417
 418   <hr/>
 419
 420   <div role="contentinfo">
 421     <p>
 422         &copy; <a href="../copyright.html">Copyright</a>
 423
 424     </p>
 425   </div>
 426   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>.
 427
 428 </footer>
 429
 430         </div>
 431       </div>
 432
 433     </section>
 434
 435   </div>
 436
 437
 438
 439   <script type="text/javascript">
 440       jQuery(function () {
 441           SphinxRtdTheme.Navigation.enable(true);
 442       });
 443   </script>
 444
 445
 446
 447
 448
 449
 450 </body>
 451 </html>