git.m6w6.name Git - m6w6/libmemcached/blob - libmemcached_configuration.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>Configuring Libmemcached &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 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="Retrieving errors" href="libmemcached/memcached_last_error_message.html" />
  40     <link rel="prev" title="Examples" href="libmemcached_examples.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">Basics</span></p>
  89 <ul class="current">
  90 <li class="toctree-l1"><a class="reference internal" href="libmemcached.html">Introducing the C Client Library for memcached</a><ul>
  91 <li class="toctree-l2"><a class="reference internal" href="libmemcached.html#synopsis">SYNOPSIS</a></li>
  92 <li class="toctree-l2"><a class="reference internal" href="libmemcached.html#description">DESCRIPTION</a></li>
  93 <li class="toctree-l2"><a class="reference internal" href="libmemcached.html#constants">CONSTANTS</a></li>
  94 <li class="toctree-l2"><a class="reference internal" href="libmemcached.html#threads-and-processes">THREADS AND PROCESSES</a></li>
  95 <li class="toctree-l2"><a class="reference internal" href="libmemcached.html#see-also">SEE ALSO</a></li>
  96 </ul>
  97 </li>
  98 <li class="toctree-l1"><a class="reference internal" href="versioning.html">Versioning</a></li>
  99 <li class="toctree-l1"><a class="reference internal" href="memcached_create.html">Creating and destroying a memcached_st</a><ul>
 100 <li class="toctree-l2"><a class="reference internal" href="memcached_create.html#synopsis">SYNOPSIS</a></li>
 101 <li class="toctree-l2"><a class="reference internal" href="memcached_create.html#description">DESCRIPTION</a></li>
 102 <li class="toctree-l2"><a class="reference internal" href="memcached_create.html#return">RETURN</a></li>
 103 <li class="toctree-l2"><a class="reference internal" href="memcached_create.html#see-also">SEE ALSO</a></li>
 104 </ul>
 105 </li>
 106 <li class="toctree-l1"><a class="reference internal" href="libmemcached_examples.html">Examples</a><ul>
 107 <li class="toctree-l2"><a class="reference internal" href="libmemcached_examples.html#description">DESCRIPTION</a></li>
 108 <li class="toctree-l2"><a class="reference internal" href="libmemcached_examples.html#connecting-to-servers">Connecting to servers</a></li>
 109 <li class="toctree-l2"><a class="reference internal" href="libmemcached_examples.html#creating-a-pool-of-servers">Creating a pool of servers</a></li>
 110 <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>
 111 <li class="toctree-l2"><a class="reference internal" href="libmemcached_examples.html#fetching-multiple-values">Fetching multiple values</a></li>
 112 <li class="toctree-l2"><a class="reference internal" href="libmemcached_examples.html#see-also">SEE ALSO</a></li>
 113 </ul>
 114 </li>
 115 <li class="toctree-l1 current"><a class="current reference internal" href="#">Configuring Libmemcached</a><ul>
 116 <li class="toctree-l2"><a class="reference internal" href="#synopsis">SYNOPSIS</a></li>
 117 <li class="toctree-l2"><a class="reference internal" href="#description">DESCRIPTION</a></li>
 118 <li class="toctree-l2"><a class="reference internal" href="#environment">ENVIRONMENT</a></li>
 119 <li class="toctree-l2"><a class="reference internal" href="#return">RETURN</a></li>
 120 <li class="toctree-l2"><a class="reference internal" href="#example">EXAMPLE</a></li>
 121 <li class="toctree-l2"><a class="reference internal" href="#see-also">SEE ALSO</a></li>
 122 </ul>
 123 </li>
 124 <li class="toctree-l1"><a class="reference internal" href="libmemcached/memcached_last_error_message.html">Retrieving errors</a><ul>
 125 <li class="toctree-l2"><a class="reference internal" href="libmemcached/memcached_last_error_message.html#synopsis">SYNOPSIS</a></li>
 126 <li class="toctree-l2"><a class="reference internal" href="libmemcached/memcached_last_error_message.html#description">DESCRIPTION</a></li>
 127 <li class="toctree-l2"><a class="reference internal" href="libmemcached/memcached_last_error_message.html#return">RETURN</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#see-also">SEE ALSO</a></li>
 139 </ul>
 140 </li>
 141 <li class="toctree-l1"><a class="reference internal" href="memcached_delete.html">Deleting data from a server</a><ul>
 142 <li class="toctree-l2"><a class="reference internal" href="memcached_delete.html#synopsis">SYNOPSIS</a></li>
 143 <li class="toctree-l2"><a class="reference internal" href="memcached_delete.html#description">DESCRIPTION</a></li>
 144 <li class="toctree-l2"><a class="reference internal" href="memcached_delete.html#return">RETURN</a></li>
 145 <li class="toctree-l2"><a class="reference internal" href="memcached_delete.html#see-also">SEE ALSO</a></li>
 146 </ul>
 147 </li>
 148 <li class="toctree-l1"><a class="reference internal" href="libmemcached/memcached_exist.html">Determine if a keys exists.</a><ul>
 149 <li class="toctree-l2"><a class="reference internal" href="libmemcached/memcached_exist.html#synopsis">SYNOPSIS</a></li>
 150 <li class="toctree-l2"><a class="reference internal" href="libmemcached/memcached_exist.html#description">DESCRIPTION</a></li>
 151 <li class="toctree-l2"><a class="reference internal" href="libmemcached/memcached_exist.html#return">RETURN</a></li>
 152 <li class="toctree-l2"><a class="reference internal" href="libmemcached/memcached_exist.html#see-also">SEE ALSO</a></li>
 153 </ul>
 154 </li>
 155 <li class="toctree-l1"><a class="reference internal" href="memcached_flush_buffers.html">Flushing client buffers</a><ul>
 156 <li class="toctree-l2"><a class="reference internal" href="memcached_flush_buffers.html#synopsis">SYNOPSIS</a></li>
 157 <li class="toctree-l2"><a class="reference internal" href="memcached_flush_buffers.html#description">DESCRIPTION</a></li>
 158 <li class="toctree-l2"><a class="reference internal" href="memcached_flush_buffers.html#return">RETURN</a></li>
 159 <li class="toctree-l2"><a class="reference internal" href="memcached_flush_buffers.html#see-also">SEE ALSO</a></li>
 160 </ul>
 161 </li>
 162 <li class="toctree-l1"><a class="reference internal" href="memcached_flush.html">Wiping clean the contents of a server</a><ul>
 163 <li class="toctree-l2"><a class="reference internal" href="memcached_flush.html#synopsis">SYNOPSIS</a></li>
 164 <li class="toctree-l2"><a class="reference internal" href="memcached_flush.html#description">DESCRIPTION</a></li>
 165 <li class="toctree-l2"><a class="reference internal" href="memcached_flush.html#return">RETURN</a></li>
 166 <li class="toctree-l2"><a class="reference internal" href="memcached_flush.html#see-also">SEE ALSO</a></li>
 167 </ul>
 168 </li>
 169 <li class="toctree-l1"><a class="reference internal" href="memcached_get.html">Retrieving data from the server</a><ul>
 170 <li class="toctree-l2"><a class="reference internal" href="memcached_get.html#synopsis">SYNOPSIS</a></li>
 171 <li class="toctree-l2"><a class="reference internal" href="memcached_get.html#description">DESCRIPTION</a></li>
 172 <li class="toctree-l2"><a class="reference internal" href="memcached_get.html#return">RETURN</a></li>
 173 <li class="toctree-l2"><a class="reference internal" href="memcached_get.html#see-also">SEE ALSO</a></li>
 174 </ul>
 175 </li>
 176 <li class="toctree-l1"><a class="reference internal" href="memcached_result_st.html">Working with result sets</a><ul>
 177 <li class="toctree-l2"><a class="reference internal" href="memcached_result_st.html#synopsis">SYNOPSIS</a></li>
 178 <li class="toctree-l2"><a class="reference internal" href="memcached_result_st.html#description">DESCRIPTION</a></li>
 179 <li class="toctree-l2"><a class="reference internal" href="memcached_result_st.html#return">RETURN</a></li>
 180 <li class="toctree-l2"><a class="reference internal" href="memcached_result_st.html#see-also">SEE ALSO</a></li>
 181 </ul>
 182 </li>
 183 <li class="toctree-l1"><a class="reference internal" href="memcached_set.html">Store, replace, add, or atomically add data to the server</a><ul>
 184 <li class="toctree-l2"><a class="reference internal" href="memcached_set.html#synopsis">SYNOPSIS</a></li>
 185 <li class="toctree-l2"><a class="reference internal" href="memcached_set.html#description">DESCRIPTION</a></li>
 186 <li class="toctree-l2"><a class="reference internal" href="memcached_set.html#return">RETURN</a></li>
 187 <li class="toctree-l2"><a class="reference internal" href="memcached_set.html#see-also">SEE ALSO</a></li>
 188 </ul>
 189 </li>
 190 <li class="toctree-l1"><a class="reference internal" href="memcached_append.html">Appending or Prepending to data on the server</a><ul>
 191 <li class="toctree-l2"><a class="reference internal" href="memcached_append.html#synopsis">SYNOPSIS</a></li>
 192 <li class="toctree-l2"><a class="reference internal" href="memcached_append.html#description">DESCRIPTION</a></li>
 193 <li class="toctree-l2"><a class="reference internal" href="memcached_append.html#return">RETURN</a></li>
 194 <li class="toctree-l2"><a class="reference internal" href="memcached_append.html#see-also">SEE ALSO</a></li>
 195 </ul>
 196 </li>
 197 <li class="toctree-l1"><a class="reference internal" href="memcached_cas.html">Working with data on the server in an atomic fashion</a><ul>
 198 <li class="toctree-l2"><a class="reference internal" href="memcached_cas.html#synopsis">SYNOPSIS</a></li>
 199 <li class="toctree-l2"><a class="reference internal" href="memcached_cas.html#description">DESCRIPTION</a></li>
 200 <li class="toctree-l2"><a class="reference internal" href="memcached_cas.html#return">RETURN</a></li>
 201 <li class="toctree-l2"><a class="reference internal" href="memcached_cas.html#see-also">SEE ALSO</a></li>
 202 </ul>
 203 </li>
 204 </ul>
 205 <p class="caption"><span class="caption-text">Advanced Topics</span></p>
 206 <ul>
 207 <li class="toctree-l1"><a class="reference internal" href="libmemcached-1.0/memcached_set_encoding_key.html">Set encryption key</a><ul>
 208 <li class="toctree-l2"><a class="reference internal" href="libmemcached-1.0/memcached_set_encoding_key.html#synopsis">SYNOPSIS</a></li>
 209 <li class="toctree-l2"><a class="reference internal" href="libmemcached-1.0/memcached_set_encoding_key.html#description">DESCRIPTION</a></li>
 210 <li class="toctree-l2"><a class="reference internal" href="libmemcached-1.0/memcached_set_encoding_key.html#return">RETURN</a></li>
 211 <li class="toctree-l2"><a class="reference internal" href="libmemcached-1.0/memcached_set_encoding_key.html#see-also">SEE ALSO</a></li>
 212 </ul>
 213 </li>
 214 <li class="toctree-l1"><a class="reference internal" href="memcached_behavior.html">Modifying how the driver behaves</a><ul>
 215 <li class="toctree-l2"><a class="reference internal" href="memcached_behavior.html#synopsis">SYNOPSIS</a></li>
 216 <li class="toctree-l2"><a class="reference internal" href="memcached_behavior.html#description">DESCRIPTION</a></li>
 217 <li class="toctree-l2"><a class="reference internal" href="memcached_behavior.html#return">RETURN</a></li>
 218 <li class="toctree-l2"><a class="reference internal" href="memcached_behavior.html#notes">NOTES</a></li>
 219 <li class="toctree-l2"><a class="reference internal" href="memcached_behavior.html#see-also">SEE ALSO</a></li>
 220 </ul>
 221 </li>
 222 <li class="toctree-l1"><a class="reference internal" href="memcached_callback.html">Setting callbacks</a><ul>
 223 <li class="toctree-l2"><a class="reference internal" href="memcached_callback.html#synopsis">SYNOPSIS</a></li>
 224 <li class="toctree-l2"><a class="reference internal" href="memcached_callback.html#description">DESCRIPTION</a></li>
 225 <li class="toctree-l2"><a class="reference internal" href="memcached_callback.html#return">RETURN</a></li>
 226 <li class="toctree-l2"><a class="reference internal" href="memcached_callback.html#see-also">SEE ALSO</a></li>
 227 </ul>
 228 </li>
 229 <li class="toctree-l1"><a class="reference internal" href="memcached_dump.html">Dumping data from a server</a><ul>
 230 <li class="toctree-l2"><a class="reference internal" href="memcached_dump.html#synopsis">SYNOPSIS</a></li>
 231 <li class="toctree-l2"><a class="reference internal" href="memcached_dump.html#description">DESCRIPTION</a></li>
 232 <li class="toctree-l2"><a class="reference internal" href="memcached_dump.html#return">RETURN</a></li>
 233 <li class="toctree-l2"><a class="reference internal" href="memcached_dump.html#see-also">SEE ALSO</a></li>
 234 </ul>
 235 </li>
 236 <li class="toctree-l1"><a class="reference internal" href="memcached_generate_hash_value.html">Generating hash values directly</a><ul>
 237 <li class="toctree-l2"><a class="reference internal" href="memcached_generate_hash_value.html#synopsis">SYNOPSIS</a></li>
 238 <li class="toctree-l2"><a class="reference internal" href="memcached_generate_hash_value.html#description">DESCRIPTION</a></li>
 239 <li class="toctree-l2"><a class="reference internal" href="memcached_generate_hash_value.html#return">RETURN</a></li>
 240 <li class="toctree-l2"><a class="reference internal" href="memcached_generate_hash_value.html#see-also">SEE ALSO</a></li>
 241 </ul>
 242 </li>
 243 <li class="toctree-l1"><a class="reference internal" href="memcached_memory_allocators.html">Use custom allocators for embedded usage</a><ul>
 244 <li class="toctree-l2"><a class="reference internal" href="memcached_memory_allocators.html#synopsis">SYNOPSIS</a></li>
 245 <li class="toctree-l2"><a class="reference internal" href="memcached_memory_allocators.html#description">DESCRIPTION</a></li>
 246 <li class="toctree-l2"><a class="reference internal" href="memcached_memory_allocators.html#notes">NOTES</a></li>
 247 <li class="toctree-l2"><a class="reference internal" href="memcached_memory_allocators.html#return">RETURN</a></li>
 248 <li class="toctree-l2"><a class="reference internal" href="memcached_memory_allocators.html#see-also">SEE ALSO</a></li>
 249 </ul>
 250 </li>
 251 <li class="toctree-l1"><a class="reference internal" href="memcached_quit.html">Disconnecting a client from a server</a><ul>
 252 <li class="toctree-l2"><a class="reference internal" href="memcached_quit.html#synopsis">SYNOPSIS</a></li>
 253 <li class="toctree-l2"><a class="reference internal" href="memcached_quit.html#description">DESCRIPTION</a></li>
 254 <li class="toctree-l2"><a class="reference internal" href="memcached_quit.html#return">RETURN</a></li>
 255 <li class="toctree-l2"><a class="reference internal" href="memcached_quit.html#see-also">SEE ALSO</a></li>
 256 </ul>
 257 </li>
 258 <li class="toctree-l1"><a class="reference internal" href="libmemcached/memcached_return_t.html">Error Codes (memcached_return_t)</a><ul>
 259 <li class="toctree-l2"><a class="reference internal" href="libmemcached/memcached_return_t.html#synopsis">SYNOPSIS</a></li>
 260 <li class="toctree-l2"><a class="reference internal" href="libmemcached/memcached_return_t.html#see-also">SEE ALSO</a></li>
 261 </ul>
 262 </li>
 263 <li class="toctree-l1"><a class="reference internal" href="memcached_sasl.html">SASL support</a><ul>
 264 <li class="toctree-l2"><a class="reference internal" href="memcached_sasl.html#synopsis">SYNOPSIS</a></li>
 265 <li class="toctree-l2"><a class="reference internal" href="memcached_sasl.html#description">DESCRIPTION</a></li>
 266 <li class="toctree-l2"><a class="reference internal" href="memcached_sasl.html#return">RETURN</a></li>
 267 <li class="toctree-l2"><a class="reference internal" href="memcached_sasl.html#see-also">SEE ALSO</a></li>
 268 </ul>
 269 </li>
 270 <li class="toctree-l1"><a class="reference internal" href="memcached_server_st.html">Managing lists of servers</a><ul>
 271 <li class="toctree-l2"><a class="reference internal" href="memcached_server_st.html#synopsis">SYNOPSIS</a></li>
 272 <li class="toctree-l2"><a class="reference internal" href="memcached_server_st.html#description">DESCRIPTION</a></li>
 273 <li class="toctree-l2"><a class="reference internal" href="memcached_server_st.html#return">RETURN</a></li>
 274 <li class="toctree-l2"><a class="reference internal" href="memcached_server_st.html#see-also">SEE ALSO</a></li>
 275 </ul>
 276 </li>
 277 <li class="toctree-l1"><a class="reference internal" href="memcached_servers.html">Manipulate the server information stored in memcached_st</a><ul>
 278 <li class="toctree-l2"><a class="reference internal" href="memcached_servers.html#synopsis">SYNOPSIS</a></li>
 279 <li class="toctree-l2"><a class="reference internal" href="memcached_servers.html#description">DESCRIPTION</a></li>
 280 <li class="toctree-l2"><a class="reference internal" href="memcached_servers.html#return">RETURN</a></li>
 281 <li class="toctree-l2"><a class="reference internal" href="memcached_servers.html#see-also">SEE ALSO</a></li>
 282 </ul>
 283 </li>
 284 <li class="toctree-l1"><a class="reference internal" href="memcached_strerror.html">Converting Errors, memcached_return_t, to strings</a><ul>
 285 <li class="toctree-l2"><a class="reference internal" href="memcached_strerror.html#synopsis">SYNOPSIS</a></li>
 286 <li class="toctree-l2"><a class="reference internal" href="memcached_strerror.html#description">DESCRIPTION</a></li>
 287 <li class="toctree-l2"><a class="reference internal" href="memcached_strerror.html#return">RETURN</a></li>
 288 <li class="toctree-l2"><a class="reference internal" href="memcached_strerror.html#see-also">SEE ALSO</a></li>
 289 </ul>
 290 </li>
 291 <li class="toctree-l1"><a class="reference internal" href="error_messages.html">Client Error messages</a><ul>
 292 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_AUTH_CONTINUE.html">MEMCACHED_AUTH_CONTINUE</a></li>
 293 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_AUTH_FAILURE.html">MEMCACHED_AUTH_FAILURE</a></li>
 294 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_AUTH_PROBLEM.html">MEMCACHED_AUTH_PROBLEM</a></li>
 295 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_BAD_KEY_PROVIDED.html">MEMCACHED_BAD_KEY_PROVIDED</a></li>
 296 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_BUFFERED.html">MEMCACHED_BUFFERED</a></li>
 297 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_CLIENT_ERROR.html">MEMCACHED_CLIENT_ERROR</a></li>
 298 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_CONNECTION_BIND_FAILURE.html">MEMCACHED_CONNECTION_BIND_FAILURE</a></li>
 299 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_CONNECTION_FAILURE.html">MEMCACHED_CONNECTION_FAILURE</a></li>
 300 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE.html">MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE</a></li>
 301 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_DATA_DOES_NOT_EXIST.html">MEMCACHED_DATA_DOES_NOT_EXIST</a></li>
 302 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_DATA_EXISTS.html">MEMCACHED_DATA_EXISTS</a></li>
 303 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_DELETED.html">MEMCACHED_DELETED</a></li>
 304 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_DEPRECATED.html">MEMCACHED_DEPRECATED</a></li>
 305 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_E2BIG.html">MEMCACHED_E2BIG</a></li>
 306 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_END.html">MEMCACHED_END</a></li>
 307 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_ERRNO.html">MEMCACHED_ERRNO</a></li>
 308 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_FAILURE.html">MEMCACHED_FAILURE</a></li>
 309 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_FAIL_UNIX_SOCKET.html">MEMCACHED_FAIL_UNIX_SOCKET</a></li>
 310 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_FETCH_NOTFINISHED.html">MEMCACHED_FETCH_NOTFINISHED</a></li>
 311 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_HOST_LOOKUP_FAILURE.html">MEMCACHED_HOST_LOOKUP_FAILURE</a></li>
 312 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_INVALID_ARGUMENTS.html">MEMCACHED_INVALID_ARGUMENTS</a></li>
 313 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_INVALID_HOST_PROTOCOL.html">MEMCACHED_INVALID_HOST_PROTOCOL</a></li>
 314 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_ITEM.html">MEMCACHED_ITEM</a></li>
 315 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_KEY_TOO_BIG.html">MEMCACHED_KEY_TOO_BIG</a></li>
 316 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_MAXIMUM_RETURN.html">MEMCACHED_MAXIMUM_RETURN</a></li>
 317 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_MEMORY_ALLOCATION_FAILURE.html">MEMCACHED_MEMORY_ALLOCATION_FAILURE</a></li>
 318 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_NOTFOUND.html">MEMCACHED_NOTFOUND</a></li>
 319 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_NOTSTORED.html">MEMCACHED_NOTSTORED</a></li>
 320 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_NOT_SUPPORTED.html">MEMCACHED_NOT_SUPPORTED</a></li>
 321 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_NO_KEY_PROVIDED.html">MEMCACHED_NO_KEY_PROVIDED</a></li>
 322 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_NO_SERVERS.html">MEMCACHED_NO_SERVERS</a></li>
 323 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_PARSE_ERROR.html">MEMCACHED_PARSE_ERROR</a></li>
 324 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_PARSE_USER_ERROR.html">MEMCACHED_PARSE_USER_ERROR</a></li>
 325 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_PARTIAL_READ.html">MEMCACHED_PARTIAL_READ</a></li>
 326 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_PROTOCOL_ERROR.html">MEMCACHED_PROTOCOL_ERROR</a></li>
 327 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_READ_FAILURE.html">MEMCACHED_READ_FAILURE</a></li>
 328 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_SERVER_ERROR.html">MEMCACHED_SERVER_ERROR</a></li>
 329 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_SERVER_MARKED_DEAD.html">MEMCACHED_SERVER_MARKED_DEAD</a></li>
 330 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_SOME_ERRORS.html">MEMCACHED_SOME_ERRORS</a></li>
 331 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_STAT.html">MEMCACHED_STAT</a></li>
 332 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_STORED.html">MEMCACHED_STORED</a></li>
 333 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_SUCCESS.html">MEMCACHED_SUCCESS</a></li>
 334 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_TIMEOUT.html">MEMCACHED_TIMEOUT</a></li>
 335 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_UNKNOWN_READ_FAILURE.html">MEMCACHED_UNKNOWN_READ_FAILURE</a></li>
 336 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_UNKNOWN_STAT_KEY.html">MEMCACHED_UNKNOWN_STAT_KEY</a></li>
 337 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_VALUE.html">MEMCACHED_VALUE</a></li>
 338 <li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_WRITE_FAILURE.html">MEMCACHED_WRITE_FAILURE</a></li>
 339 </ul>
 340 </li>
 341 <li class="toctree-l1"><a class="reference internal" href="memcached_user_data.html">Storing custom user information in the client.</a><ul>
 342 <li class="toctree-l2"><a class="reference internal" href="memcached_user_data.html#library">LIBRARY</a></li>
 343 <li class="toctree-l2"><a class="reference internal" href="memcached_user_data.html#synopsis">SYNOPSIS</a></li>
 344 <li class="toctree-l2"><a class="reference internal" href="memcached_user_data.html#description">DESCRIPTION</a></li>
 345 <li class="toctree-l2"><a class="reference internal" href="memcached_user_data.html#return">RETURN</a></li>
 346 <li class="toctree-l2"><a class="reference internal" href="memcached_user_data.html#see-also">SEE ALSO</a></li>
 347 </ul>
 348 </li>
 349 <li class="toctree-l1"><a class="reference internal" href="memcached_verbosity.html">Setting the verbosity of a server</a><ul>
 350 <li class="toctree-l2"><a class="reference internal" href="memcached_verbosity.html#synopsis">SYNOPSIS</a></li>
 351 <li class="toctree-l2"><a class="reference internal" href="memcached_verbosity.html#description">DESCRIPTION</a></li>
 352 <li class="toctree-l2"><a class="reference internal" href="memcached_verbosity.html#return">RETURN</a></li>
 353 <li class="toctree-l2"><a class="reference internal" href="memcached_verbosity.html#see-also">SEE ALSO</a></li>
 354 </ul>
 355 </li>
 356 <li class="toctree-l1"><a class="reference internal" href="memcached_version.html">Getting version information about the client and server</a><ul>
 357 <li class="toctree-l2"><a class="reference internal" href="memcached_version.html#synopsis">SYNOPSIS</a></li>
 358 <li class="toctree-l2"><a class="reference internal" href="memcached_version.html#description">DESCRIPTION</a></li>
 359 <li class="toctree-l2"><a class="reference internal" href="memcached_version.html#return">RETURN</a></li>
 360 <li class="toctree-l2"><a class="reference internal" href="memcached_version.html#see-also">SEE ALSO</a></li>
 361 </ul>
 362 </li>
 363 <li class="toctree-l1"><a class="reference internal" href="libmemcached/defaults.html">DEFAULTS</a></li>
 364 </ul>
 365 <p class="caption"><span class="caption-text">Interface Versions</span></p>
 366 <ul>
 367 <li class="toctree-l1"><a class="reference internal" href="libmemcached-1.0/index.html">libmemcached 1.0 API</a><ul>
 368 <li class="toctree-l2"><a class="reference internal" href="libmemcached-1.0/memcached_touch.html">memcached_touch, memcached_touch_by_key</a></li>
 369 </ul>
 370 </li>
 371 <li class="toctree-l1"><a class="reference internal" href="libmemcached-1.1/index.html">libmemcached 1.1 API</a></li>
 372 </ul>
 373 <p class="caption"><span class="caption-text">Deprecated Functions</span></p>
 374 <ul>
 375 <li class="toctree-l1"><a class="reference internal" href="libmemcached/memcached_fetch.html">memcached_fetch</a></li>
 376 </ul>
 377 <p class="caption"><span class="caption-text">Platform Specifics</span></p>
 378 <ul>
 379 <li class="toctree-l1"><a class="reference internal" href="tap.html">Systemtap support</a></li>
 380 <li class="toctree-l1"><a class="reference internal" href="types.html">Required C types</a><ul>
 381 <li class="toctree-l2"><a class="reference internal" href="types.html#types">Types</a></li>
 382 <li class="toctree-l2"><a class="reference internal" href="types.html#c-types-used">C Types Used</a></li>
 383 </ul>
 384 </li>
 385 </ul>
 386 <p class="caption"><span class="caption-text">Deriving Statistics from a Server</span></p>
 387 <ul>
 388 <li class="toctree-l1"><a class="reference internal" href="memcached_analyze.html">Analyzing servers</a><ul>
 389 <li class="toctree-l2"><a class="reference internal" href="memcached_analyze.html#synopsis">SYNOPSIS</a></li>
 390 <li class="toctree-l2"><a class="reference internal" href="memcached_analyze.html#description">DESCRIPTION</a></li>
 391 <li class="toctree-l2"><a class="reference internal" href="memcached_analyze.html#return">RETURN</a></li>
 392 <li class="toctree-l2"><a class="reference internal" href="memcached_analyze.html#see-also">SEE ALSO</a></li>
 393 </ul>
 394 </li>
 395 <li class="toctree-l1"><a class="reference internal" href="memcached_stats.html">Working with statistical information from a server</a><ul>
 396 <li class="toctree-l2"><a class="reference internal" href="memcached_stats.html#synopsis">SYNOPSIS</a></li>
 397 <li class="toctree-l2"><a class="reference internal" href="memcached_stats.html#description">DESCRIPTION</a></li>
 398 <li class="toctree-l2"><a class="reference internal" href="memcached_stats.html#return">RETURN</a></li>
 399 <li class="toctree-l2"><a class="reference internal" href="memcached_stats.html#see-also">SEE ALSO</a></li>
 400 </ul>
 401 </li>
 402 </ul>
 403 <p class="caption"><span class="caption-text">Libmemcachedutil</span></p>
 404 <ul>
 405 <li class="toctree-l1"><a class="reference internal" href="libmemcachedutil.html">Introducing libmemcachedutil</a><ul>
 406 <li class="toctree-l2"><a class="reference internal" href="libmemcachedutil.html#synopsis">SYNOPSIS</a></li>
 407 <li class="toctree-l2"><a class="reference internal" href="libmemcachedutil.html#description">DESCRIPTION</a></li>
 408 <li class="toctree-l2"><a class="reference internal" href="libmemcachedutil.html#threads">THREADS</a></li>
 409 <li class="toctree-l2"><a class="reference internal" href="libmemcachedutil.html#see-also">SEE ALSO</a></li>
 410 </ul>
 411 </li>
 412 <li class="toctree-l1"><a class="reference internal" href="memcached_pool.html">Working with memcached pools</a><ul>
 413 <li class="toctree-l2"><a class="reference internal" href="memcached_pool.html#synopsis">SYNOPSIS</a></li>
 414 <li class="toctree-l2"><a class="reference internal" href="memcached_pool.html#description">DESCRIPTION</a></li>
 415 <li class="toctree-l2"><a class="reference internal" href="memcached_pool.html#return">RETURN</a></li>
 416 <li class="toctree-l2"><a class="reference internal" href="memcached_pool.html#see-also">SEE ALSO</a></li>
 417 </ul>
 418 </li>
 419 </ul>
 420 <p class="caption"><span class="caption-text">Client Applications</span></p>
 421 <ul>
 422 <li class="toctree-l1"><a class="reference internal" href="bin/memcapable.html">memcapable - Checking a Memcached server capabilities and compatibility</a><ul>
 423 <li class="toctree-l2"><a class="reference internal" href="bin/memcapable.html#synopsis">SYNOPSIS</a></li>
 424 <li class="toctree-l2"><a class="reference internal" href="bin/memcapable.html#description">DESCRIPTION</a></li>
 425 <li class="toctree-l2"><a class="reference internal" href="bin/memcapable.html#limitations">LIMITATIONS</a></li>
 426 <li class="toctree-l2"><a class="reference internal" href="bin/memcapable.html#options">OPTIONS</a></li>
 427 <li class="toctree-l2"><a class="reference internal" href="bin/memcapable.html#see-also">SEE ALSO</a></li>
 428 </ul>
 429 </li>
 430 <li class="toctree-l1"><a class="reference internal" href="bin/memcat.html">memcat - “cat” data from a server</a><ul>
 431 <li class="toctree-l2"><a class="reference internal" href="bin/memcat.html#synopsis">SYNOPSIS</a></li>
 432 <li class="toctree-l2"><a class="reference internal" href="bin/memcat.html#description">DESCRIPTION</a></li>
 433 <li class="toctree-l2"><a class="reference internal" href="bin/memcat.html#options">OPTIONS</a></li>
 434 <li class="toctree-l2"><a class="reference internal" href="bin/memcat.html#see-also">SEE ALSO</a></li>
 435 </ul>
 436 </li>
 437 <li class="toctree-l1"><a class="reference internal" href="bin/memcp.html">memcp - Copy data to a server</a><ul>
 438 <li class="toctree-l2"><a class="reference internal" href="bin/memcp.html#synopsis">SYNOPSIS</a></li>
 439 <li class="toctree-l2"><a class="reference internal" href="bin/memcp.html#description">DESCRIPTION</a></li>
 440 <li class="toctree-l2"><a class="reference internal" href="bin/memcp.html#options">OPTIONS</a></li>
 441 <li class="toctree-l2"><a class="reference internal" href="bin/memcp.html#see-also">SEE ALSO</a></li>
 442 </ul>
 443 </li>
 444 <li class="toctree-l1"><a class="reference internal" href="bin/memdump.html">memdump - Dumping your server</a><ul>
 445 <li class="toctree-l2"><a class="reference internal" href="bin/memdump.html#synopsis">SYNOPSIS</a></li>
 446 <li class="toctree-l2"><a class="reference internal" href="bin/memdump.html#description">DESCRIPTION</a></li>
 447 <li class="toctree-l2"><a class="reference internal" href="bin/memdump.html#options">OPTIONS</a></li>
 448 <li class="toctree-l2"><a class="reference internal" href="bin/memdump.html#see-also">SEE ALSO</a></li>
 449 </ul>
 450 </li>
 451 <li class="toctree-l1"><a class="reference internal" href="bin/memerror.html">memerror - translate an error code to a string</a><ul>
 452 <li class="toctree-l2"><a class="reference internal" href="bin/memerror.html#synopsis">SYNOPSIS</a></li>
 453 <li class="toctree-l2"><a class="reference internal" href="bin/memerror.html#description">DESCRIPTION</a></li>
 454 <li class="toctree-l2"><a class="reference internal" href="bin/memerror.html#options">OPTIONS</a></li>
 455 <li class="toctree-l2"><a class="reference internal" href="bin/memerror.html#see-also">SEE ALSO</a></li>
 456 </ul>
 457 </li>
 458 <li class="toctree-l1"><a class="reference internal" href="bin/memflush.html">memflush - flush all data from a server</a><ul>
 459 <li class="toctree-l2"><a class="reference internal" href="bin/memflush.html#synopsis">SYNOPSIS</a></li>
 460 <li class="toctree-l2"><a class="reference internal" href="bin/memflush.html#description">DESCRIPTION</a></li>
 461 <li class="toctree-l2"><a class="reference internal" href="bin/memflush.html#options">OPTIONS</a></li>
 462 <li class="toctree-l2"><a class="reference internal" href="bin/memflush.html#see-also">SEE ALSO</a></li>
 463 </ul>
 464 </li>
 465 <li class="toctree-l1"><a class="reference internal" href="bin/memrm.html">memrm - Remove data from a server</a><ul>
 466 <li class="toctree-l2"><a class="reference internal" href="bin/memrm.html#synopsis">SYNOPSIS</a></li>
 467 <li class="toctree-l2"><a class="reference internal" href="bin/memrm.html#description">DESCRIPTION</a></li>
 468 <li class="toctree-l2"><a class="reference internal" href="bin/memrm.html#options">OPTIONS</a></li>
 469 <li class="toctree-l2"><a class="reference internal" href="bin/memrm.html#see-also">SEE ALSO</a></li>
 470 </ul>
 471 </li>
 472 <li class="toctree-l1"><a class="reference internal" href="bin/memslap.html">memslap - Load testing  and benchmarking a server</a><ul>
 473 <li class="toctree-l2"><a class="reference internal" href="bin/memslap.html#synopsis">SYNOPSIS</a></li>
 474 <li class="toctree-l2"><a class="reference internal" href="bin/memslap.html#description">DESCRIPTION</a></li>
 475 <li class="toctree-l2"><a class="reference internal" href="bin/memslap.html#options">OPTIONS</a></li>
 476 <li class="toctree-l2"><a class="reference internal" href="bin/memslap.html#see-also">SEE ALSO</a></li>
 477 </ul>
 478 </li>
 479 <li class="toctree-l1"><a class="reference internal" href="bin/memaslap.html">memaslap - Load testing  and benchmarking a server</a><ul>
 480 <li class="toctree-l2"><a class="reference internal" href="bin/memaslap.html#synopsis">SYNOPSIS</a></li>
 481 <li class="toctree-l2"><a class="reference internal" href="bin/memaslap.html#description">DESCRIPTION</a></li>
 482 <li class="toctree-l2"><a class="reference internal" href="bin/memaslap.html#features">FEATURES</a></li>
 483 <li class="toctree-l2"><a class="reference internal" href="bin/memaslap.html#details">DETAILS</a></li>
 484 <li class="toctree-l2"><a class="reference internal" href="bin/memaslap.html#usage">USAGE</a></li>
 485 <li class="toctree-l2"><a class="reference internal" href="bin/memaslap.html#configuration-file">Configuration file</a></li>
 486 <li class="toctree-l2"><a class="reference internal" href="bin/memaslap.html#format-of-output">Format of output</a></li>
 487 <li class="toctree-l2"><a class="reference internal" href="bin/memaslap.html#options">OPTIONS</a></li>
 488 <li class="toctree-l2"><a class="reference internal" href="bin/memaslap.html#examples">EXAMPLES</a></li>
 489 <li class="toctree-l2"><a class="reference internal" href="bin/memaslap.html#see-also">SEE ALSO</a></li>
 490 </ul>
 491 </li>
 492 <li class="toctree-l1"><a class="reference internal" href="bin/memstat.html">memstat - Gather statistics from a server</a><ul>
 493 <li class="toctree-l2"><a class="reference internal" href="bin/memstat.html#synopsis">SYNOPSIS</a></li>
 494 <li class="toctree-l2"><a class="reference internal" href="bin/memstat.html#description">DESCRIPTION</a></li>
 495 <li class="toctree-l2"><a class="reference internal" href="bin/memstat.html#options">OPTIONS</a></li>
 496 <li class="toctree-l2"><a class="reference internal" href="bin/memstat.html#see-also">SEE ALSO</a></li>
 497 </ul>
 498 </li>
 499 <li class="toctree-l1"><a class="reference internal" href="bin/memexist.html">memexist - Check for the existence of a key</a><ul>
 500 <li class="toctree-l2"><a class="reference internal" href="bin/memexist.html#synopsis">SYNOPSIS</a></li>
 501 <li class="toctree-l2"><a class="reference internal" href="bin/memexist.html#description">DESCRIPTION</a></li>
 502 <li class="toctree-l2"><a class="reference internal" href="bin/memexist.html#options">OPTIONS</a></li>
 503 <li class="toctree-l2"><a class="reference internal" href="bin/memexist.html#see-also">SEE ALSO</a></li>
 504 </ul>
 505 </li>
 506 <li class="toctree-l1"><a class="reference internal" href="bin/memparse.html">memparse - Parse an option string</a><ul>
 507 <li class="toctree-l2"><a class="reference internal" href="bin/memparse.html#synopsis">SYNOPSIS</a></li>
 508 <li class="toctree-l2"><a class="reference internal" href="bin/memparse.html#description">DESCRIPTION</a></li>
 509 <li class="toctree-l2"><a class="reference internal" href="bin/memparse.html#options">OPTIONS</a></li>
 510 <li class="toctree-l2"><a class="reference internal" href="bin/memparse.html#see-also">SEE ALSO</a></li>
 511 </ul>
 512 </li>
 513 <li class="toctree-l1"><a class="reference internal" href="bin/memping.html">memping - Test to see if a server is available.</a><ul>
 514 <li class="toctree-l2"><a class="reference internal" href="bin/memping.html#synopsis">SYNOPSIS</a></li>
 515 <li class="toctree-l2"><a class="reference internal" href="bin/memping.html#description">DESCRIPTION</a></li>
 516 <li class="toctree-l2"><a class="reference internal" href="bin/memping.html#options">OPTIONS</a></li>
 517 <li class="toctree-l2"><a class="reference internal" href="bin/memping.html#see-also">SEE ALSO</a></li>
 518 </ul>
 519 </li>
 520 <li class="toctree-l1"><a class="reference internal" href="bin/memtouch.html">memtouch - Touches a key.</a><ul>
 521 <li class="toctree-l2"><a class="reference internal" href="bin/memtouch.html#synopsis">SYNOPSIS</a></li>
 522 <li class="toctree-l2"><a class="reference internal" href="bin/memtouch.html#description">DESCRIPTION</a></li>
 523 <li class="toctree-l2"><a class="reference internal" href="bin/memtouch.html#options">OPTIONS</a></li>
 524 <li class="toctree-l2"><a class="reference internal" href="bin/memtouch.html#see-also">SEE ALSO</a></li>
 525 </ul>
 526 </li>
 527 </ul>
 528 <p class="caption"><span class="caption-text">Libhashkit</span></p>
 529 <ul>
 530 <li class="toctree-l1"><a class="reference internal" href="libhashkit.html">Introducing libhashkit</a><ul>
 531 <li class="toctree-l2"><a class="reference internal" href="libhashkit.html#description">DESCRIPTION</a></li>
 532 <li class="toctree-l2"><a class="reference internal" href="libhashkit.html#see-also">SEE ALSO</a></li>
 533 </ul>
 534 </li>
 535 <li class="toctree-l1"><a class="reference internal" href="hashkit_create.html">Creating a hashkit structure</a><ul>
 536 <li class="toctree-l2"><a class="reference internal" href="hashkit_create.html#synopsis">SYNOPSIS</a></li>
 537 <li class="toctree-l2"><a class="reference internal" href="hashkit_create.html#description">DESCRIPTION</a></li>
 538 <li class="toctree-l2"><a class="reference internal" href="hashkit_create.html#return-value">RETURN VALUE</a></li>
 539 <li class="toctree-l2"><a class="reference internal" href="hashkit_create.html#see-also">SEE ALSO</a></li>
 540 </ul>
 541 </li>
 542 <li class="toctree-l1"><a class="reference internal" href="hashkit_functions.html">Available Hashes</a><ul>
 543 <li class="toctree-l2"><a class="reference internal" href="hashkit_functions.html#synopsis">SYNOPSIS</a></li>
 544 <li class="toctree-l2"><a class="reference internal" href="hashkit_functions.html#description">DESCRIPTION</a></li>
 545 <li class="toctree-l2"><a class="reference internal" href="hashkit_functions.html#return-value">RETURN VALUE</a></li>
 546 <li class="toctree-l2"><a class="reference internal" href="hashkit_functions.html#see-also">SEE ALSO</a></li>
 547 </ul>
 548 </li>
 549 <li class="toctree-l1"><a class="reference internal" href="hashkit_value.html">hashkit_value</a><ul>
 550 <li class="toctree-l2"><a class="reference internal" href="hashkit_value.html#synopsis">SYNOPSIS</a></li>
 551 <li class="toctree-l2"><a class="reference internal" href="hashkit_value.html#description">DESCRIPTION</a></li>
 552 <li class="toctree-l2"><a class="reference internal" href="hashkit_value.html#return-value">RETURN VALUE</a></li>
 553 <li class="toctree-l2"><a class="reference internal" href="hashkit_value.html#see-also">SEE ALSO</a></li>
 554 </ul>
 555 </li>
 556 </ul>
 557
 558
 559
 560         </div>
 561       </div>
 562     </nav>
 563
 564     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 565
 566
 567       <nav class="wy-nav-top" aria-label="top navigation">
 568
 569           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 570           <a href="index.html">libmemcached</a>
 571
 572       </nav>
 573
 574
 575       <div class="wy-nav-content">
 576
 577         <div class="rst-content">
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595 <div role="navigation" aria-label="breadcrumbs navigation">
 596
 597   <ul class="wy-breadcrumbs">
 598
 599       <li><a href="index.html">Docs</a> &raquo;</li>
 600
 601       <li>Configuring Libmemcached</li>
 602
 603
 604       <li class="wy-breadcrumbs-aside">
 605
 606
 607
 608       </li>
 609
 610   </ul>
 611
 612
 613   <hr/>
 614 </div>
 615           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 616            <div itemprop="articleBody">
 617
 618   <div class="section" id="configuring-libmemcached">
 619 <h1>Configuring Libmemcached<a class="headerlink" href="#configuring-libmemcached" title="Permalink to this headline">¶</a></h1>
 620 <div class="section" id="synopsis">
 621 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
 622 <dl class="describe">
 623 <dt>
 624 <code class="sig-name descname">#include &lt;libmemcached-1.0/memcached.h&gt;</code></dt>
 625 <dd></dd></dl>
 626
 627 <dl class="function">
 628 <dt id="c.memcached">
 629 <a class="reference internal" href="memcached_create.html#c.memcached_st" title="memcached_st">memcached_st</a> *<code class="sig-name descname">memcached</code><span class="sig-paren">(</span>const char<em> *string</em>, size_t<em> string_length</em><span class="sig-paren">)</span><a class="headerlink" href="#c.memcached" title="Permalink to this definition">¶</a></dt>
 630 <dd></dd></dl>
 631
 632 <dl class="function">
 633 <dt id="c.libmemcached_check_configuration">
 634 <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">libmemcached_check_configuration</code><span class="sig-paren">(</span>const char<em> *option_string</em>, size_t<em> length</em>, char<em> *error_buffer</em>, size_t<em> error_buffer_size</em><span class="sig-paren">)</span><a class="headerlink" href="#c.libmemcached_check_configuration" title="Permalink to this definition">¶</a></dt>
 635 <dd></dd></dl>
 636
 637 <p>Compile and link with -lmemcached</p>
 638 </div>
 639 <div class="section" id="description">
 640 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
 641 <p>Libmemcached implements a custom language for configuring and modifying
 642 servers. By passing in an option string you can generate a <code class="docutils literal notranslate"><span class="pre">memcached_st</span></code> object
 643 that you can use in your application directly.</p>
 644 <div class="section" id="general-options">
 645 <h3>General Options:<a class="headerlink" href="#general-options" title="Permalink to this headline">¶</a></h3>
 646 <dl class="option">
 647 <dt id="cmdoption-server">
 648 <code class="sig-name descname">--SERVER</code><code class="sig-prename descclassname">=&lt;servername&gt;:&lt;optional_port&gt;/?&lt;optional_weight&gt;</code><a class="headerlink" href="#cmdoption-server" title="Permalink to this definition">¶</a></dt>
 649 <dd></dd></dl>
 650
 651 <p>Provide a servername to be used by the client.</p>
 652 <p>Providing a weight will cause weighting to occur with all hosts with each server getting a default weight of 1.</p>
 653 <dl class="option">
 654 <dt id="cmdoption-socket">
 655 <code class="sig-name descname">--SOCKET</code><code class="sig-prename descclassname">=&quot;&lt;filepath&gt;/?&lt;optional_weight&gt;&quot;</code><a class="headerlink" href="#cmdoption-socket" title="Permalink to this definition">¶</a></dt>
 656 <dd></dd></dl>
 657
 658 <p>Provide a filepath to a UNIX socket file. Providing a weight will cause weighting to occur with all hosts with each server getting a default weight of 1.</p>
 659 <dl class="option">
 660 <dt id="cmdoption-verify-key">
 661 <code class="sig-name descname">--VERIFY-KEY</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-verify-key" title="Permalink to this definition">¶</a></dt>
 662 <dd></dd></dl>
 663
 664 <p>Verify that keys that are being used fit within the design of the protocol being used.</p>
 665 <dl class="option">
 666 <dt id="cmdoption-remove-failed-servers">
 667 <code class="sig-name descname">--REMOVE_FAILED_SERVERS</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-remove-failed-servers" title="Permalink to this definition">¶</a></dt>
 668 <dd></dd></dl>
 669
 670 <p>Enable the behavior <a class="reference internal" href="memcached_behavior.html#c.MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS" title="MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS"><code class="xref c c-type docutils literal notranslate"><span class="pre">MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS</span></code></a>.</p>
 671 <dl class="option">
 672 <dt id="cmdoption-binary-protocol">
 673 <code class="sig-name descname">--BINARY-PROTOCOL</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-binary-protocol" title="Permalink to this definition">¶</a></dt>
 674 <dd></dd></dl>
 675
 676 <p>Force all connections to use the binary protocol.</p>
 677 <dl class="option">
 678 <dt id="cmdoption-buffer-requests">
 679 <code class="sig-name descname">--BUFFER-REQUESTS</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-buffer-requests" title="Permalink to this definition">¶</a></dt>
 680 <dd></dd></dl>
 681
 682 <p>Please see <a class="reference internal" href="memcached_behavior.html#c.MEMCACHED_BEHAVIOR_BUFFER_REQUESTS" title="MEMCACHED_BEHAVIOR_BUFFER_REQUESTS"><code class="xref c c-type docutils literal notranslate"><span class="pre">MEMCACHED_BEHAVIOR_BUFFER_REQUESTS</span></code></a>.</p>
 683 <dl class="option">
 684 <dt id="cmdoption-configure-file">
 685 <code class="sig-name descname">--CONFIGURE-FILE</code><code class="sig-prename descclassname">=</code><a class="headerlink" href="#cmdoption-configure-file" title="Permalink to this definition">¶</a></dt>
 686 <dd></dd></dl>
 687
 688 <p>Provide a configuration file to be used to load requests. Beware that by using a configuration file libmemcached will reset memcached_st based on information only contained in the file.</p>
 689 <dl class="option">
 690 <dt id="cmdoption-connect-timeout">
 691 <code class="sig-name descname">--CONNECT-TIMEOUT</code><code class="sig-prename descclassname">=</code><a class="headerlink" href="#cmdoption-connect-timeout" title="Permalink to this definition">¶</a></dt>
 692 <dd></dd></dl>
 693
 694 <p>Please see <a class="reference internal" href="memcached_behavior.html#c.MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT" title="MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT"><code class="xref c c-type docutils literal notranslate"><span class="pre">MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT</span></code></a>.</p>
 695 <dl class="option">
 696 <dt id="cmdoption-distribution">
 697 <code class="sig-name descname">--DISTRIBUTION</code><code class="sig-prename descclassname">=</code><a class="headerlink" href="#cmdoption-distribution" title="Permalink to this definition">¶</a></dt>
 698 <dd></dd></dl>
 699
 700 <p>Set the distribution model used by the client.  See <em class="manpage">memcached_behavior_set(3)</em> for more details.</p>
 701 <dl class="option">
 702 <dt id="cmdoption-hash">
 703 <code class="sig-name descname">--HASH</code><code class="sig-prename descclassname">=</code><a class="headerlink" href="#cmdoption-hash" title="Permalink to this definition">¶</a></dt>
 704 <dd></dd></dl>
 705
 706 <p>Set the hashing algorithm used for placing keys on servers.</p>
 707 <dl class="option">
 708 <dt id="cmdoption-hash-with-namespace">
 709 <code class="sig-name descname">--HASH-WITH-NAMESPACE</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-hash-with-namespace" title="Permalink to this definition">¶</a></dt>
 710 <dd></dd></dl>
 711
 712 <p>When enabled the prefix key will be added to the key when determining which
 713 server to store the data in.</p>
 714 <dl class="option">
 715 <dt id="cmdoption-noreply">
 716 <code class="sig-name descname">--NOREPLY</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-noreply" title="Permalink to this definition">¶</a></dt>
 717 <dd></dd></dl>
 718
 719 <p>Enable “no reply” for all calls that support this. It is highly recommended
 720 that you use this option with the binary protocol only.</p>
 721 <dl class="option">
 722 <dt id="cmdoption-number-of-replicas">
 723 <code class="sig-name descname">--NUMBER-OF-REPLICAS</code><code class="sig-prename descclassname">=</code><a class="headerlink" href="#cmdoption-number-of-replicas" title="Permalink to this definition">¶</a></dt>
 724 <dd></dd></dl>
 725
 726 <p>Set the number of servers that keys will be replicated to.</p>
 727 <dl class="option">
 728 <dt id="cmdoption-randomize-replica-read">
 729 <code class="sig-name descname">--RANDOMIZE-REPLICA-READ</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-randomize-replica-read" title="Permalink to this definition">¶</a></dt>
 730 <dd></dd></dl>
 731
 732 <p>Select randomly the server within the replication pool to read from.</p>
 733 <dl class="option">
 734 <dt id="cmdoption-sort-hosts">
 735 <code class="sig-name descname">--SORT-HOSTS</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-sort-hosts" title="Permalink to this definition">¶</a></dt>
 736 <dd></dd></dl>
 737
 738 <p>When adding new servers always calculate their distribution based on sorted naming order.</p>
 739 <dl class="option">
 740 <dt id="cmdoption-support-cas">
 741 <code class="sig-name descname">--SUPPORT-CAS</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-support-cas" title="Permalink to this definition">¶</a></dt>
 742 <dd></dd></dl>
 743
 744 <p>See <em class="manpage">memcached_behavior_set(3)</em> for <a class="reference internal" href="memcached_behavior.html#c.MEMCACHED_BEHAVIOR_SUPPORT_CAS" title="MEMCACHED_BEHAVIOR_SUPPORT_CAS"><code class="xref c c-type docutils literal notranslate"><span class="pre">MEMCACHED_BEHAVIOR_SUPPORT_CAS</span></code></a></p>
 745 <dl class="option">
 746 <dt id="cmdoption-use-udp">
 747 <code class="sig-name descname">--USE-UDP</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-use-udp" title="Permalink to this definition">¶</a></dt>
 748 <dd></dd></dl>
 749
 750 <p>See <em class="manpage">memcached_behavior_set(3)</em> for <a class="reference internal" href="memcached_behavior.html#c.MEMCACHED_BEHAVIOR_USE_UDP" title="MEMCACHED_BEHAVIOR_USE_UDP"><code class="xref c c-type docutils literal notranslate"><span class="pre">MEMCACHED_BEHAVIOR_USE_UDP</span></code></a></p>
 751 <dl class="option">
 752 <dt id="cmdoption-namespace">
 753 <code class="sig-name descname">--NAMESPACE</code><code class="sig-prename descclassname">=</code><a class="headerlink" href="#cmdoption-namespace" title="Permalink to this definition">¶</a></dt>
 754 <dd></dd></dl>
 755
 756 <p>A namespace is a container that provides context for keys, only other
 757 requests that know the namespace can access these values. This is
 758 accomplished by prepending the namespace value to all keys.</p>
 759 <div class="section" id="memcached-pool-options">
 760 <h4>Memcached Pool Options:<a class="headerlink" href="#memcached-pool-options" title="Permalink to this headline">¶</a></h4>
 761 <dl class="option">
 762 <dt id="cmdoption-pool-min">
 763 <code class="sig-name descname">--POOL-MIN</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-pool-min" title="Permalink to this definition">¶</a></dt>
 764 <dd></dd></dl>
 765
 766 <p>Initial size of pool.</p>
 767 <dl class="option">
 768 <dt id="cmdoption-pool-max">
 769 <code class="sig-name descname">--POOL-MAX</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-pool-max" title="Permalink to this definition">¶</a></dt>
 770 <dd></dd></dl>
 771
 772 <p>Maximize size of the pool.</p>
 773 </div>
 774 <div class="section" id="i-o-options">
 775 <h4>I/O Options:<a class="headerlink" href="#i-o-options" title="Permalink to this headline">¶</a></h4>
 776 <dl class="option">
 777 <dt id="cmdoption-tcp-nodelay">
 778 <code class="sig-name descname">--TCP-NODELAY</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-tcp-nodelay" title="Permalink to this definition">¶</a></dt>
 779 <dd></dd></dl>
 780
 781 <p>See <em class="manpage">memcached_behavior_set(3)</em> for MEMCACHED_BEHAVIOR_TCP_NODELAY</p>
 782 <dl class="option">
 783 <dt id="cmdoption-tcp-keepalive">
 784 <code class="sig-name descname">--TCP-KEEPALIVE</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-tcp-keepalive" title="Permalink to this definition">¶</a></dt>
 785 <dd></dd></dl>
 786
 787 <p>See <em class="manpage">memcached_behavior_set(3)</em> for MEMCACHED_BEHAVIOR_TCP_KEEPALIVE</p>
 788 <dl class="option">
 789 <dt id="cmdoption-retry-timeout">
 790 <code class="sig-name descname">--RETRY-TIMEOUT</code><code class="sig-prename descclassname">=</code><a class="headerlink" href="#cmdoption-retry-timeout" title="Permalink to this definition">¶</a></dt>
 791 <dd></dd></dl>
 792
 793 <p>See <em class="manpage">memcached_behavior_set(3)</em> for MEMCACHED_BEHAVIOR_RETRY_TIMEOUT</p>
 794 <dl class="option">
 795 <dt id="cmdoption-server-failure-limit">
 796 <code class="sig-name descname">--SERVER-FAILURE-LIMIT</code><code class="sig-prename descclassname">=</code><a class="headerlink" href="#cmdoption-server-failure-limit" title="Permalink to this definition">¶</a></dt>
 797 <dd></dd></dl>
 798
 799 <p>See <em class="manpage">memcached_behavior_set(3)</em> for MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT</p>
 800 <dl class="option">
 801 <dt id="cmdoption-snd-timeout">
 802 <code class="sig-name descname">--SND-TIMEOUT</code><code class="sig-prename descclassname">=</code><a class="headerlink" href="#cmdoption-snd-timeout" title="Permalink to this definition">¶</a></dt>
 803 <dd></dd></dl>
 804
 805 <p>See <em class="manpage">memcached_behavior_set(3)</em> for MEMCACHED_BEHAVIOR_SND_TIMEOUT</p>
 806 <dl class="option">
 807 <dt id="cmdoption-socket-recv-size">
 808 <code class="sig-name descname">--SOCKET-RECV-SIZE</code><code class="sig-prename descclassname">=</code><a class="headerlink" href="#cmdoption-socket-recv-size" title="Permalink to this definition">¶</a></dt>
 809 <dd></dd></dl>
 810
 811 <p>See <em class="manpage">memcached_behavior_set(3)</em> for MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE</p>
 812 <dl class="option">
 813 <dt id="cmdoption-socket-send-size">
 814 <code class="sig-name descname">--SOCKET-SEND-SIZE</code><code class="sig-prename descclassname">=</code><a class="headerlink" href="#cmdoption-socket-send-size" title="Permalink to this definition">¶</a></dt>
 815 <dd></dd></dl>
 816
 817 <p>See <em class="manpage">memcached_behavior_set(3)</em> for MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE</p>
 818 <dl class="option">
 819 <dt id="cmdoption-poll-timeout">
 820 <code class="sig-name descname">--POLL-TIMEOUT</code><code class="sig-prename descclassname">=</code><a class="headerlink" href="#cmdoption-poll-timeout" title="Permalink to this definition">¶</a></dt>
 821 <dd></dd></dl>
 822
 823 <p>That sets the value of the timeout used by :manpage: <cite>poll()</cite>.</p>
 824 <dl class="option">
 825 <dt id="cmdoption-io-bytes-watermark">
 826 <code class="sig-name descname">--IO-BYTES-WATERMARK</code><code class="sig-prename descclassname">=</code><a class="headerlink" href="#cmdoption-io-bytes-watermark" title="Permalink to this definition">¶</a></dt>
 827 <dd></dd></dl>
 828
 829 <dl class="option">
 830 <dt id="cmdoption-io-key-prefetch">
 831 <code class="sig-name descname">--IO-KEY-PREFETCH</code><code class="sig-prename descclassname">=</code><a class="headerlink" href="#cmdoption-io-key-prefetch" title="Permalink to this definition">¶</a></dt>
 832 <dd></dd></dl>
 833
 834 <dl class="option">
 835 <dt id="cmdoption-io-msg-watermark">
 836 <code class="sig-name descname">--IO-MSG-WATERMARK</code><code class="sig-prename descclassname">=</code><a class="headerlink" href="#cmdoption-io-msg-watermark" title="Permalink to this definition">¶</a></dt>
 837 <dd></dd></dl>
 838
 839 <dl class="option">
 840 <dt id="cmdoption-tcp-keepidle">
 841 <code class="sig-name descname">--TCP-KEEPIDLE</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-tcp-keepidle" title="Permalink to this definition">¶</a></dt>
 842 <dd></dd></dl>
 843
 844 <dl class="option">
 845 <dt id="cmdoption-rcv-timeout">
 846 <code class="sig-name descname">--RCV-TIMEOUT</code><code class="sig-prename descclassname">=</code><a class="headerlink" href="#cmdoption-rcv-timeout" title="Permalink to this definition">¶</a></dt>
 847 <dd></dd></dl>
 848
 849 </div>
 850 </div>
 851 <div class="section" id="other-options">
 852 <h3>Other Options:<a class="headerlink" href="#other-options" title="Permalink to this headline">¶</a></h3>
 853 <dl class="option">
 854 <dt id="cmdoption-arg-include">
 855 <code class="sig-name descname">INCLUDE</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-arg-include" title="Permalink to this definition">¶</a></dt>
 856 <dd></dd></dl>
 857
 858 <p>Include a file in configuration. Unlike –CONFIGURE-FILE= this will not reset memcached_st</p>
 859 <dl class="option">
 860 <dt id="cmdoption-arg-reset">
 861 <code class="sig-name descname">RESET</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-arg-reset" title="Permalink to this definition">¶</a></dt>
 862 <dd></dd></dl>
 863
 864 <p>Reset memcached_st and continue to process.</p>
 865 <dl class="option">
 866 <dt id="cmdoption-arg-end">
 867 <code class="sig-name descname">END</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-arg-end" title="Permalink to this definition">¶</a></dt>
 868 <dd></dd></dl>
 869
 870 <p>End configuration processing.</p>
 871 <dl class="option">
 872 <dt id="cmdoption-arg-error">
 873 <code class="sig-name descname">ERROR</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-arg-error" title="Permalink to this definition">¶</a></dt>
 874 <dd></dd></dl>
 875
 876 <p>End configuration processing and throw an error.</p>
 877 </div>
 878 </div>
 879 <div class="section" id="environment">
 880 <h2>ENVIRONMENT<a class="headerlink" href="#environment" title="Permalink to this headline">¶</a></h2>
 881 <dl class="envvar">
 882 <dt id="envvar-LIBMEMCACHED">
 883 <code class="sig-name descname">LIBMEMCACHED</code><a class="headerlink" href="#envvar-LIBMEMCACHED" title="Permalink to this definition">¶</a></dt>
 884 <dd></dd></dl>
 885
 886 </div>
 887 <div class="section" id="return">
 888 <h2>RETURN<a class="headerlink" href="#return" title="Permalink to this headline">¶</a></h2>
 889 <p><a class="reference internal" href="#c.memcached" title="memcached"><code class="xref c c-func docutils literal notranslate"><span class="pre">memcached()</span></code></a> returns a pointer to the memcached_st that was
 890 created (or initialized).  On an allocation failure, it returns NULL.</p>
 891 </div>
 892 <div class="section" id="example">
 893 <h2>EXAMPLE<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2>
 894 <div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="k">const</span> <span class="kt">char</span> <span class="o">*</span><span class="n">config_string</span><span class="o">=</span>
 895   <span class="s">&quot;--SERVER=host10.example.com &quot;</span>
 896   <span class="s">&quot;--SERVER=host11.example.com &quot;</span>
 897   <span class="s">&quot;--SERVER=host10.example.com&quot;</span><span class="p">;</span>
 898 <span class="n">memcached_st</span> <span class="o">*</span><span class="n">memc</span><span class="o">=</span> <span class="n">memcached</span><span class="p">(</span><span class="n">config_string</span><span class="p">,</span> <span class="n">strlen</span><span class="p">(</span><span class="n">config_string</span><span class="p">));</span>
 899 <span class="p">{</span>
 900   <span class="c1">// ...</span>
 901 <span class="p">}</span>
 902 <span class="n">memcached_free</span><span class="p">(</span><span class="n">memc</span><span class="p">);</span>
 903 </pre></div>
 904 </div>
 905 </div>
 906 <div class="section" id="see-also">
 907 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
 908 <p><em class="manpage">memcached(1)</em> <em class="manpage">libmemcached(3)</em> <em class="manpage">memcached_strerror(3)</em></p>
 909 </div>
 910 </div>
 911
 912
 913            </div>
 914
 915           </div>
 916           <footer>
 917
 918     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 919
 920         <a href="libmemcached/memcached_last_error_message.html" class="btn btn-neutral float-right" title="Retrieving errors" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 921
 922
 923         <a href="libmemcached_examples.html" class="btn btn-neutral float-left" title="Examples" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 924
 925     </div>
 926
 927
 928   <hr/>
 929
 930   <div role="contentinfo">
 931     <p>
 932         &copy; <a href="copyright.html">Copyright</a>
 933
 934     </p>
 935   </div>
 936   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>.
 937
 938 </footer>
 939
 940         </div>
 941       </div>
 942
 943     </section>
 944
 945   </div>
 946
 947
 948
 949   <script type="text/javascript">
 950       jQuery(function () {
 951           SphinxRtdTheme.Navigation.enable(true);
 952       });
 953   </script>
 954
 955
 956
 957
 958
 959
 960 </body>
 961 </html>