git.m6w6.name Git - m6w6/libmemcached/blob - 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  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 src="_static/jquery.js"></script>
  25         <script src="_static/underscore.js"></script>
  26         <script src="_static/doctools.js"></script>
  27         <script 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="Disconnecting a client from a server" href="memcached_quit.html" />
  40     <link rel="prev" title="Generating hash values directly" href="memcached_generate_hash_value.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
  64
  65
  66 <div role="search">
  67   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
  68     <input type="text" name="q" placeholder="Search docs" />
  69     <input type="hidden" name="check_keywords" value="yes" />
  70     <input type="hidden" name="area" value="default" />
  71   </form>
  72 </div>
  73
  74
  75         </div>
  76
  77         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  78
  79
  80
  81
  82
  83
  84               <p class="caption"><span class="caption-text">Basics</span></p>
  85 <ul>
  86 <li class="toctree-l1"><a class="reference internal" href="libmemcached.html">Introducing the C Client Library for memcached</a><ul>
  87 <li class="toctree-l2"><a class="reference internal" href="libmemcached.html#synopsis">SYNOPSIS</a></li>
  88 <li class="toctree-l2"><a class="reference internal" href="libmemcached.html#description">DESCRIPTION</a></li>
  89 <li class="toctree-l2"><a class="reference internal" href="libmemcached.html#constants">CONSTANTS</a></li>
  90 <li class="toctree-l2"><a class="reference internal" href="libmemcached.html#threads-and-processes">THREADS AND PROCESSES</a></li>
  91 <li class="toctree-l2"><a class="reference internal" href="libmemcached.html#home">HOME</a></li>
  92 <li class="toctree-l2"><a class="reference internal" href="libmemcached.html#see-also">SEE ALSO</a></li>
  93 </ul>
  94 </li>
  95 <li class="toctree-l1"><a class="reference internal" href="versioning.html">Versioning</a></li>
  96 <li class="toctree-l1"><a class="reference internal" href="memcached_create.html">Creating and destroying a memcached_st</a><ul>
  97 <li class="toctree-l2"><a class="reference internal" href="memcached_create.html#synopsis">SYNOPSIS</a></li>
  98 <li class="toctree-l2"><a class="reference internal" href="memcached_create.html#description">DESCRIPTION</a></li>
  99 <li class="toctree-l2"><a class="reference internal" href="memcached_create.html#return">RETURN</a></li>
 100 <li class="toctree-l2"><a class="reference internal" href="memcached_create.html#home">HOME</a></li>
 101 <li class="toctree-l2"><a class="reference internal" href="memcached_create.html#see-also">SEE ALSO</a></li>
 102 </ul>
 103 </li>
 104 <li class="toctree-l1"><a class="reference internal" href="libmemcached_examples.html">Examples</a><ul>
 105 <li class="toctree-l2"><a class="reference internal" href="libmemcached_examples.html#description">DESCRIPTION</a></li>
 106 <li class="toctree-l2"><a class="reference internal" href="libmemcached_examples.html#connecting-to-servers">Connecting to servers</a></li>
 107 <li class="toctree-l2"><a class="reference internal" href="libmemcached_examples.html#creating-a-pool-of-servers">Creating a pool of servers</a></li>
 108 <li class="toctree-l2"><a class="reference internal" href="libmemcached_examples.html#adding-a-value-to-the-server">Adding a value to the server</a></li>
 109 <li class="toctree-l2"><a class="reference internal" href="libmemcached_examples.html#fetching-multiple-values">Fetching multiple values</a></li>
 110 <li class="toctree-l2"><a class="reference internal" href="libmemcached_examples.html#home">HOME</a></li>
 111 <li class="toctree-l2"><a class="reference internal" href="libmemcached_examples.html#see-also">SEE ALSO</a></li>
 112 </ul>
 113 </li>
 114 <li class="toctree-l1"><a class="reference internal" href="libmemcached_configuration.html">Configuring Libmemcached</a><ul>
 115 <li class="toctree-l2"><a class="reference internal" href="libmemcached_configuration.html#synopsis">SYNOPSIS</a></li>
 116 <li class="toctree-l2"><a class="reference internal" href="libmemcached_configuration.html#description">DESCRIPTION</a></li>
 117 <li class="toctree-l2"><a class="reference internal" href="libmemcached_configuration.html#return">RETURN</a></li>
 118 <li class="toctree-l2"><a class="reference internal" href="libmemcached_configuration.html#example">EXAMPLE</a></li>
 119 <li class="toctree-l2"><a class="reference internal" href="libmemcached_configuration.html#home">HOME</a></li>
 120 <li class="toctree-l2"><a class="reference internal" href="libmemcached_configuration.html#see-also">SEE ALSO</a></li>
 121 </ul>
 122 </li>
 123 <li class="toctree-l1"><a class="reference internal" href="libmemcached/memcached_last_error_message.html">Retrieving errors</a><ul>
 124 <li class="toctree-l2"><a class="reference internal" href="libmemcached/memcached_last_error_message.html#synopsis">SYNOPSIS</a></li>
 125 <li class="toctree-l2"><a class="reference internal" href="libmemcached/memcached_last_error_message.html#description">DESCRIPTION</a></li>
 126 <li class="toctree-l2"><a class="reference internal" href="libmemcached/memcached_last_error_message.html#return">RETURN</a></li>
 127 <li class="toctree-l2"><a class="reference internal" href="libmemcached/memcached_last_error_message.html#home">HOME</a></li>
 128 <li class="toctree-l2"><a class="reference internal" href="libmemcached/memcached_last_error_message.html#see-also">SEE ALSO</a></li>
 129 </ul>
 130 </li>
 131 </ul>
 132 <p class="caption"><span class="caption-text">Working with Data</span></p>
 133 <ul>
 134 <li class="toctree-l1"><a class="reference internal" href="memcached_auto.html">Incrementing and Decrementing Values</a><ul>
 135 <li class="toctree-l2"><a class="reference internal" href="memcached_auto.html#synopsis">SYNOPSIS</a></li>
 136 <li class="toctree-l2"><a class="reference internal" href="memcached_auto.html#description">DESCRIPTION</a></li>
 137 <li class="toctree-l2"><a class="reference internal" href="memcached_auto.html#return">RETURN</a></li>
 138 <li class="toctree-l2"><a class="reference internal" href="memcached_auto.html#home">HOME</a></li>
 139 <li class="toctree-l2"><a class="reference internal" href="memcached_auto.html#see-also">SEE ALSO</a></li>
 140 </ul>
 141 </li>
 142 <li class="toctree-l1"><a class="reference internal" href="memcached_delete.html">Deleting data from a server</a><ul>
 143 <li class="toctree-l2"><a class="reference internal" href="memcached_delete.html#synopsis">SYNOPSIS</a></li>
 144 <li class="toctree-l2"><a class="reference internal" href="memcached_delete.html#description">DESCRIPTION</a></li>
 145 <li class="toctree-l2"><a class="reference internal" href="memcached_delete.html#return">RETURN</a></li>
 146 <li class="toctree-l2"><a class="reference internal" href="memcached_delete.html#home">HOME</a></li>
 147 <li class="toctree-l2"><a class="reference internal" href="memcached_delete.html#author">AUTHOR</a></li>
 148 <li class="toctree-l2"><a class="reference internal" href="memcached_delete.html#see-also">SEE ALSO</a></li>
 149 </ul>
 150 </li>
 151 <li class="toctree-l1"><a class="reference internal" href="libmemcached/memcached_exist.html">Determine if a keys exists.</a><ul>
 152 <li class="toctree-l2"><a class="reference internal" href="libmemcached/memcached_exist.html#synopsis">SYNOPSIS</a></li>
 153 <li class="toctree-l2"><a class="reference internal" href="libmemcached/memcached_exist.html#description">DESCRIPTION</a></li>
 154 <li class="toctree-l2"><a class="reference internal" href="libmemcached/memcached_exist.html#return">RETURN</a></li>
 155 <li class="toctree-l2"><a class="reference internal" href="libmemcached/memcached_exist.html#home">HOME</a></li>
 156 <li class="toctree-l2"><a class="reference internal" href="libmemcached/memcached_exist.html#see-also">SEE ALSO</a></li>
 157 </ul>
 158 </li>
 159 <li class="toctree-l1"><a class="reference internal" href="memcached_flush_buffers.html">Flushing client buffers</a><ul>
 160 <li class="toctree-l2"><a class="reference internal" href="memcached_flush_buffers.html#synopsis">SYNOPSIS</a></li>
 161 <li class="toctree-l2"><a class="reference internal" href="memcached_flush_buffers.html#description">DESCRIPTION</a></li>
 162 <li class="toctree-l2"><a class="reference internal" href="memcached_flush_buffers.html#return">RETURN</a></li>
 163 <li class="toctree-l2"><a class="reference internal" href="memcached_flush_buffers.html#home">HOME</a></li>
 164 <li class="toctree-l2"><a class="reference internal" href="memcached_flush_buffers.html#author">AUTHOR</a></li>
 165 <li class="toctree-l2"><a class="reference internal" href="memcached_flush_buffers.html#see-also">SEE ALSO</a></li>
 166 </ul>
 167 </li>
 168 <li class="toctree-l1"><a class="reference internal" href="memcached_flush.html">Wiping clean the contents of a server</a><ul>
 169 <li class="toctree-l2"><a class="reference internal" href="memcached_flush.html#synopsis">SYNOPSIS</a></li>
 170 <li class="toctree-l2"><a class="reference internal" href="memcached_flush.html#description">DESCRIPTION</a></li>
 171 <li class="toctree-l2"><a class="reference internal" href="memcached_flush.html#return">RETURN</a></li>
 172 <li class="toctree-l2"><a class="reference internal" href="memcached_flush.html#home">HOME</a></li>
 173 <li class="toctree-l2"><a class="reference internal" href="memcached_flush.html#author">AUTHOR</a></li>
 174 <li class="toctree-l2"><a class="reference internal" href="memcached_flush.html#see-also">SEE ALSO</a></li>
 175 </ul>
 176 </li>
 177 <li class="toctree-l1"><a class="reference internal" href="memcached_get.html">Retrieving data from the server</a><ul>
 178 <li class="toctree-l2"><a class="reference internal" href="memcached_get.html#synopsis">SYNOPSIS</a></li>
 179 <li class="toctree-l2"><a class="reference internal" href="memcached_get.html#description">DESCRIPTION</a></li>
 180 <li class="toctree-l2"><a class="reference internal" href="memcached_get.html#return">RETURN</a></li>
 181 <li class="toctree-l2"><a class="reference internal" href="memcached_get.html#home">HOME</a></li>
 182 <li class="toctree-l2"><a class="reference internal" href="memcached_get.html#see-also">SEE ALSO</a></li>
 183 </ul>
 184 </li>
 185 <li class="toctree-l1"><a class="reference internal" href="memcached_result_st.html">Working with result sets</a><ul>
 186 <li class="toctree-l2"><a class="reference internal" href="memcached_result_st.html#synopsis">SYNOPSIS</a></li>
 187 <li class="toctree-l2"><a class="reference internal" href="memcached_result_st.html#description">DESCRIPTION</a></li>
 188 <li class="toctree-l2"><a class="reference internal" href="memcached_result_st.html#return">RETURN</a></li>
 189 <li class="toctree-l2"><a class="reference internal" href="memcached_result_st.html#home">HOME</a></li>
 190 <li class="toctree-l2"><a class="reference internal" href="memcached_result_st.html#see-also">SEE ALSO</a></li>
 191 </ul>
 192 </li>
 193 <li class="toctree-l1"><a class="reference internal" href="memcached_set.html">Store, replace, add, or atomically add data to the server</a><ul>
 194 <li class="toctree-l2"><a class="reference internal" href="memcached_set.html#synopsis">SYNOPSIS</a></li>
 195 <li class="toctree-l2"><a class="reference internal" href="memcached_set.html#description">DESCRIPTION</a></li>
 196 <li class="toctree-l2"><a class="reference internal" href="memcached_set.html#return">RETURN</a></li>
 197 <li class="toctree-l2"><a class="reference internal" href="memcached_set.html#home">HOME</a></li>
 198 <li class="toctree-l2"><a class="reference internal" href="memcached_set.html#see-also">SEE ALSO</a></li>
 199 </ul>
 200 </li>
 201 <li class="toctree-l1"><a class="reference internal" href="memcached_append.html">Appending or Prepending to data on the server</a><ul>
 202 <li class="toctree-l2"><a class="reference internal" href="memcached_append.html#synopsis">SYNOPSIS</a></li>
 203 <li class="toctree-l2"><a class="reference internal" href="memcached_append.html#description">DESCRIPTION</a></li>
 204 <li class="toctree-l2"><a class="reference internal" href="memcached_append.html#return">RETURN</a></li>
 205 <li class="toctree-l2"><a class="reference internal" href="memcached_append.html#home">HOME</a></li>
 206 <li class="toctree-l2"><a class="reference internal" href="memcached_append.html#see-also">SEE ALSO</a></li>
 207 </ul>
 208 </li>
 209 <li class="toctree-l1"><a class="reference internal" href="memcached_cas.html">Working with data on the server in an atomic fashion</a><ul>
 210 <li class="toctree-l2"><a class="reference internal" href="memcached_cas.html#synopsis">SYNOPSIS</a></li>
 211 <li class="toctree-l2"><a class="reference internal" href="memcached_cas.html#description">DESCRIPTION</a></li>
 212 <li class="toctree-l2"><a class="reference internal" href="memcached_cas.html#return">RETURN</a></li>
 213 <li class="toctree-l2"><a class="reference internal" href="memcached_cas.html#home">HOME</a></li>
 214 <li class="toctree-l2"><a class="reference internal" href="memcached_cas.html#see-also">SEE ALSO</a></li>
 215 </ul>
 216 </li>
 217 </ul>
 218 <p class="caption"><span class="caption-text">Advanced Topics</span></p>
 219 <ul class="current">
 220 <li class="toctree-l1"><a class="reference internal" href="libmemcached-1.0/memcached_set_encoding_key.html">Set encryption key</a><ul>
 221 <li class="toctree-l2"><a class="reference internal" href="libmemcached-1.0/memcached_set_encoding_key.html#synopsis">SYNOPSIS</a></li>
 222 <li class="toctree-l2"><a class="reference internal" href="libmemcached-1.0/memcached_set_encoding_key.html#description">DESCRIPTION</a></li>
 223 <li class="toctree-l2"><a class="reference internal" href="libmemcached-1.0/memcached_set_encoding_key.html#return">RETURN</a></li>
 224 <li class="toctree-l2"><a class="reference internal" href="libmemcached-1.0/memcached_set_encoding_key.html#home">HOME</a></li>
 225 <li class="toctree-l2"><a class="reference internal" href="libmemcached-1.0/memcached_set_encoding_key.html#author">AUTHOR</a></li>
 226 <li class="toctree-l2"><a class="reference internal" href="libmemcached-1.0/memcached_set_encoding_key.html#see-also">SEE ALSO</a></li>
 227 </ul>
 228 </li>
 229 <li class="toctree-l1"><a class="reference internal" href="memcached_behavior.html">Modifying how the driver behaves</a><ul>
 230 <li class="toctree-l2"><a class="reference internal" href="memcached_behavior.html#synopsis">SYNOPSIS</a></li>
 231 <li class="toctree-l2"><a class="reference internal" href="memcached_behavior.html#description">DESCRIPTION</a></li>
 232 <li class="toctree-l2"><a class="reference internal" href="memcached_behavior.html#return">RETURN</a></li>
 233 <li class="toctree-l2"><a class="reference internal" href="memcached_behavior.html#notes">NOTES</a></li>
 234 <li class="toctree-l2"><a class="reference internal" href="memcached_behavior.html#home">HOME</a></li>
 235 <li class="toctree-l2"><a class="reference internal" href="memcached_behavior.html#see-also">SEE ALSO</a></li>
 236 </ul>
 237 </li>
 238 <li class="toctree-l1"><a class="reference internal" href="memcached_callback.html">Setting callbacks</a><ul>
 239 <li class="toctree-l2"><a class="reference internal" href="memcached_callback.html#synopsis">SYNOPSIS</a></li>
 240 <li class="toctree-l2"><a class="reference internal" href="memcached_callback.html#description">DESCRIPTION</a></li>
 241 <li class="toctree-l2"><a class="reference internal" href="memcached_callback.html#return">RETURN</a></li>
 242 <li class="toctree-l2"><a class="reference internal" href="memcached_callback.html#home">HOME</a></li>
 243 <li class="toctree-l2"><a class="reference internal" href="memcached_callback.html#author">AUTHOR</a></li>
 244 <li class="toctree-l2"><a class="reference internal" href="memcached_callback.html#see-also">SEE ALSO</a></li>
 245 </ul>
 246 </li>
 247 <li class="toctree-l1"><a class="reference internal" href="memcached_dump.html">Dumping data from a server</a><ul>
 248 <li class="toctree-l2"><a class="reference internal" href="memcached_dump.html#synopsis">SYNOPSIS</a></li>
 249 <li class="toctree-l2"><a class="reference internal" href="memcached_dump.html#description">DESCRIPTION</a></li>
 250 <li class="toctree-l2"><a class="reference internal" href="memcached_dump.html#return">RETURN</a></li>
 251 <li class="toctree-l2"><a class="reference internal" href="memcached_dump.html#home">HOME</a></li>
 252 <li class="toctree-l2"><a class="reference internal" href="memcached_dump.html#author">AUTHOR</a></li>
 253 <li class="toctree-l2"><a class="reference internal" href="memcached_dump.html#see-also">SEE ALSO</a></li>
 254 </ul>
 255 </li>
 256 <li class="toctree-l1"><a class="reference internal" href="memcached_generate_hash_value.html">Generating hash values directly</a><ul>
 257 <li class="toctree-l2"><a class="reference internal" href="memcached_generate_hash_value.html#synopsis">SYNOPSIS</a></li>
 258 <li class="toctree-l2"><a class="reference internal" href="memcached_generate_hash_value.html#description">DESCRIPTION</a></li>
 259 <li class="toctree-l2"><a class="reference internal" href="memcached_generate_hash_value.html#return">RETURN</a></li>
 260 <li class="toctree-l2"><a class="reference internal" href="memcached_generate_hash_value.html#home">HOME</a></li>
 261 <li class="toctree-l2"><a class="reference internal" href="memcached_generate_hash_value.html#author">AUTHOR</a></li>
 262 <li class="toctree-l2"><a class="reference internal" href="memcached_generate_hash_value.html#see-also">SEE ALSO</a></li>
 263 </ul>
 264 </li>
 265 <li class="toctree-l1 current"><a class="current reference internal" href="#">Use custom allocators for embedded usage</a><ul>
 266 <li class="toctree-l2"><a class="reference internal" href="#synopsis">SYNOPSIS</a></li>
 267 <li class="toctree-l2"><a class="reference internal" href="#description">DESCRIPTION</a></li>
 268 <li class="toctree-l2"><a class="reference internal" href="#notes">NOTES</a></li>
 269 <li class="toctree-l2"><a class="reference internal" href="#return">RETURN</a></li>
 270 <li class="toctree-l2"><a class="reference internal" href="#home">HOME</a></li>
 271 <li class="toctree-l2"><a class="reference internal" href="#see-also">SEE ALSO</a></li>
 272 </ul>
 273 </li>
 274 <li class="toctree-l1"><a class="reference internal" href="memcached_quit.html">Disconnecting a client from a server</a><ul>
 275 <li class="toctree-l2"><a class="reference internal" href="memcached_quit.html#synopsis">SYNOPSIS</a></li>
 276 <li class="toctree-l2"><a class="reference internal" href="memcached_quit.html#description">DESCRIPTION</a></li>
 277 <li class="toctree-l2"><a class="reference internal" href="memcached_quit.html#return">RETURN</a></li>
 278 <li class="toctree-l2"><a class="reference internal" href="memcached_quit.html#home">HOME</a></li>
 279 <li class="toctree-l2"><a class="reference internal" href="memcached_quit.html#author">AUTHOR</a></li>
 280 <li class="toctree-l2"><a class="reference internal" href="memcached_quit.html#see-also">SEE ALSO</a></li>
 281 </ul>
 282 </li>
 283 <li class="toctree-l1"><a class="reference internal" href="libmemcached/memcached_return_t.html">Error Codes (memcached_return_t)</a><ul>
 284 <li class="toctree-l2"><a class="reference internal" href="libmemcached/memcached_return_t.html#synopsis">SYNOPSIS</a></li>
 285 <li class="toctree-l2"><a class="reference internal" href="libmemcached/memcached_return_t.html#see-also">SEE ALSO</a></li>
 286 </ul>
 287 </li>
 288 <li class="toctree-l1"><a class="reference internal" href="memcached_sasl.html">SASL support</a><ul>
 289 <li class="toctree-l2"><a class="reference internal" href="memcached_sasl.html#synopsis">SYNOPSIS</a></li>
 290 <li class="toctree-l2"><a class="reference internal" href="memcached_sasl.html#description">DESCRIPTION</a></li>
 291 <li class="toctree-l2"><a class="reference internal" href="memcached_sasl.html#return">RETURN</a></li>
 292 <li class="toctree-l2"><a class="reference internal" href="memcached_sasl.html#home">HOME</a></li>
 293 <li class="toctree-l2"><a class="reference internal" href="memcached_sasl.html#author">AUTHOR</a></li>
 294 <li class="toctree-l2"><a class="reference internal" href="memcached_sasl.html#see-also">SEE ALSO</a></li>
 295 </ul>
 296 </li>
 297 <li class="toctree-l1"><a class="reference internal" href="memcached_server_st.html">Managing lists of servers</a><ul>
 298 <li class="toctree-l2"><a class="reference internal" href="memcached_server_st.html#synopsis">SYNOPSIS</a></li>
 299 <li class="toctree-l2"><a class="reference internal" href="memcached_server_st.html#description">DESCRIPTION</a></li>
 300 <li class="toctree-l2"><a class="reference internal" href="memcached_server_st.html#return">RETURN</a></li>
 301 <li class="toctree-l2"><a class="reference internal" href="memcached_server_st.html#home">HOME</a></li>
 302 <li class="toctree-l2"><a class="reference internal" href="memcached_server_st.html#see-also">SEE ALSO</a></li>
 303 </ul>
 304 </li>
 305 <li class="toctree-l1"><a class="reference internal" href="memcached_servers.html">Manipulate the server information stored in memcached_st</a><ul>
 306 <li class="toctree-l2"><a class="reference internal" href="memcached_servers.html#synopsis">SYNOPSIS</a></li>
 307 <li class="toctree-l2"><a class="reference internal" href="memcached_servers.html#description">DESCRIPTION</a></li>
 308 <li class="toctree-l2"><a class="reference internal" href="memcached_servers.html#return">RETURN</a></li>
 309 <li class="toctree-l2"><a class="reference internal" href="memcached_servers.html#home">HOME</a></li>
 310 <li class="toctree-l2"><a class="reference internal" href="memcached_servers.html#see-also">SEE ALSO</a></li>
 311 </ul>
 312 </li>
 313 <li class="toctree-l1"><a class="reference internal" href="memcached_strerror.html">Coverting Errors, memcached_return_t, to strings</a><ul>
 314 <li class="toctree-l2"><a class="reference internal" href="memcached_strerror.html#synopsis">SYNOPSIS</a></li>
 315 <li class="toctree-l2"><a class="reference internal" href="memcached_strerror.html#description">DESCRIPTION</a></li>
 316 <li class="toctree-l2"><a class="reference internal" href="memcached_strerror.html#return">RETURN</a></li>
 317 <li class="toctree-l2"><a class="reference internal" href="memcached_strerror.html#home">HOME</a></li>
 318 <li class="toctree-l2"><a class="reference internal" href="memcached_strerror.html#see-also">SEE ALSO</a></li>
 319 </ul>
 320 </li>
 321 <li class="toctree-l1"><a class="reference internal" href="error_messages.html">Client Error messages</a><ul>
 322 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_AUTH_CONTINUE.html">MEMCACHED_AUTH_CONTINUE</a></li>
 323 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_AUTH_FAILURE.html">MEMCACHED_AUTH_FAILURE</a></li>
 324 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_AUTH_PROBLEM.html">MEMCACHED_AUTH_PROBLEM</a></li>
 325 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_BAD_KEY_PROVIDED.html">MEMCACHED_BAD_KEY_PROVIDED</a></li>
 326 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_BUFFERED.html">MEMCACHED_BUFFERED</a></li>
 327 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_CLIENT_ERROR.html">MEMCACHED_CLIENT_ERROR</a></li>
 328 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_CONNECTION_BIND_FAILURE.html">MEMCACHED_CONNECTION_BIND_FAILURE</a></li>
 329 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_CONNECTION_FAILURE.html">MEMCACHED_CONNECTION_FAILURE</a></li>
 330 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE.html">MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE</a></li>
 331 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_DATA_DOES_NOT_EXIST.html">MEMCACHED_DATA_DOES_NOT_EXIST</a></li>
 332 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_DATA_EXISTS.html">MEMCACHED_DATA_EXISTS</a></li>
 333 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_DELETED.html">MEMCACHED_DELETED</a></li>
 334 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_DEPRECATED.html">MEMCACHED_DEPRECATED</a></li>
 335 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_E2BIG.html">MEMCACHED_E2BIG</a></li>
 336 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_END.html">MEMCACHED_END</a></li>
 337 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_ERRNO.html">MEMCACHED_ERRNO</a></li>
 338 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_FAILURE.html">MEMCACHED_FAILURE</a></li>
 339 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_FAIL_UNIX_SOCKET.html">MEMCACHED_FAIL_UNIX_SOCKET</a></li>
 340 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_FETCH_NOTFINISHED.html">MEMCACHED_FETCH_NOTFINISHED</a></li>
 341 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_HOST_LOOKUP_FAILURE.html">MEMCACHED_HOST_LOOKUP_FAILURE</a></li>
 342 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_INVALID_ARGUMENTS.html">MEMCACHED_INVALID_ARGUMENTS</a></li>
 343 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_INVALID_HOST_PROTOCOL.html">MEMCACHED_INVALID_HOST_PROTOCOL</a></li>
 344 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_ITEM.html">MEMCACHED_ITEM</a></li>
 345 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_KEY_TOO_BIG.html">MEMCACHED_KEY_TOO_BIG</a></li>
 346 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_MAXIMUM_RETURN.html">MEMCACHED_MAXIMUM_RETURN</a></li>
 347 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_MEMORY_ALLOCATION_FAILURE.html">MEMCACHED_MEMORY_ALLOCATION_FAILURE</a></li>
 348 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_NOTFOUND.html">MEMCACHED_NOTFOUND</a></li>
 349 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_NOTSTORED.html">MEMCACHED_NOTSTORED</a></li>
 350 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_NOT_SUPPORTED.html">MEMCACHED_NOT_SUPPORTED</a></li>
 351 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_NO_KEY_PROVIDED.html">MEMCACHED_NO_KEY_PROVIDED</a></li>
 352 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_NO_SERVERS.html">MEMCACHED_NO_SERVERS</a></li>
 353 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_PARSE_ERROR.html">MEMCACHED_PARSE_ERROR</a></li>
 354 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_PARSE_USER_ERROR.html">MEMCACHED_PARSE_USER_ERROR</a></li>
 355 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_PARTIAL_READ.html">MEMCACHED_PARTIAL_READ</a></li>
 356 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_PROTOCOL_ERROR.html">MEMCACHED_PROTOCOL_ERROR</a></li>
 357 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_READ_FAILURE.html">MEMCACHED_READ_FAILURE</a></li>
 358 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_SERVER_ERROR.html">MEMCACHED_SERVER_ERROR</a></li>
 359 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_SERVER_MARKED_DEAD.html">MEMCACHED_SERVER_MARKED_DEAD</a></li>
 360 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_SOME_ERRORS.html">MEMCACHED_SOME_ERRORS</a></li>
 361 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_STAT.html">MEMCACHED_STAT</a></li>
 362 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_STORED.html">MEMCACHED_STORED</a></li>
 363 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_SUCCESS.html">MEMCACHED_SUCCESS</a></li>
 364 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_TIMEOUT.html">MEMCACHED_TIMEOUT</a></li>
 365 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_UNKNOWN_READ_FAILURE.html">MEMCACHED_UNKNOWN_READ_FAILURE</a></li>
 366 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_UNKNOWN_STAT_KEY.html">MEMCACHED_UNKNOWN_STAT_KEY</a></li>
 367 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_VALUE.html">MEMCACHED_VALUE</a></li>
 368 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_WRITE_FAILURE.html">MEMCACHED_WRITE_FAILURE</a></li>
 369 </ul>
 370 </li>
 371 <li class="toctree-l1"><a class="reference internal" href="memcached_user_data.html">Storing custom user information in the client.</a><ul>
 372 <li class="toctree-l2"><a class="reference internal" href="memcached_user_data.html#library">LIBRARY</a></li>
 373 <li class="toctree-l2"><a class="reference internal" href="memcached_user_data.html#synopsis">SYNOPSIS</a></li>
 374 <li class="toctree-l2"><a class="reference internal" href="memcached_user_data.html#description">DESCRIPTION</a></li>
 375 <li class="toctree-l2"><a class="reference internal" href="memcached_user_data.html#return">RETURN</a></li>
 376 <li class="toctree-l2"><a class="reference internal" href="memcached_user_data.html#home">HOME</a></li>
 377 <li class="toctree-l2"><a class="reference internal" href="memcached_user_data.html#see-also">SEE ALSO</a></li>
 378 </ul>
 379 </li>
 380 <li class="toctree-l1"><a class="reference internal" href="memcached_verbosity.html">Setting the verbosity of a server</a><ul>
 381 <li class="toctree-l2"><a class="reference internal" href="memcached_verbosity.html#synopsis">SYNOPSIS</a></li>
 382 <li class="toctree-l2"><a class="reference internal" href="memcached_verbosity.html#description">DESCRIPTION</a></li>
 383 <li class="toctree-l2"><a class="reference internal" href="memcached_verbosity.html#return">RETURN</a></li>
 384 <li class="toctree-l2"><a class="reference internal" href="memcached_verbosity.html#home">HOME</a></li>
 385 <li class="toctree-l2"><a class="reference internal" href="memcached_verbosity.html#see-also">SEE ALSO</a></li>
 386 </ul>
 387 </li>
 388 <li class="toctree-l1"><a class="reference internal" href="memcached_version.html">Getting version information about the client and server</a><ul>
 389 <li class="toctree-l2"><a class="reference internal" href="memcached_version.html#synopsis">SYNOPSIS</a></li>
 390 <li class="toctree-l2"><a class="reference internal" href="memcached_version.html#description">DESCRIPTION</a></li>
 391 <li class="toctree-l2"><a class="reference internal" href="memcached_version.html#return">RETURN</a></li>
 392 <li class="toctree-l2"><a class="reference internal" href="memcached_version.html#home">HOME</a></li>
 393 <li class="toctree-l2"><a class="reference internal" href="memcached_version.html#see-also">SEE ALSO</a></li>
 394 </ul>
 395 </li>
 396 <li class="toctree-l1"><a class="reference internal" href="libmemcached/defaults.html">DEFAULTS</a></li>
 397 </ul>
 398 <p class="caption"><span class="caption-text">Interface Versions</span></p>
 399 <ul>
 400 <li class="toctree-l1"><a class="reference internal" href="libmemcached-1.0/index.html">libmemcached 1.0 API</a><ul>
 401 <li class="toctree-l2"><a class="reference internal" href="libmemcached-1.0/memcached_touch.html">memcached_touch, memcached_touch_by_key</a></li>
 402 </ul>
 403 </li>
 404 <li class="toctree-l1"><a class="reference internal" href="libmemcached-1.1/index.html">libmemcached 1.1 API</a></li>
 405 </ul>
 406 <p class="caption"><span class="caption-text">Deprecated Functions</span></p>
 407 <ul>
 408 <li class="toctree-l1"><a class="reference internal" href="libmemcached/memcached_fetch.html">memcached_fetch</a></li>
 409 </ul>
 410 <p class="caption"><span class="caption-text">Platform Specifics</span></p>
 411 <ul>
 412 <li class="toctree-l1"><a class="reference internal" href="tap.html">Systemtap support</a></li>
 413 <li class="toctree-l1"><a class="reference internal" href="types.html">Required C types</a><ul>
 414 <li class="toctree-l2"><a class="reference internal" href="types.html#types">Types</a></li>
 415 <li class="toctree-l2"><a class="reference internal" href="types.html#c-types-used">C Types Used</a></li>
 416 </ul>
 417 </li>
 418 </ul>
 419 <p class="caption"><span class="caption-text">Deriving Statistics from a Server</span></p>
 420 <ul>
 421 <li class="toctree-l1"><a class="reference internal" href="memcached_analyze.html">Anaylzing servers</a><ul>
 422 <li class="toctree-l2"><a class="reference internal" href="memcached_analyze.html#synopsis">SYNOPSIS</a></li>
 423 <li class="toctree-l2"><a class="reference internal" href="memcached_analyze.html#description">DESCRIPTION</a></li>
 424 <li class="toctree-l2"><a class="reference internal" href="memcached_analyze.html#return">RETURN</a></li>
 425 <li class="toctree-l2"><a class="reference internal" href="memcached_analyze.html#home">HOME</a></li>
 426 <li class="toctree-l2"><a class="reference internal" href="memcached_analyze.html#see-also">SEE ALSO</a></li>
 427 </ul>
 428 </li>
 429 <li class="toctree-l1"><a class="reference internal" href="memcached_stats.html">Working with statistical information from a server</a><ul>
 430 <li class="toctree-l2"><a class="reference internal" href="memcached_stats.html#synopsis">SYNOPSIS</a></li>
 431 <li class="toctree-l2"><a class="reference internal" href="memcached_stats.html#description">DESCRIPTION</a></li>
 432 <li class="toctree-l2"><a class="reference internal" href="memcached_stats.html#return">RETURN</a></li>
 433 <li class="toctree-l2"><a class="reference internal" href="memcached_stats.html#home">HOME</a></li>
 434 <li class="toctree-l2"><a class="reference internal" href="memcached_stats.html#author">AUTHOR</a></li>
 435 <li class="toctree-l2"><a class="reference internal" href="memcached_stats.html#see-also">SEE ALSO</a></li>
 436 </ul>
 437 </li>
 438 </ul>
 439 <p class="caption"><span class="caption-text">Libmemcachedutil</span></p>
 440 <ul>
 441 <li class="toctree-l1"><a class="reference internal" href="libmemcachedutil.html">Introducing libmemcachedutil</a><ul>
 442 <li class="toctree-l2"><a class="reference internal" href="libmemcachedutil.html#synopsis">SYNOPSIS</a></li>
 443 <li class="toctree-l2"><a class="reference internal" href="libmemcachedutil.html#description">DESCRIPTION</a></li>
 444 <li class="toctree-l2"><a class="reference internal" href="libmemcachedutil.html#threads">THREADS</a></li>
 445 <li class="toctree-l2"><a class="reference internal" href="libmemcachedutil.html#home">HOME</a></li>
 446 <li class="toctree-l2"><a class="reference internal" href="libmemcachedutil.html#see-also">SEE ALSO</a></li>
 447 </ul>
 448 </li>
 449 <li class="toctree-l1"><a class="reference internal" href="memcached_pool.html">Working with memcached pools</a><ul>
 450 <li class="toctree-l2"><a class="reference internal" href="memcached_pool.html#synopsis">SYNOPSIS</a></li>
 451 <li class="toctree-l2"><a class="reference internal" href="memcached_pool.html#description">DESCRIPTION</a></li>
 452 <li class="toctree-l2"><a class="reference internal" href="memcached_pool.html#return">RETURN</a></li>
 453 <li class="toctree-l2"><a class="reference internal" href="memcached_pool.html#home">HOME</a></li>
 454 <li class="toctree-l2"><a class="reference internal" href="memcached_pool.html#author">AUTHOR</a></li>
 455 <li class="toctree-l2"><a class="reference internal" href="memcached_pool.html#see-also">SEE ALSO</a></li>
 456 </ul>
 457 </li>
 458 </ul>
 459 <p class="caption"><span class="caption-text">Client Applications</span></p>
 460 <ul>
 461 <li class="toctree-l1"><a class="reference internal" href="bin/memcapable.html">memcapable - Checking a Memcached server capibilities and compatibility</a><ul>
 462 <li class="toctree-l2"><a class="reference internal" href="bin/memcapable.html#synopsis">SYNOPSIS</a></li>
 463 <li class="toctree-l2"><a class="reference internal" href="bin/memcapable.html#description">DESCRIPTION</a></li>
 464 <li class="toctree-l2"><a class="reference internal" href="bin/memcapable.html#limitations">LIMITATIONS</a></li>
 465 <li class="toctree-l2"><a class="reference internal" href="bin/memcapable.html#options">OPTIONS</a></li>
 466 <li class="toctree-l2"><a class="reference internal" href="bin/memcapable.html#home">HOME</a></li>
 467 <li class="toctree-l2"><a class="reference internal" href="bin/memcapable.html#author">AUTHOR</a></li>
 468 <li class="toctree-l2"><a class="reference internal" href="bin/memcapable.html#see-also">SEE ALSO</a></li>
 469 </ul>
 470 </li>
 471 <li class="toctree-l1"><a class="reference internal" href="bin/memcat.html">memcat - “cat” data from a server</a><ul>
 472 <li class="toctree-l2"><a class="reference internal" href="bin/memcat.html#synopsis">SYNOPSIS</a></li>
 473 <li class="toctree-l2"><a class="reference internal" href="bin/memcat.html#description">DESCRIPTION</a></li>
 474 <li class="toctree-l2"><a class="reference internal" href="bin/memcat.html#options">OPTIONS</a></li>
 475 <li class="toctree-l2"><a class="reference internal" href="bin/memcat.html#home">HOME</a></li>
 476 <li class="toctree-l2"><a class="reference internal" href="bin/memcat.html#author">AUTHOR</a></li>
 477 <li class="toctree-l2"><a class="reference internal" href="bin/memcat.html#see-also">SEE ALSO</a></li>
 478 </ul>
 479 </li>
 480 <li class="toctree-l1"><a class="reference internal" href="bin/memcp.html">memcp - Copy data to a server</a><ul>
 481 <li class="toctree-l2"><a class="reference internal" href="bin/memcp.html#synopsis">SYNOPSIS</a></li>
 482 <li class="toctree-l2"><a class="reference internal" href="bin/memcp.html#description">DESCRIPTION</a></li>
 483 <li class="toctree-l2"><a class="reference internal" href="bin/memcp.html#options">OPTIONS</a></li>
 484 <li class="toctree-l2"><a class="reference internal" href="bin/memcp.html#home">HOME</a></li>
 485 <li class="toctree-l2"><a class="reference internal" href="bin/memcp.html#author">AUTHOR</a></li>
 486 <li class="toctree-l2"><a class="reference internal" href="bin/memcp.html#see-also">SEE ALSO</a></li>
 487 </ul>
 488 </li>
 489 <li class="toctree-l1"><a class="reference internal" href="bin/memdump.html">memdump - Dumping your server</a><ul>
 490 <li class="toctree-l2"><a class="reference internal" href="bin/memdump.html#synopsis">SYNOPSIS</a></li>
 491 <li class="toctree-l2"><a class="reference internal" href="bin/memdump.html#description">DESCRIPTION</a></li>
 492 <li class="toctree-l2"><a class="reference internal" href="bin/memdump.html#options">OPTIONS</a></li>
 493 <li class="toctree-l2"><a class="reference internal" href="bin/memdump.html#home">HOME</a></li>
 494 <li class="toctree-l2"><a class="reference internal" href="bin/memdump.html#author">AUTHOR</a></li>
 495 <li class="toctree-l2"><a class="reference internal" href="bin/memdump.html#see-also">SEE ALSO</a></li>
 496 </ul>
 497 </li>
 498 <li class="toctree-l1"><a class="reference internal" href="bin/memerror.html">memerror - translate an error code to a string</a><ul>
 499 <li class="toctree-l2"><a class="reference internal" href="bin/memerror.html#synopsis">SYNOPSIS</a></li>
 500 <li class="toctree-l2"><a class="reference internal" href="bin/memerror.html#description">DESCRIPTION</a></li>
 501 <li class="toctree-l2"><a class="reference internal" href="bin/memerror.html#options">OPTIONS</a></li>
 502 <li class="toctree-l2"><a class="reference internal" href="bin/memerror.html#home">HOME</a></li>
 503 <li class="toctree-l2"><a class="reference internal" href="bin/memerror.html#author">AUTHOR</a></li>
 504 <li class="toctree-l2"><a class="reference internal" href="bin/memerror.html#see-also">SEE ALSO</a></li>
 505 </ul>
 506 </li>
 507 <li class="toctree-l1"><a class="reference internal" href="bin/memflush.html">memflush - flush all data from a server</a><ul>
 508 <li class="toctree-l2"><a class="reference internal" href="bin/memflush.html#synopsis">SYNOPSIS</a></li>
 509 <li class="toctree-l2"><a class="reference internal" href="bin/memflush.html#description">DESCRIPTION</a></li>
 510 <li class="toctree-l2"><a class="reference internal" href="bin/memflush.html#options">OPTIONS</a></li>
 511 <li class="toctree-l2"><a class="reference internal" href="bin/memflush.html#home">HOME</a></li>
 512 <li class="toctree-l2"><a class="reference internal" href="bin/memflush.html#author">AUTHOR</a></li>
 513 <li class="toctree-l2"><a class="reference internal" href="bin/memflush.html#see-also">SEE ALSO</a></li>
 514 </ul>
 515 </li>
 516 <li class="toctree-l1"><a class="reference internal" href="bin/memrm.html">memrm - Remove data from a server</a><ul>
 517 <li class="toctree-l2"><a class="reference internal" href="bin/memrm.html#synopsis">SYNOPSIS</a></li>
 518 <li class="toctree-l2"><a class="reference internal" href="bin/memrm.html#description">DESCRIPTION</a></li>
 519 <li class="toctree-l2"><a class="reference internal" href="bin/memrm.html#options">OPTIONS</a></li>
 520 <li class="toctree-l2"><a class="reference internal" href="bin/memrm.html#home">HOME</a></li>
 521 <li class="toctree-l2"><a class="reference internal" href="bin/memrm.html#author">AUTHOR</a></li>
 522 <li class="toctree-l2"><a class="reference internal" href="bin/memrm.html#see-also">SEE ALSO</a></li>
 523 </ul>
 524 </li>
 525 <li class="toctree-l1"><a class="reference internal" href="bin/memslap.html">memslap - Load testing  and benchmarking a server</a><ul>
 526 <li class="toctree-l2"><a class="reference internal" href="bin/memslap.html#synopsis">SYNOPSIS</a></li>
 527 <li class="toctree-l2"><a class="reference internal" href="bin/memslap.html#description">DESCRIPTION</a></li>
 528 <li class="toctree-l2"><a class="reference internal" href="bin/memslap.html#options">OPTIONS</a></li>
 529 <li class="toctree-l2"><a class="reference internal" href="bin/memslap.html#home">HOME</a></li>
 530 <li class="toctree-l2"><a class="reference internal" href="bin/memslap.html#author">AUTHOR</a></li>
 531 <li class="toctree-l2"><a class="reference internal" href="bin/memslap.html#see-also">SEE ALSO</a></li>
 532 </ul>
 533 </li>
 534 <li class="toctree-l1"><a class="reference internal" href="bin/memaslap.html">memaslap - Load testing  and benchmarking a server</a><ul>
 535 <li class="toctree-l2"><a class="reference internal" href="bin/memaslap.html#synopsis">SYNOPSIS</a></li>
 536 <li class="toctree-l2"><a class="reference internal" href="bin/memaslap.html#description">DESCRIPTION</a></li>
 537 <li class="toctree-l2"><a class="reference internal" href="bin/memaslap.html#features">FEATURES</a></li>
 538 <li class="toctree-l2"><a class="reference internal" href="bin/memaslap.html#details">DETAILS</a></li>
 539 <li class="toctree-l2"><a class="reference internal" href="bin/memaslap.html#usage">USAGE</a></li>
 540 <li class="toctree-l2"><a class="reference internal" href="bin/memaslap.html#configuration-file">Configuration file</a></li>
 541 <li class="toctree-l2"><a class="reference internal" href="bin/memaslap.html#format-of-output">Format of output</a></li>
 542 <li class="toctree-l2"><a class="reference internal" href="bin/memaslap.html#options">OPTIONS</a></li>
 543 <li class="toctree-l2"><a class="reference internal" href="bin/memaslap.html#examples">EXAMPLES</a></li>
 544 <li class="toctree-l2"><a class="reference internal" href="bin/memaslap.html#home">HOME</a></li>
 545 <li class="toctree-l2"><a class="reference internal" href="bin/memaslap.html#authors">AUTHORS</a></li>
 546 <li class="toctree-l2"><a class="reference internal" href="bin/memaslap.html#see-also">SEE ALSO</a></li>
 547 </ul>
 548 </li>
 549 <li class="toctree-l1"><a class="reference internal" href="bin/memstat.html">memstat - Gather statistics from a server</a><ul>
 550 <li class="toctree-l2"><a class="reference internal" href="bin/memstat.html#synopsis">SYNOPSIS</a></li>
 551 <li class="toctree-l2"><a class="reference internal" href="bin/memstat.html#description">DESCRIPTION</a></li>
 552 <li class="toctree-l2"><a class="reference internal" href="bin/memstat.html#options">OPTIONS</a></li>
 553 <li class="toctree-l2"><a class="reference internal" href="bin/memstat.html#home">HOME</a></li>
 554 <li class="toctree-l2"><a class="reference internal" href="bin/memstat.html#see-also">SEE ALSO</a></li>
 555 </ul>
 556 </li>
 557 <li class="toctree-l1"><a class="reference internal" href="bin/memexist.html">memexist - Check for the existance of a key</a><ul>
 558 <li class="toctree-l2"><a class="reference internal" href="bin/memexist.html#synopsis">SYNOPSIS</a></li>
 559 <li class="toctree-l2"><a class="reference internal" href="bin/memexist.html#description">DESCRIPTION</a></li>
 560 <li class="toctree-l2"><a class="reference internal" href="bin/memexist.html#options">OPTIONS</a></li>
 561 <li class="toctree-l2"><a class="reference internal" href="bin/memexist.html#home">HOME</a></li>
 562 <li class="toctree-l2"><a class="reference internal" href="bin/memexist.html#author">AUTHOR</a></li>
 563 <li class="toctree-l2"><a class="reference internal" href="bin/memexist.html#see-also">SEE ALSO</a></li>
 564 </ul>
 565 </li>
 566 <li class="toctree-l1"><a class="reference internal" href="bin/memparse.html">memparse - Parse an option string</a><ul>
 567 <li class="toctree-l2"><a class="reference internal" href="bin/memparse.html#synopsis">SYNOPSIS</a></li>
 568 <li class="toctree-l2"><a class="reference internal" href="bin/memparse.html#description">DESCRIPTION</a></li>
 569 <li class="toctree-l2"><a class="reference internal" href="bin/memparse.html#options">OPTIONS</a></li>
 570 <li class="toctree-l2"><a class="reference internal" href="bin/memparse.html#home">HOME</a></li>
 571 <li class="toctree-l2"><a class="reference internal" href="bin/memparse.html#author">AUTHOR</a></li>
 572 <li class="toctree-l2"><a class="reference internal" href="bin/memparse.html#see-also">SEE ALSO</a></li>
 573 </ul>
 574 </li>
 575 <li class="toctree-l1"><a class="reference internal" href="bin/memping.html">memping - Test to see if a server is available.</a><ul>
 576 <li class="toctree-l2"><a class="reference internal" href="bin/memping.html#synopsis">SYNOPSIS</a></li>
 577 <li class="toctree-l2"><a class="reference internal" href="bin/memping.html#description">DESCRIPTION</a></li>
 578 <li class="toctree-l2"><a class="reference internal" href="bin/memping.html#options">OPTIONS</a></li>
 579 <li class="toctree-l2"><a class="reference internal" href="bin/memping.html#home">HOME</a></li>
 580 <li class="toctree-l2"><a class="reference internal" href="bin/memping.html#author">AUTHOR</a></li>
 581 <li class="toctree-l2"><a class="reference internal" href="bin/memping.html#see-also">SEE ALSO</a></li>
 582 </ul>
 583 </li>
 584 <li class="toctree-l1"><a class="reference internal" href="bin/memtouch.html">memtouch - Touches a key.</a><ul>
 585 <li class="toctree-l2"><a class="reference internal" href="bin/memtouch.html#synopsis">SYNOPSIS</a></li>
 586 <li class="toctree-l2"><a class="reference internal" href="bin/memtouch.html#description">DESCRIPTION</a></li>
 587 <li class="toctree-l2"><a class="reference internal" href="bin/memtouch.html#options">OPTIONS</a></li>
 588 <li class="toctree-l2"><a class="reference internal" href="bin/memtouch.html#home">HOME</a></li>
 589 <li class="toctree-l2"><a class="reference internal" href="bin/memtouch.html#author">AUTHOR</a></li>
 590 <li class="toctree-l2"><a class="reference internal" href="bin/memtouch.html#see-also">SEE ALSO</a></li>
 591 </ul>
 592 </li>
 593 </ul>
 594 <p class="caption"><span class="caption-text">Libhashkit</span></p>
 595 <ul>
 596 <li class="toctree-l1"><a class="reference internal" href="libhashkit.html">Introducing libhashkit</a><ul>
 597 <li class="toctree-l2"><a class="reference internal" href="libhashkit.html#description">DESCRIPTION</a></li>
 598 <li class="toctree-l2"><a class="reference internal" href="libhashkit.html#home">HOME</a></li>
 599 <li class="toctree-l2"><a class="reference internal" href="libhashkit.html#see-also">SEE ALSO</a></li>
 600 </ul>
 601 </li>
 602 <li class="toctree-l1"><a class="reference internal" href="hashkit_create.html">Creating a hashkit structure</a><ul>
 603 <li class="toctree-l2"><a class="reference internal" href="hashkit_create.html#synopsis">SYNOPSIS</a></li>
 604 <li class="toctree-l2"><a class="reference internal" href="hashkit_create.html#description">DESCRIPTION</a></li>
 605 <li class="toctree-l2"><a class="reference internal" href="hashkit_create.html#return-value">RETURN VALUE</a></li>
 606 <li class="toctree-l2"><a class="reference internal" href="hashkit_create.html#home">HOME</a></li>
 607 <li class="toctree-l2"><a class="reference internal" href="hashkit_create.html#see-also">SEE ALSO</a></li>
 608 </ul>
 609 </li>
 610 <li class="toctree-l1"><a class="reference internal" href="hashkit_functions.html">Available Hashes</a><ul>
 611 <li class="toctree-l2"><a class="reference internal" href="hashkit_functions.html#synopsis">SYNOPSIS</a></li>
 612 <li class="toctree-l2"><a class="reference internal" href="hashkit_functions.html#description">DESCRIPTION</a></li>
 613 <li class="toctree-l2"><a class="reference internal" href="hashkit_functions.html#return-value">RETURN VALUE</a></li>
 614 <li class="toctree-l2"><a class="reference internal" href="hashkit_functions.html#home">HOME</a></li>
 615 <li class="toctree-l2"><a class="reference internal" href="hashkit_functions.html#see-also">SEE ALSO</a></li>
 616 </ul>
 617 </li>
 618 <li class="toctree-l1"><a class="reference internal" href="hashkit_value.html">hashkit_value</a><ul>
 619 <li class="toctree-l2"><a class="reference internal" href="hashkit_value.html#synopsis">SYNOPSIS</a></li>
 620 <li class="toctree-l2"><a class="reference internal" href="hashkit_value.html#description">DESCRIPTION</a></li>
 621 <li class="toctree-l2"><a class="reference internal" href="hashkit_value.html#return-value">RETURN VALUE</a></li>
 622 <li class="toctree-l2"><a class="reference internal" href="hashkit_value.html#home">HOME</a></li>
 623 <li class="toctree-l2"><a class="reference internal" href="hashkit_value.html#see-also">SEE ALSO</a></li>
 624 </ul>
 625 </li>
 626 </ul>
 627
 628
 629
 630         </div>
 631       </div>
 632     </nav>
 633
 634     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 635
 636
 637       <nav class="wy-nav-top" aria-label="top navigation">
 638
 639           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 640           <a href="index.html">libmemcached</a>
 641
 642       </nav>
 643
 644
 645       <div class="wy-nav-content">
 646
 647         <div class="rst-content">
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665 <div role="navigation" aria-label="breadcrumbs navigation">
 666
 667   <ul class="wy-breadcrumbs">
 668
 669       <li><a href="index.html">Docs</a> &raquo;</li>
 670
 671       <li>Use custom allocators for embedded usage</li>
 672
 673
 674       <li class="wy-breadcrumbs-aside">
 675
 676
 677
 678       </li>
 679
 680   </ul>
 681
 682
 683   <hr/>
 684 </div>
 685           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 686            <div itemprop="articleBody">
 687
 688   <div class="section" id="use-custom-allocators-for-embedded-usage">
 689 <h1>Use custom allocators for embedded usage<a class="headerlink" href="#use-custom-allocators-for-embedded-usage" title="Permalink to this headline">¶</a></h1>
 690 <p id="index-0">Manage memory allocator functions</p>
 691 <div class="section" id="synopsis">
 692 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
 693 <p>#include &lt;libmemcached/memcached.h&gt;</p>
 694 <dl class="function">
 695 <dt id="c.memcached_set_memory_allocators">
 696 <a class="reference internal" href="libmemcached/memcached_return_t.html#c.memcached_return_t" title="memcached_return_t">memcached_return_t</a> <code class="sig-name descname">memcached_set_memory_allocators</code><span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#c.memcached_st" title="memcached_st">memcached_st</a><em> *ptr</em>, <a class="reference internal" href="#c.memcached_malloc_fn" title="memcached_malloc_fn">memcached_malloc_fn</a><em> mem_malloc</em>, <a class="reference internal" href="#c.memcached_free_fn" title="memcached_free_fn">memcached_free_fn</a><em> mem_free</em>, <a class="reference internal" href="#c.memcached_realloc_fn" title="memcached_realloc_fn">memcached_realloc_fn</a><em> mem_realloc</em>, <a class="reference internal" href="#c.memcached_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="#c.memcached_set_memory_allocators" title="Permalink to this definition">¶</a></dt>
 697 <dd></dd></dl>
 698
 699 <dl class="function">
 700 <dt id="c.memcached_get_memory_allocators">
 701 void <code class="sig-name descname">memcached_get_memory_allocators</code><span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#c.memcached_st" title="memcached_st">memcached_st</a><em> *ptr</em>, <a class="reference internal" href="#c.memcached_malloc_fn" title="memcached_malloc_fn">memcached_malloc_fn</a><em> *mem_malloc</em>, <a class="reference internal" href="#c.memcached_free_fn" title="memcached_free_fn">memcached_free_fn</a><em> *mem_free</em>, <a class="reference internal" href="#c.memcached_realloc_fn" title="memcached_realloc_fn">memcached_realloc_fn</a><em> *mem_realloc</em>, <a class="reference internal" href="#c.memcached_calloc_fn" title="memcached_calloc_fn">memcached_calloc_fn</a><em> *mem_calloc</em><span class="sig-paren">)</span><a class="headerlink" href="#c.memcached_get_memory_allocators" title="Permalink to this definition">¶</a></dt>
 702 <dd></dd></dl>
 703
 704 <dl class="function">
 705 <dt id="c.memcached_get_memory_allocators_context">
 706 void * <code class="sig-name descname">memcached_get_memory_allocators_context</code><span class="sig-paren">(</span>const <a class="reference internal" href="memcached_create.html#c.memcached_st" title="memcached_st">memcached_st</a><em> *ptr</em><span class="sig-paren">)</span><a class="headerlink" href="#c.memcached_get_memory_allocators_context" title="Permalink to this definition">¶</a></dt>
 707 <dd></dd></dl>
 708
 709 <dl class="function">
 710 <dt id="c.memcached_malloc_fn">
 711 void * <code class="sig-name descname">(*memcached_malloc_fn)</code><span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#c.memcached_st" title="memcached_st">memcached_st</a><em> *ptr</em>, const size_t<em> size</em>, void<em> *context</em><span class="sig-paren">)</span><a class="headerlink" href="#c.memcached_malloc_fn" title="Permalink to this definition">¶</a></dt>
 712 <dd></dd></dl>
 713
 714 <dl class="function">
 715 <dt id="c.memcached_realloc_fn">
 716 void * <code class="sig-name descname">(*memcached_realloc_fn)</code><span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#c.memcached_st" title="memcached_st">memcached_st</a><em> *ptr</em>, void<em> *mem</em>, const size_t<em> size</em>, void<em> *context</em><span class="sig-paren">)</span><a class="headerlink" href="#c.memcached_realloc_fn" title="Permalink to this definition">¶</a></dt>
 717 <dd></dd></dl>
 718
 719 <dl class="function">
 720 <dt id="c.memcached_free_fn">
 721 void <code class="sig-name descname">(*memcached_free_fn)</code><span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#c.memcached_st" title="memcached_st">memcached_st</a><em> *ptr</em>, void<em> *mem</em>, void<em> *context</em><span class="sig-paren">)</span><a class="headerlink" href="#c.memcached_free_fn" title="Permalink to this definition">¶</a></dt>
 722 <dd></dd></dl>
 723
 724 <dl class="function">
 725 <dt id="c.memcached_calloc_fn">
 726 void * <code class="sig-name descname">(*memcached_calloc_fn)</code><span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#c.memcached_st" title="memcached_st">memcached_st</a><em> *ptr</em>, size_t<em> nelem</em>, const size_t<em> elsize</em>, void<em> *context</em><span class="sig-paren">)</span><a class="headerlink" href="#c.memcached_calloc_fn" title="Permalink to this definition">¶</a></dt>
 727 <dd></dd></dl>
 728
 729 <p>Compile and link with -lmemcached</p>
 730 </div>
 731 <div class="section" id="description">
 732 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
 733 <p>libmemcached(3) allows you to specify your own memory allocators, optimized
 734 for your application. This enables libmemcached to be used inside of applications that have their own malloc implementation.</p>
 735 <p><a class="reference internal" href="#c.memcached_set_memory_allocators" title="memcached_set_memory_allocators"><code class="xref c c-func docutils literal notranslate"><span class="pre">memcached_set_memory_allocators()</span></code></a> is used to set the memory
 736 allocators used by the memcached instance specified by ptr. Please note that
 737 you cannot override only one of the memory allocators, you have to specify a
 738 complete new set if you want to override one of them. All of the memory
 739 allocation functions should behave as specified in the C99 standard. Specify
 740 NULL as all functions to reset them to the default values.</p>
 741 <p><a class="reference internal" href="#c.memcached_get_memory_allocators" title="memcached_get_memory_allocators"><code class="xref c c-func docutils literal notranslate"><span class="pre">memcached_get_memory_allocators()</span></code></a> is used to get the currently used
 742 memory allocators by a mamcached handle.</p>
 743 <p><a class="reference internal" href="#c.memcached_get_memory_allocators_context" title="memcached_get_memory_allocators_context"><code class="xref c c-func docutils literal notranslate"><span class="pre">memcached_get_memory_allocators_context()</span></code></a> returns the void * that
 744 was passed in during the call to <a class="reference internal" href="#c.memcached_set_memory_allocators" title="memcached_set_memory_allocators"><code class="xref c c-func docutils literal notranslate"><span class="pre">memcached_set_memory_allocators()</span></code></a>.</p>
 745 <p>The first argument to the memory allocator functions is a pointer to a
 746 memcached structure, the is passed as const and you will need to clone
 747 it in order to make use of any operation which would modify it.</p>
 748 </div>
 749 <div class="section" id="notes">
 750 <h2>NOTES<a class="headerlink" href="#notes" title="Permalink to this headline">¶</a></h2>
 751 <p>In version 0.38 all functions were modified to have a context void pointer
 752 passed to them. This was so that customer allocators could have their
 753 own space for memory.</p>
 754 </div>
 755 <div class="section" id="return">
 756 <h2>RETURN<a class="headerlink" href="#return" title="Permalink to this headline">¶</a></h2>
 757 <p><a class="reference internal" href="#c.memcached_set_memory_allocators" title="memcached_set_memory_allocators"><code class="xref c c-func docutils literal notranslate"><span class="pre">memcached_set_memory_allocators()</span></code></a> return <a class="reference internal" href="client_errors/MEMCACHED_SUCCESS.html#c.MEMCACHED_SUCCESS" title="MEMCACHED_SUCCESS"><code class="xref c c-type docutils literal notranslate"><span class="pre">MEMCACHED_SUCCESS</span></code></a>
 758 upon success, and <a class="reference internal" href="client_errors/MEMCACHED_FAILURE.html#c.MEMCACHED_FAILURE" title="MEMCACHED_FAILURE"><code class="xref c c-type docutils literal notranslate"><span class="pre">MEMCACHED_FAILURE</span></code></a> if you don’t pass a complete set
 759 of function pointers.</p>
 760 </div>
 761 <div class="section" id="home">
 762 <h2>HOME<a class="headerlink" href="#home" title="Permalink to this headline">¶</a></h2>
 763 <p>To find out more information please check:
 764 <a class="reference external" href="http://libmemcached.org/">http://libmemcached.org/</a></p>
 765 </div>
 766 <div class="section" id="see-also">
 767 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
 768 <p><em class="manpage">memcached(1)</em> <em class="manpage">libmemcached(3)</em> <em class="manpage">memcached_strerror(3)</em></p>
 769 </div>
 770 </div>
 771
 772
 773            </div>
 774
 775           </div>
 776           <footer>
 777
 778     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 779
 780         <a href="memcached_quit.html" class="btn btn-neutral float-right" title="Disconnecting a client from a server" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 781
 782
 783         <a href="memcached_generate_hash_value.html" class="btn btn-neutral float-left" title="Generating hash values directly" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 784
 785     </div>
 786
 787
 788   <hr/>
 789
 790   <div role="contentinfo">
 791     <p>
 792         &copy; <a href="copyright.html">Copyright</a> 2011-2020 Brian Aker, Michael Wallner
 793
 794     </p>
 795   </div>
 796   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>.
 797
 798 </footer>
 799
 800         </div>
 801       </div>
 802
 803     </section>
 804
 805   </div>
 806
 807
 808
 809   <script type="text/javascript">
 810       jQuery(function () {
 811           SphinxRtdTheme.Navigation.enable(true);
 812       });
 813   </script>
 814
 815
 816
 817
 818
 819
 820 </body>
 821 </html>