git.m6w6.name Git - m6w6/libmemcached/blob - libmemcached/memcached_memory_allocators.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>Use custom allocators for embedded usage &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="Storing custom information in the client" href="memcached_user_data.html" />
  40     <link rel="prev" title="Library callbacks" href="memcached_callback.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"><a class="reference internal" href="memcached_callback.html">Library callbacks</a></li>
  99 <li class="toctree-l4 current"><a class="current reference internal" href="#">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>Use custom allocators for embedded usage</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="use-custom-allocators-for-embedded-usage">
 200 <h1>Use custom allocators for embedded usage<a class="headerlink" href="#use-custom-allocators-for-embedded-usage" title="Permalink to this headline">¶</a></h1>
 201 <p>Manage memory allocator functions</p>
 202 <div class="section" id="synopsis">
 203 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
 204 <dl class="docutils">
 205 <dt>#include &lt;libmemcached/memcached.h&gt;</dt>
 206 <dd>Compile and link with -lmemcached</dd>
 207 </dl>
 208 <dl class="function">
 209 <dt id="_CPPv431memcached_set_memory_allocatorsP12memcached_st19memcached_malloc_fn17memcached_free_fn20memcached_realloc_fn19memcached_calloc_fnPv">
 210 <span id="_CPPv331memcached_set_memory_allocatorsP12memcached_st19memcached_malloc_fn17memcached_free_fn20memcached_realloc_fn19memcached_calloc_fnPv"></span><span id="_CPPv231memcached_set_memory_allocatorsP12memcached_st19memcached_malloc_fn17memcached_free_fn20memcached_realloc_fn19memcached_calloc_fnPv"></span><span id="memcached_set_memory_allocators__memcached_stP.memcached_malloc_fn.memcached_free_fn.memcached_realloc_fn.memcached_calloc_fn.voidP"></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_set_memory_allocators</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="#_CPPv419memcached_malloc_fn" title="memcached_malloc_fn">memcached_malloc_fn</a> <em>mem_malloc</em>, <a class="reference internal" href="#_CPPv417memcached_free_fn" title="memcached_free_fn">memcached_free_fn</a> <em>mem_free</em>, <a class="reference internal" href="#_CPPv420memcached_realloc_fn" title="memcached_realloc_fn">memcached_realloc_fn</a> <em>mem_realloc</em>, <a class="reference internal" href="#_CPPv419memcached_calloc_fn" title="memcached_calloc_fn">memcached_calloc_fn</a> <em>mem_calloc</em>, void *<em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv431memcached_set_memory_allocatorsP12memcached_st19memcached_malloc_fn17memcached_free_fn20memcached_realloc_fn19memcached_calloc_fnPv" title="Permalink to this definition">¶</a><br /></dt>
 211 <dd><table class="docutils field-list" frame="void" rules="none">
 212 <col class="field-name" />
 213 <col class="field-body" />
 214 <tbody valign="top">
 215 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 216 <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>
 217 <li><strong>mem_malloc</strong> -- pointer to a <a class="reference internal" href="#_CPPv419memcached_malloc_fn" title="memcached_malloc_fn"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_malloc_fn</span></code></a> callback</li>
 218 <li><strong>mem_free</strong> -- pointer to a <a class="reference internal" href="#_CPPv417memcached_free_fn" title="memcached_free_fn"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_free_fn</span></code></a> callback</li>
 219 <li><strong>mem_realloc</strong> -- pointer to a <a class="reference internal" href="#_CPPv420memcached_realloc_fn" title="memcached_realloc_fn"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_realloc_fn</span></code></a> callback</li>
 220 <li><strong>mem_calloc</strong> -- pointer to a <a class="reference internal" href="#_CPPv419memcached_calloc_fn" title="memcached_calloc_fn"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_calloc_fn</span></code></a> callback</li>
 221 <li><strong>context</strong> -- pointer to a user supplied context</li>
 222 </ul>
 223 </td>
 224 </tr>
 225 <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>
 226 </td>
 227 </tr>
 228 </tbody>
 229 </table>
 230 </dd></dl>
 231
 232 <dl class="function">
 233 <dt id="_CPPv431memcached_get_memory_allocatorsP12memcached_stP19memcached_malloc_fnP17memcached_free_fnP20memcached_realloc_fnP19memcached_calloc_fn">
 234 <span id="_CPPv331memcached_get_memory_allocatorsP12memcached_stP19memcached_malloc_fnP17memcached_free_fnP20memcached_realloc_fnP19memcached_calloc_fn"></span><span id="_CPPv231memcached_get_memory_allocatorsP12memcached_stP19memcached_malloc_fnP17memcached_free_fnP20memcached_realloc_fnP19memcached_calloc_fn"></span><span id="memcached_get_memory_allocators__memcached_stP.memcached_malloc_fnP.memcached_free_fnP.memcached_realloc_fnP.memcached_calloc_fnP"></span>void <code class="descname">memcached_get_memory_allocators</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="#_CPPv419memcached_malloc_fn" title="memcached_malloc_fn">memcached_malloc_fn</a> *<em>mem_malloc</em>, <a class="reference internal" href="#_CPPv417memcached_free_fn" title="memcached_free_fn">memcached_free_fn</a> *<em>mem_free</em>, <a class="reference internal" href="#_CPPv420memcached_realloc_fn" title="memcached_realloc_fn">memcached_realloc_fn</a> *<em>mem_realloc</em>, <a class="reference internal" href="#_CPPv419memcached_calloc_fn" title="memcached_calloc_fn">memcached_calloc_fn</a> *<em>mem_calloc</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv431memcached_get_memory_allocatorsP12memcached_stP19memcached_malloc_fnP17memcached_free_fnP20memcached_realloc_fnP19memcached_calloc_fn" title="Permalink to this definition">¶</a><br /></dt>
 235 <dd><table class="docutils field-list" frame="void" rules="none">
 236 <col class="field-name" />
 237 <col class="field-body" />
 238 <tbody valign="top">
 239 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 240 <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>
 241 <li><strong>mem_malloc</strong> -- pointer to store the address of the <a class="reference internal" href="#_CPPv419memcached_malloc_fn" title="memcached_malloc_fn"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_malloc_fn</span></code></a> callback</li>
 242 <li><strong>mem_free</strong> -- pointer to store the address of the <a class="reference internal" href="#_CPPv417memcached_free_fn" title="memcached_free_fn"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_free_fn</span></code></a> callback</li>
 243 <li><strong>mem_realloc</strong> -- pointer to store the address of the <a class="reference internal" href="#_CPPv420memcached_realloc_fn" title="memcached_realloc_fn"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_realloc_fn</span></code></a> callback</li>
 244 <li><strong>mem_calloc</strong> -- pointer to store the address of the <a class="reference internal" href="#_CPPv419memcached_calloc_fn" title="memcached_calloc_fn"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_calloc_fn</span></code></a> callback</li>
 245 </ul>
 246 </td>
 247 </tr>
 248 </tbody>
 249 </table>
 250 </dd></dl>
 251
 252 <dl class="function">
 253 <dt id="_CPPv439memcached_get_memory_allocators_contextPK12memcached_st">
 254 <span id="_CPPv339memcached_get_memory_allocators_contextPK12memcached_st"></span><span id="_CPPv239memcached_get_memory_allocators_contextPK12memcached_st"></span><span id="memcached_get_memory_allocators_context__memcached_stCP"></span>void *<code class="descname">memcached_get_memory_allocators_context</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> *<em>ptr</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv439memcached_get_memory_allocators_contextPK12memcached_st" title="Permalink to this definition">¶</a><br /></dt>
 255 <dd><table class="docutils field-list" frame="void" rules="none">
 256 <col class="field-name" />
 257 <col class="field-body" />
 258 <tbody valign="top">
 259 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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</td>
 260 </tr>
 261 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">pointer to the user supplied context</td>
 262 </tr>
 263 </tbody>
 264 </table>
 265 </dd></dl>
 266
 267 <dl class="type">
 268 <dt id="_CPPv419memcached_malloc_fn">
 269 <span id="_CPPv319memcached_malloc_fn"></span><span id="_CPPv219memcached_malloc_fn"></span><span id="memcached_malloc_fn"></span><em class="property">typedef </em>void *(*<code class="descname">memcached_malloc_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> size_t size, void *context<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv419memcached_malloc_fn" title="Permalink to this definition">¶</a><br /></dt>
 270 <dd><table class="docutils field-list" frame="void" rules="none">
 271 <col class="field-name" />
 272 <col class="field-body" />
 273 <tbody valign="top">
 274 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 275 <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>
 276 <li><strong>size</strong> -- the number of bytes to allocate</li>
 277 <li><strong>context</strong> -- pointer to the user supplied context</li>
 278 </ul>
 279 </td>
 280 </tr>
 281 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">pointer to at least <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">size</span></code> bytes of allocated memory</p>
 282 </td>
 283 </tr>
 284 </tbody>
 285 </table>
 286 </dd></dl>
 287
 288 <dl class="type">
 289 <dt id="_CPPv420memcached_realloc_fn">
 290 <span id="_CPPv320memcached_realloc_fn"></span><span id="_CPPv220memcached_realloc_fn"></span><span id="memcached_realloc_fn"></span><em class="property">typedef </em>void *(*<code class="descname">memcached_realloc_fn</code>)<span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *ptr, void *mem, <em class="property">const</em> size_t size, void *context<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv420memcached_realloc_fn" title="Permalink to this definition">¶</a><br /></dt>
 291 <dd><table class="docutils field-list" frame="void" rules="none">
 292 <col class="field-name" />
 293 <col class="field-body" />
 294 <tbody valign="top">
 295 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 296 <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>
 297 <li><strong>mem</strong> -- pointer to previously allocated memory</li>
 298 <li><strong>size</strong> -- the number of bytes to allocate</li>
 299 <li><strong>context</strong> -- pointer to the user supplied context</li>
 300 </ul>
 301 </td>
 302 </tr>
 303 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">pointer to at least <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">size</span></code> bytes of allocated memory</p>
 304 </td>
 305 </tr>
 306 </tbody>
 307 </table>
 308 </dd></dl>
 309
 310 <dl class="type">
 311 <dt id="_CPPv417memcached_free_fn">
 312 <span id="_CPPv317memcached_free_fn"></span><span id="_CPPv217memcached_free_fn"></span><span id="memcached_free_fn"></span><em class="property">typedef </em>void (*<code class="descname">memcached_free_fn</code>)<span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *ptr, void *mem, void *context<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv417memcached_free_fn" title="Permalink to this definition">¶</a><br /></dt>
 313 <dd><table class="docutils field-list" frame="void" rules="none">
 314 <col class="field-name" />
 315 <col class="field-body" />
 316 <tbody valign="top">
 317 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 318 <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>
 319 <li><strong>mem</strong> -- pointer to previously allocated memory</li>
 320 <li><strong>context</strong> -- pointer to the user supplied context</li>
 321 </ul>
 322 </td>
 323 </tr>
 324 </tbody>
 325 </table>
 326 </dd></dl>
 327
 328 <dl class="type">
 329 <dt id="_CPPv419memcached_calloc_fn">
 330 <span id="_CPPv319memcached_calloc_fn"></span><span id="_CPPv219memcached_calloc_fn"></span><span id="memcached_calloc_fn"></span><em class="property">typedef </em>void *(*<code class="descname">memcached_calloc_fn</code>)<span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *ptr, size_t nelem, <em class="property">const</em> size_t elsize, void *context<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv419memcached_calloc_fn" title="Permalink to this definition">¶</a><br /></dt>
 331 <dd><table class="docutils field-list" frame="void" rules="none">
 332 <col class="field-name" />
 333 <col class="field-body" />
 334 <tbody valign="top">
 335 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 336 <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>
 337 <li><strong>nelem</strong> -- number of elements to allocate</li>
 338 <li><strong>elsize</strong> -- the number of bytes to allocate per element</li>
 339 <li><strong>context</strong> -- pointer to the user supplied context</li>
 340 </ul>
 341 </td>
 342 </tr>
 343 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">pointer to at least <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">elsize</span></code> * <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">nelem</span></code>  bytes of allocated and zeroed memory</p>
 344 </td>
 345 </tr>
 346 </tbody>
 347 </table>
 348 </dd></dl>
 349
 350 </div>
 351 <div class="section" id="description">
 352 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
 353 <p><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">libmemcached</span></code> allows you to specify your own memory allocators, optimized for
 354 your application. This enables libmemcached to be used inside of applications
 355 that have their own malloc implementation.</p>
 356 <p><a class="reference internal" href="#_CPPv431memcached_set_memory_allocatorsP12memcached_st19memcached_malloc_fn17memcached_free_fn20memcached_realloc_fn19memcached_calloc_fnPv" title="memcached_set_memory_allocators"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_set_memory_allocators()</span></code></a> is used to set the memory allocators
 357 used by the memcached instance specified by ptr. Please note that you cannot
 358 override only one of the memory allocators, you have to specify a complete new
 359 set if you want to override one of them. All of the memory allocation functions
 360 should behave as specified in the C99 standard. Specify NULL as all functions to
 361 reset them to the default values.</p>
 362 <p><a class="reference internal" href="#_CPPv431memcached_get_memory_allocatorsP12memcached_stP19memcached_malloc_fnP17memcached_free_fnP20memcached_realloc_fnP19memcached_calloc_fn" title="memcached_get_memory_allocators"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_get_memory_allocators()</span></code></a> is used to get the currently used memory
 363 allocators by a memcached handle.</p>
 364 <p><a class="reference internal" href="#_CPPv439memcached_get_memory_allocators_contextPK12memcached_st" title="memcached_get_memory_allocators_context"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_get_memory_allocators_context()</span></code></a> returns the void * that was
 365 passed in during the call to <a class="reference internal" href="#_CPPv431memcached_set_memory_allocatorsP12memcached_st19memcached_malloc_fn17memcached_free_fn20memcached_realloc_fn19memcached_calloc_fnPv" title="memcached_set_memory_allocators"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_set_memory_allocators()</span></code></a>.</p>
 366 <p>The first argument to the memory allocator functions is a pointer to a memcached
 367 structure, the is passed as const and you will need to clone it in order to make
 368 use of any operation which would modify it.</p>
 369 </div>
 370 <div class="section" id="notes">
 371 <h2>NOTES<a class="headerlink" href="#notes" title="Permalink to this headline">¶</a></h2>
 372 <p>In version 0.38 all functions were modified to have a context void pointer
 373 passed to them. This was so that custom allocators could have their own space
 374 for memory.</p>
 375 </div>
 376 <div class="section" id="return-value">
 377 <h2>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
 378 <p><a class="reference internal" href="#_CPPv431memcached_set_memory_allocatorsP12memcached_st19memcached_malloc_fn17memcached_free_fn20memcached_realloc_fn19memcached_calloc_fnPv" title="memcached_set_memory_allocators"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_set_memory_allocators()</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 success,
 379 and <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> if you don't pass a complete set of function pointers.</p>
 380 </div>
 381 <div class="section" id="see-also">
 382 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
 383 <ul class="simple">
 384 <li><em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/1/memcached">memcached(1)</a></em></li>
 385 <li><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></li>
 386 <li><a class="reference internal" href="memcached_strerror.html"><span class="doc">Converting Error Codes to Messages</span></a></li>
 387 </ul>
 388 </div>
 389 </div>
 390
 391
 392            </div>
 393
 394           </div>
 395           <footer>
 396
 397     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 398
 399         <a href="memcached_user_data.html" class="btn btn-neutral float-right" title="Storing custom information in the client" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 400
 401
 402         <a href="memcached_callback.html" class="btn btn-neutral float-left" title="Library callbacks" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 403
 404     </div>
 405
 406
 407   <hr/>
 408
 409   <div role="contentinfo">
 410     <p>
 411         &copy; <a href="../copyright.html">Copyright</a>
 412
 413     </p>
 414   </div>
 415   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>.
 416
 417 </footer>
 418
 419         </div>
 420       </div>
 421
 422     </section>
 423
 424   </div>
 425
 426
 427
 428   <script type="text/javascript">
 429       jQuery(function () {
 430           SphinxRtdTheme.Navigation.enable(true);
 431       });
 432   </script>
 433
 434
 435
 436
 437
 438
 439 </body>
 440 </html>