git.m6w6.name Git - m6w6/libmemcached/blob - libmemcached/constants.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>libmemcached Constants and Defaults &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="libmemcached Examples" href="examples.html" />
  40     <link rel="prev" title="libmemcached Configuration" href="configuration.html" />
  41 </head>
  42
  43 <body class="wy-body-for-nav">
  44
  45
  46   <div class="wy-grid-for-nav">
  47
  48     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  49       <div class="wy-side-scroll">
  50         <div class="wy-side-nav-search" >
  51
  52
  53
  54             <a href="../index.html" class="icon icon-home"> libmemcached
  55
  56
  57
  58           </a>
  59
  60
  61
  62
  63               <div class="version">
  64                 1.0
  65               </div>
  66
  67
  68
  69
  70 <div role="search">
  71   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
  72     <input type="text" name="q" placeholder="Search docs" />
  73     <input type="hidden" name="check_keywords" value="yes" />
  74     <input type="hidden" name="area" value="default" />
  75   </form>
  76 </div>
  77
  78
  79         </div>
  80
  81         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  82
  83
  84
  85
  86
  87
  88               <p class="caption"><span class="caption-text">libmemcached</span></p>
  89 <ul class="current">
  90 <li class="toctree-l1"><a class="reference internal" href="../libmemcached.html">Introduction</a></li>
  91 <li class="toctree-l1"><a class="reference internal" href="index.html">libmemcached API</a><ul>
  92 <li class="toctree-l2"><a class="reference internal" href="index_basics.html">Basics</a></li>
  93 <li class="toctree-l2"><a class="reference internal" href="index_data.html">Working with Data</a></li>
  94 <li class="toctree-l2"><a class="reference internal" href="index_errors.html">Messages and Errors</a></li>
  95 <li class="toctree-l2"><a class="reference internal" href="index_advanced.html">Advanced Topics</a></li>
  96 <li class="toctree-l2"><a class="reference internal" href="index_deprecated.html">Deprecated Functionality</a></li>
  97 </ul>
  98 </li>
  99 <li class="toctree-l1 current"><a class="reference internal" href="index_misc.html">Misc</a><ul class="current">
 100 <li class="toctree-l2"><a class="reference internal" href="configuration.html">Configuration</a></li>
 101 <li class="toctree-l2 current"><a class="current reference internal" href="#">Constants</a></li>
 102 <li class="toctree-l2"><a class="reference internal" href="examples.html">Examples</a></li>
 103 <li class="toctree-l2"><a class="reference internal" href="versioning.html">Versioning</a></li>
 104 </ul>
 105 </li>
 106 </ul>
 107 <p class="caption"><span class="caption-text">libmemcachedutil</span></p>
 108 <ul>
 109 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil.html">Introduction</a></li>
 110 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a><ul>
 111 <li class="toctree-l2"><a class="reference internal" href="../libmemcachedutil/memcached_pool.html">Working with memcached pools</a></li>
 112 </ul>
 113 </li>
 114 </ul>
 115 <p class="caption"><span class="caption-text">libhashkit</span></p>
 116 <ul>
 117 <li class="toctree-l1"><a class="reference internal" href="../libhashkit.html">Introduction</a></li>
 118 <li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a><ul>
 119 <li class="toctree-l2"><a class="reference internal" href="../libhashkit/hashkit_create.html">Creating a hashkit structure</a></li>
 120 <li class="toctree-l2"><a class="reference internal" href="../libhashkit/hashkit_function.html">Set Hash Function</a></li>
 121 <li class="toctree-l2"><a class="reference internal" href="../libhashkit/hashkit_functions.html">Available Hashes</a></li>
 122 <li class="toctree-l2"><a class="reference internal" href="../libhashkit/hashkit_value.html">Generate hash value</a></li>
 123 </ul>
 124 </li>
 125 </ul>
 126 <p class="caption"><span class="caption-text">Client Applications</span></p>
 127 <ul>
 128 <li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a><ul>
 129 <li class="toctree-l2"><a class="reference internal" href="../bin/memcapable.html">memcapable - Checking a Memcached server capabilities and compatibility</a></li>
 130 <li class="toctree-l2"><a class="reference internal" href="../bin/memcat.html">memcat - “cat” data from a server</a></li>
 131 <li class="toctree-l2"><a class="reference internal" href="../bin/memcp.html">memcp - Copy data to a server</a></li>
 132 <li class="toctree-l2"><a class="reference internal" href="../bin/memdump.html">memdump - Dumping your server</a></li>
 133 <li class="toctree-l2"><a class="reference internal" href="../bin/memerror.html">memerror - translate an error code to a string</a></li>
 134 <li class="toctree-l2"><a class="reference internal" href="../bin/memflush.html">memflush - flush all data from a server</a></li>
 135 <li class="toctree-l2"><a class="reference internal" href="../bin/memrm.html">memrm - Remove data from a server</a></li>
 136 <li class="toctree-l2"><a class="reference internal" href="../bin/memslap.html">memslap - Load testing  and benchmarking a server</a></li>
 137 <li class="toctree-l2"><a class="reference internal" href="../bin/memaslap.html">memaslap - Load testing  and benchmarking a server</a></li>
 138 <li class="toctree-l2"><a class="reference internal" href="../bin/memstat.html">memstat - Gather statistics from a server</a></li>
 139 <li class="toctree-l2"><a class="reference internal" href="../bin/memexist.html">memexist - Check for the existence of a key</a></li>
 140 <li class="toctree-l2"><a class="reference internal" href="../bin/memparse.html">memparse - Parse an option string</a></li>
 141 <li class="toctree-l2"><a class="reference internal" href="../bin/memping.html">memping - Test to see if a server is available.</a></li>
 142 <li class="toctree-l2"><a class="reference internal" href="../bin/memtouch.html">memtouch - Touches a key.</a></li>
 143 </ul>
 144 </li>
 145 </ul>
 146
 147
 148
 149         </div>
 150       </div>
 151     </nav>
 152
 153     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 154
 155
 156       <nav class="wy-nav-top" aria-label="top navigation">
 157
 158           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 159           <a href="../index.html">libmemcached</a>
 160
 161       </nav>
 162
 163
 164       <div class="wy-nav-content">
 165
 166         <div class="rst-content">
 167
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184 <div role="navigation" aria-label="breadcrumbs navigation">
 185
 186   <ul class="wy-breadcrumbs">
 187
 188       <li><a href="../index.html">Docs</a> &raquo;</li>
 189
 190           <li><a href="index_misc.html">Misc</a> &raquo;</li>
 191
 192       <li>libmemcached Constants and Defaults</li>
 193
 194
 195       <li class="wy-breadcrumbs-aside">
 196
 197
 198
 199       </li>
 200
 201   </ul>
 202
 203
 204   <hr/>
 205 </div>
 206           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 207            <div itemprop="articleBody">
 208
 209   <div class="section" id="libmemcached-constants-and-defaults">
 210 <h1>libmemcached Constants and Defaults<a class="headerlink" href="#libmemcached-constants-and-defaults" title="Permalink to this headline">¶</a></h1>
 211 <div class="section" id="synopsis">
 212 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
 213 <dl class="simple">
 214 <dt>#include &lt;libmemcached-1.0/memcached.h&gt;</dt><dd><p>Compile and link with -lmemcached</p>
 215 </dd>
 216 </dl>
 217 <dl class="macro">
 218 <dt id="c.LIBMEMCACHED_VERSION_STRING">
 219 <code class="sig-name descname">LIBMEMCACHED_VERSION_STRING</code><a class="headerlink" href="#c.LIBMEMCACHED_VERSION_STRING" title="Permalink to this definition">¶</a></dt>
 220 <dd><p>String value of libmemcached version such as “1.23.4”</p>
 221 </dd></dl>
 222
 223 <dl class="macro">
 224 <dt id="c.LIBMEMCACHED_VERSION_HEX">
 225 <code class="sig-name descname">LIBMEMCACHED_VERSION_HEX</code><a class="headerlink" href="#c.LIBMEMCACHED_VERSION_HEX" title="Permalink to this definition">¶</a></dt>
 226 <dd><p>Hex value of the version number. “0x00048000” This can be used for comparing
 227 versions based on number.</p>
 228 </dd></dl>
 229
 230 <dl class="macro">
 231 <dt id="c.MEMCACHED_DEFAULT_PORT">
 232 <code class="sig-name descname">MEMCACHED_DEFAULT_PORT</code><a class="headerlink" href="#c.MEMCACHED_DEFAULT_PORT" title="Permalink to this definition">¶</a></dt>
 233 <dd><p>The default port used by <a class="reference internal" href="configuration.html#_CPPv49memcachedPKc6size_t" title="memcached"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached()</span></code></a>.</p>
 234 </dd></dl>
 235
 236 <dl class="macro">
 237 <dt id="c.MEMCACHED_DEFAULT_TIMEOUT">
 238 <code class="sig-name descname">MEMCACHED_DEFAULT_TIMEOUT</code><a class="headerlink" href="#c.MEMCACHED_DEFAULT_TIMEOUT" title="Permalink to this definition">¶</a></dt>
 239 <dd><p>Default timeout of 5000 milliseconds.</p>
 240 </dd></dl>
 241
 242 <dl class="macro">
 243 <dt id="c.MEMCACHED_DEFAULT_CONNECT_TIMEOUT">
 244 <code class="sig-name descname">MEMCACHED_DEFAULT_CONNECT_TIMEOUT</code><a class="headerlink" href="#c.MEMCACHED_DEFAULT_CONNECT_TIMEOUT" title="Permalink to this definition">¶</a></dt>
 245 <dd><p>Default connect timeout of 4000 milliseconds.</p>
 246 </dd></dl>
 247
 248 <dl class="macro">
 249 <dt id="c.MEMCACHED_MAX_BUFFER">
 250 <code class="sig-name descname">MEMCACHED_MAX_BUFFER</code><a class="headerlink" href="#c.MEMCACHED_MAX_BUFFER" title="Permalink to this definition">¶</a></dt>
 251 <dd><p>Default size of read/write buffers (which includes the null pointer).</p>
 252 </dd></dl>
 253
 254 <dl class="macro">
 255 <dt id="c.MEMCACHED_MAX_KEY">
 256 <code class="sig-name descname">MEMCACHED_MAX_KEY</code><a class="headerlink" href="#c.MEMCACHED_MAX_KEY" title="Permalink to this definition">¶</a></dt>
 257 <dd><p>Default maximum size of a key (which includes the null pointer). Master keys
 258 have no limit, this only applies to keys used for storage.</p>
 259 </dd></dl>
 260
 261 <dl class="macro">
 262 <dt id="c.MEMCACHED_MAX_NAMESPACE">
 263 <code class="sig-name descname">MEMCACHED_MAX_NAMESPACE</code><a class="headerlink" href="#c.MEMCACHED_MAX_NAMESPACE" title="Permalink to this definition">¶</a></dt>
 264 <dd><p>Maximum length allowed for namespacing of a key. Defaults to 128.</p>
 265 </dd></dl>
 266
 267 <dl class="macro">
 268 <dt id="c.MEMCACHED_MAX_HOST_LENGTH">
 269 <code class="sig-name descname">MEMCACHED_MAX_HOST_LENGTH</code><a class="headerlink" href="#c.MEMCACHED_MAX_HOST_LENGTH" title="Permalink to this definition">¶</a></dt>
 270 <dd><p>Maximum allowed length of the hostname.</p>
 271 </dd></dl>
 272
 273 <dl class="macro">
 274 <dt id="c.MEMCACHED_MAX_HOST_SORT_LENGTH">
 275 <code class="sig-name descname">MEMCACHED_MAX_HOST_SORT_LENGTH</code><a class="headerlink" href="#c.MEMCACHED_MAX_HOST_SORT_LENGTH" title="Permalink to this definition">¶</a></dt>
 276 <dd><p>Length of the host string used for sorting. Used for Ketama.</p>
 277 </dd></dl>
 278
 279 <dl class="macro">
 280 <dt id="c.MEMCACHED_MAX_INTEGER_DISPLAY_LENGTH">
 281 <code class="sig-name descname">MEMCACHED_MAX_INTEGER_DISPLAY_LENGTH</code><a class="headerlink" href="#c.MEMCACHED_MAX_INTEGER_DISPLAY_LENGTH" title="Permalink to this definition">¶</a></dt>
 282 <dd><p>Maximum display width of an integer represented as string.</p>
 283 </dd></dl>
 284
 285 <dl class="macro">
 286 <dt id="c.MEMCACHED_CONTINUUM_ADDITION">
 287 <code class="sig-name descname">MEMCACHED_CONTINUUM_ADDITION</code><a class="headerlink" href="#c.MEMCACHED_CONTINUUM_ADDITION" title="Permalink to this definition">¶</a></dt>
 288 <dd><p>How many extra slots we should build for in the continuum, defaults to 10.</p>
 289 </dd></dl>
 290
 291 <dl class="macro">
 292 <dt id="c.MEMCACHED_STRIDE">
 293 <code class="sig-name descname">MEMCACHED_STRIDE</code><a class="headerlink" href="#c.MEMCACHED_STRIDE" title="Permalink to this definition">¶</a></dt>
 294 <dd><p>This is the “stride” used in the consistent hash used between replicas.</p>
 295 </dd></dl>
 296
 297 <dl class="macro">
 298 <dt id="c.MEMCACHED_SERVER_FAILURE_LIMIT">
 299 <code class="sig-name descname">MEMCACHED_SERVER_FAILURE_LIMIT</code><a class="headerlink" href="#c.MEMCACHED_SERVER_FAILURE_LIMIT" title="Permalink to this definition">¶</a></dt>
 300 <dd><p>Value 5</p>
 301 </dd></dl>
 302
 303 <dl class="macro">
 304 <dt id="c.MEMCACHED_SERVER_FAILURE_RETRY_TIMEOUT">
 305 <code class="sig-name descname">MEMCACHED_SERVER_FAILURE_RETRY_TIMEOUT</code><a class="headerlink" href="#c.MEMCACHED_SERVER_FAILURE_RETRY_TIMEOUT" title="Permalink to this definition">¶</a></dt>
 306 <dd><p>Value 2</p>
 307 </dd></dl>
 308
 309 <dl class="macro">
 310 <dt id="c.MEMCACHED_SERVER_FAILURE_DEAD_TIMEOUT">
 311 <code class="sig-name descname">MEMCACHED_SERVER_FAILURE_DEAD_TIMEOUT</code><a class="headerlink" href="#c.MEMCACHED_SERVER_FAILURE_DEAD_TIMEOUT" title="Permalink to this definition">¶</a></dt>
 312 <dd><p>Value 0</p>
 313 </dd></dl>
 314
 315 <dl class="macro">
 316 <dt id="c.MEMCACHED_VERSION_STRING_LENGTH">
 317 <code class="sig-name descname">MEMCACHED_VERSION_STRING_LENGTH</code><a class="headerlink" href="#c.MEMCACHED_VERSION_STRING_LENGTH" title="Permalink to this definition">¶</a></dt>
 318 <dd><p>Value 24</p>
 319 </dd></dl>
 320
 321 </div>
 322 <div class="section" id="description">
 323 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
 324 <p>These compile time defaults are provided by <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">libmemcached</span></code> for convenience.</p>
 325 </div>
 326 </div>
 327
 328
 329            </div>
 330
 331           </div>
 332           <footer>
 333
 334     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 335
 336         <a href="examples.html" class="btn btn-neutral float-right" title="libmemcached Examples" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 337
 338
 339         <a href="configuration.html" class="btn btn-neutral float-left" title="libmemcached Configuration" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 340
 341     </div>
 342
 343
 344   <hr/>
 345
 346   <div role="contentinfo">
 347     <p>
 348         &copy; <a href="../copyright.html">Copyright</a>
 349
 350     </p>
 351   </div>
 352   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>.
 353
 354 </footer>
 355
 356         </div>
 357       </div>
 358
 359     </section>
 360
 361   </div>
 362
 363
 364
 365   <script type="text/javascript">
 366       jQuery(function () {
 367           SphinxRtdTheme.Navigation.enable(true);
 368       });
 369   </script>
 370
 371
 372
 373
 374
 375
 376 </body>
 377 </html>