git.m6w6.name Git - m6w6/libmemcached/blob - libmemcached/constants.html

   1
   2
   3 <!DOCTYPE html>
   4 <html class="writer-html5" lang="en" >
   5 <head>
   6   <meta charset="utf-8">
   7
   8   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   9
  10   <title>libmemcached Constants and Defaults &mdash; libmemcached 1.0.99 documentation</title>
  11
  12
  13
  14   <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  15   <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  16
  17
  18
  19
  20
  21
  22
  23   <!--[if lt IE 9]>
  24     <script src="../_static/js/html5shiv.min.js"></script>
  25   <![endif]-->
  26
  27
  28       <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
  29         <script src="../_static/jquery.js"></script>
  30         <script src="../_static/underscore.js"></script>
  31         <script src="../_static/doctools.js"></script>
  32         <script src="../_static/language_data.js"></script>
  33
  34     <script type="text/javascript" src="../_static/js/theme.js"></script>
  35
  36
  37     <link rel="index" title="Index" href="../genindex.html" />
  38     <link rel="search" title="Search" href="../search.html" />
  39     <link rel="copyright" title="Copyright" href="../copyright.html" />
  40     <link rel="next" title="libmemcached Examples" href="examples.html" />
  41     <link rel="prev" title="libmemcached Configuration" href="configuration.html" />
  42 </head>
  43
  44 <body class="wy-body-for-nav">
  45
  46
  47   <div class="wy-grid-for-nav">
  48
  49     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  50       <div class="wy-side-scroll">
  51         <div class="wy-side-nav-search" >
  52
  53
  54
  55             <a href="../index.html" class="icon icon-home" alt="Documentation Home"> libmemcached
  56
  57
  58
  59           </a>
  60
  61
  62
  63
  64               <div class="version">
  65                 1.0
  66               </div>
  67
  68
  69
  70
  71 <div role="search">
  72   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
  73     <input type="text" name="q" placeholder="Search docs" />
  74     <input type="hidden" name="check_keywords" value="yes" />
  75     <input type="hidden" name="area" value="default" />
  76   </form>
  77 </div>
  78
  79
  80         </div>
  81
  82
  83         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  84
  85
  86
  87
  88
  89
  90               <p class="caption"><span class="caption-text">libmemcached</span></p>
  91 <ul class="current">
  92 <li class="toctree-l1"><a class="reference internal" href="../libmemcached.html">Introduction</a></li>
  93 <li class="toctree-l1"><a class="reference internal" href="index.html">libmemcached API</a></li>
  94 <li class="toctree-l1 current"><a class="reference internal" href="index_misc.html">Misc</a><ul class="current">
  95 <li class="toctree-l2"><a class="reference internal" href="configuration.html">Configuration</a></li>
  96 <li class="toctree-l2 current"><a class="current reference internal" href="#">Constants</a></li>
  97 <li class="toctree-l2"><a class="reference internal" href="examples.html">Examples</a></li>
  98 <li class="toctree-l2"><a class="reference internal" href="versioning.html">Versioning</a></li>
  99 </ul>
 100 </li>
 101 </ul>
 102 <p class="caption"><span class="caption-text">libmemcachedutil</span></p>
 103 <ul>
 104 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil.html">Introduction</a></li>
 105 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
 106 </ul>
 107 <p class="caption"><span class="caption-text">libhashkit</span></p>
 108 <ul>
 109 <li class="toctree-l1"><a class="reference internal" href="../libhashkit.html">Introduction</a></li>
 110 <li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a></li>
 111 </ul>
 112 <p class="caption"><span class="caption-text">Client Applications</span></p>
 113 <ul>
 114 <li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a></li>
 115 </ul>
 116 <p class="caption"><span class="caption-text">Copyright</span></p>
 117 <ul>
 118 <li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
 119 </ul>
 120
 121
 122
 123         </div>
 124
 125       </div>
 126     </nav>
 127
 128     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 129
 130
 131       <nav class="wy-nav-top" aria-label="top navigation">
 132
 133           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 134           <a href="../index.html">libmemcached</a>
 135
 136       </nav>
 137
 138
 139       <div class="wy-nav-content">
 140
 141         <div class="rst-content">
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159 <div role="navigation" aria-label="breadcrumbs navigation">
 160
 161   <ul class="wy-breadcrumbs">
 162
 163       <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
 164
 165           <li><a href="index_misc.html">Misc</a> &raquo;</li>
 166
 167       <li>libmemcached Constants and Defaults</li>
 168
 169
 170       <li class="wy-breadcrumbs-aside">
 171
 172
 173
 174       </li>
 175
 176   </ul>
 177
 178
 179   <hr/>
 180 </div>
 181           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 182            <div itemprop="articleBody">
 183
 184   <div class="section" id="libmemcached-constants-and-defaults">
 185 <h1>libmemcached Constants and Defaults<a class="headerlink" href="#libmemcached-constants-and-defaults" title="Permalink to this headline">¶</a></h1>
 186 <div class="section" id="synopsis">
 187 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
 188 <dl class="simple">
 189 <dt>#include &lt;libmemcached-1.0/memcached.h&gt;</dt><dd><p>Compile and link with -lmemcached</p>
 190 </dd>
 191 </dl>
 192 <dl class="c macro">
 193 <dt id="c.LIBMEMCACHED_VERSION_STRING">
 194 <code class="sig-name descname">LIBMEMCACHED_VERSION_STRING</code><a class="headerlink" href="#c.LIBMEMCACHED_VERSION_STRING" title="Permalink to this definition">¶</a><br /></dt>
 195 <dd><p>String value of libmemcached version such as &quot;1.0.99&quot;</p>
 196 </dd></dl>
 197
 198 <dl class="c macro">
 199 <dt id="c.LIBMEMCACHED_VERSION_HEX">
 200 <code class="sig-name descname">LIBMEMCACHED_VERSION_HEX</code><a class="headerlink" href="#c.LIBMEMCACHED_VERSION_HEX" title="Permalink to this definition">¶</a><br /></dt>
 201 <dd><p>Hex value of the version number, e.g. &quot;0x00048000&quot;.
 202 This can be used for comparing versions based on number.</p>
 203 </dd></dl>
 204
 205 <dl class="c macro">
 206 <dt id="c.MEMCACHED_DEFAULT_PORT">
 207 <code class="sig-name descname">MEMCACHED_DEFAULT_PORT</code><a class="headerlink" href="#c.MEMCACHED_DEFAULT_PORT" title="Permalink to this definition">¶</a><br /></dt>
 208 <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>
 209 </dd></dl>
 210
 211 <dl class="c macro">
 212 <dt id="c.MEMCACHED_DEFAULT_TIMEOUT">
 213 <code class="sig-name descname">MEMCACHED_DEFAULT_TIMEOUT</code><a class="headerlink" href="#c.MEMCACHED_DEFAULT_TIMEOUT" title="Permalink to this definition">¶</a><br /></dt>
 214 <dd><p>Default timeout of 5000 milliseconds.</p>
 215 </dd></dl>
 216
 217 <dl class="c macro">
 218 <dt id="c.MEMCACHED_DEFAULT_CONNECT_TIMEOUT">
 219 <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><br /></dt>
 220 <dd><p>Default connect timeout of 4000 milliseconds.</p>
 221 </dd></dl>
 222
 223 <dl class="c macro">
 224 <dt id="c.MEMCACHED_MAX_BUFFER">
 225 <code class="sig-name descname">MEMCACHED_MAX_BUFFER</code><a class="headerlink" href="#c.MEMCACHED_MAX_BUFFER" title="Permalink to this definition">¶</a><br /></dt>
 226 <dd><p>Default size of read/write buffers (which includes the null pointer).</p>
 227 </dd></dl>
 228
 229 <dl class="c macro">
 230 <dt id="c.MEMCACHED_MAX_KEY">
 231 <code class="sig-name descname">MEMCACHED_MAX_KEY</code><a class="headerlink" href="#c.MEMCACHED_MAX_KEY" title="Permalink to this definition">¶</a><br /></dt>
 232 <dd><p>Default maximum size of a key (which includes the null pointer). Master keys
 233 have no limit, this only applies to keys used for storage.</p>
 234 </dd></dl>
 235
 236 <dl class="c macro">
 237 <dt id="c.MEMCACHED_MAX_NAMESPACE">
 238 <code class="sig-name descname">MEMCACHED_MAX_NAMESPACE</code><a class="headerlink" href="#c.MEMCACHED_MAX_NAMESPACE" title="Permalink to this definition">¶</a><br /></dt>
 239 <dd><p>Maximum length allowed for namespacing of a key. Defaults to 128.</p>
 240 </dd></dl>
 241
 242 <dl class="c macro">
 243 <dt id="c.MEMCACHED_MAX_HOST_LENGTH">
 244 <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><br /></dt>
 245 <dd><p>Maximum allowed length of the hostname.</p>
 246 </dd></dl>
 247
 248 <dl class="c macro">
 249 <dt id="c.MEMCACHED_MAX_HOST_SORT_LENGTH">
 250 <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><br /></dt>
 251 <dd><p>Length of the host string used for sorting. Used for Ketama.</p>
 252 </dd></dl>
 253
 254 <dl class="c macro">
 255 <dt id="c.MEMCACHED_MAX_INTEGER_DISPLAY_LENGTH">
 256 <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><br /></dt>
 257 <dd><p>Maximum display width of an integer represented as string.</p>
 258 </dd></dl>
 259
 260 <dl class="c macro">
 261 <dt id="c.MEMCACHED_CONTINUUM_ADDITION">
 262 <code class="sig-name descname">MEMCACHED_CONTINUUM_ADDITION</code><a class="headerlink" href="#c.MEMCACHED_CONTINUUM_ADDITION" title="Permalink to this definition">¶</a><br /></dt>
 263 <dd><p>How many extra slots we should build for in the continuum, defaults to 10.</p>
 264 </dd></dl>
 265
 266 <dl class="c macro">
 267 <dt id="c.MEMCACHED_EXPIRATION_NOT_ADD">
 268 <code class="sig-name descname">MEMCACHED_EXPIRATION_NOT_ADD</code><a class="headerlink" href="#c.MEMCACHED_EXPIRATION_NOT_ADD" title="Permalink to this definition">¶</a><br /></dt>
 269 <dd><p>Value <code class="docutils literal notranslate"><span class="pre">0xffffffffU</span></code></p>
 270 </dd></dl>
 271
 272 <dl class="c macro">
 273 <dt id="c.MEMCACHED_STRIDE">
 274 <code class="sig-name descname">MEMCACHED_STRIDE</code><a class="headerlink" href="#c.MEMCACHED_STRIDE" title="Permalink to this definition">¶</a><br /></dt>
 275 <dd><p>This is the &quot;stride&quot; used in the consistent hash used between replicas.</p>
 276 </dd></dl>
 277
 278 <dl class="c macro">
 279 <dt id="c.MEMCACHED_SERVER_FAILURE_LIMIT">
 280 <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><br /></dt>
 281 <dd><p>Value 5</p>
 282 </dd></dl>
 283
 284 <dl class="c macro">
 285 <dt id="c.MEMCACHED_SERVER_FAILURE_RETRY_TIMEOUT">
 286 <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><br /></dt>
 287 <dd><p>Value 2</p>
 288 </dd></dl>
 289
 290 <dl class="c macro">
 291 <dt id="c.MEMCACHED_SERVER_FAILURE_DEAD_TIMEOUT">
 292 <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><br /></dt>
 293 <dd><p>Value 0</p>
 294 </dd></dl>
 295
 296 <dl class="c macro">
 297 <dt id="c.MEMCACHED_VERSION_STRING_LENGTH">
 298 <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><br /></dt>
 299 <dd><p>Value 24</p>
 300 </dd></dl>
 301
 302 </div>
 303 <div class="section" id="description">
 304 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
 305 <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>
 306 </div>
 307 </div>
 308
 309
 310            </div>
 311
 312           </div>
 313           <footer>
 314
 315     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 316
 317         <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>
 318
 319
 320         <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>
 321
 322     </div>
 323
 324
 325   <hr/>
 326
 327   <div role="contentinfo">
 328     <p>
 329
 330
 331         &copy; <a href="../copyright.html">Copyright</a>
 332
 333     </p>
 334   </div>
 335
 336
 337
 338     Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
 339
 340     <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
 341
 342     provided by <a href="https://readthedocs.org">Read the Docs</a>.
 343
 344 </footer>
 345
 346         </div>
 347       </div>
 348
 349     </section>
 350
 351   </div>
 352
 353
 354   <script type="text/javascript">
 355       jQuery(function () {
 356           SphinxRtdTheme.Navigation.enable(true);
 357       });
 358   </script>
 359
 360
 361
 362
 363
 364
 365 </body>
 366 </html>