Deploy to GitHub pages
[m6w6/libmemcached] / libmemcached / constants.html
index 929a3736fd6a06430664f172c657b391587b1f54..e44257aaa798f0bc10594f6ab0a7ea27ac5e1e9a 100644 (file)
@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>libmemcached Constants and Defaults &mdash; libmemcached 1.0.99 documentation</title>
+  <title>libmemcached Constants and Defaults &mdash; libmemcached 1.1.0 documentation</title>
   
 
   
   
     
       <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
-        <script src="../_static/jquery.js"></script>
-        <script src="../_static/underscore.js"></script>
-        <script src="../_static/doctools.js"></script>
-        <script src="../_static/language_data.js"></script>
+        <script type="text/javascript" src="../_static/jquery.js"></script>
+        <script type="text/javascript" src="../_static/underscore.js"></script>
+        <script type="text/javascript" src="../_static/doctools.js"></script>
+        <script type="text/javascript" src="../_static/language_data.js"></script>
     
     <script type="text/javascript" src="../_static/js/theme.js"></script>
 
@@ -61,7 +61,7 @@
             
             
               <div class="version">
-                1.0
+                1.1
               </div>
             
           
               
             
             
-              <p class="caption"><span class="caption-text">libmemcached</span></p>
-<ul class="current">
+              <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="../libmemcached.html">Introduction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="index.html">libmemcached API</a></li>
-<li class="toctree-l1 current"><a class="reference internal" href="index_misc.html">Misc</a><ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a></li>
+<li class="toctree-l1 current"><a class="reference internal" href="index_misc.html">Miscellaneous</a><ul class="current">
 <li class="toctree-l2"><a class="reference internal" href="configuration.html">Configuration</a></li>
 <li class="toctree-l2 current"><a class="current reference internal" href="#">Constants</a></li>
 <li class="toctree-l2"><a class="reference internal" href="examples.html">Examples</a></li>
 </ul>
 </li>
 </ul>
-<p class="caption"><span class="caption-text">libmemcachedutil</span></p>
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil.html">Introduction</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
-</ul>
-<p class="caption"><span class="caption-text">libhashkit</span></p>
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="../libhashkit.html">Introduction</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a></li>
-</ul>
-<p class="caption"><span class="caption-text">Client Applications</span></p>
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a></li>
-</ul>
-<p class="caption"><span class="caption-text">Copyright</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../changelogs.html">Change Logs</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
 </ul>
 
     
       <li><a href="../index.html">Docs</a> &raquo;</li>
         
-          <li><a href="index_misc.html">Misc</a> &raquo;</li>
+          <li><a href="index_misc.html">Miscellaneous</a> &raquo;</li>
         
       <li>libmemcached Constants and Defaults</li>
     
       <li class="wy-breadcrumbs-aside">
         
             
+            
+              <a href="https://github.com/m6w6/libmemcached/blob/v1.x/docs/source/libmemcached/constants.rst" class="fa fa-github"> Edit on GitHub</a>
+            
+          
         
       </li>
     
 <h1>libmemcached Constants and Defaults<a class="headerlink" href="#libmemcached-constants-and-defaults" title="Permalink to this headline">¶</a></h1>
 <div class="section" id="synopsis">
 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
-<dl class="simple">
-<dt>#include &lt;libmemcached-1.0/memcached.h&gt;</dt><dd><p>Compile and link with -lmemcached</p>
-</dd>
+<dl class="docutils">
+<dt>#include &lt;libmemcached-<a href="#id1"><span class="problematic" id="id2">|libmemcached_version|</span></a>/memcached.h&gt;</dt>
+<dd>Compile and link with -lmemcached</dd>
 </dl>
 <dl class="macro">
 <dt id="c.LIBMEMCACHED_VERSION_STRING">
-<code class="sig-name descname">LIBMEMCACHED_VERSION_STRING</code><a class="headerlink" href="#c.LIBMEMCACHED_VERSION_STRING" title="Permalink to this definition">¶</a></dt>
-<dd><p>String value of libmemcached version such as “1.23.4”</p>
+<code class="descname">LIBMEMCACHED_VERSION_STRING</code><a class="headerlink" href="#c.LIBMEMCACHED_VERSION_STRING" title="Permalink to this definition">¶</a></dt>
+<dd><p>String value of libmemcached version such as &quot;1.1.0&quot;</p>
 </dd></dl>
 
 <dl class="macro">
 <dt id="c.LIBMEMCACHED_VERSION_HEX">
-<code class="sig-name descname">LIBMEMCACHED_VERSION_HEX</code><a class="headerlink" href="#c.LIBMEMCACHED_VERSION_HEX" title="Permalink to this definition">¶</a></dt>
-<dd><p>Hex value of the version number. “0x00048000” This can be used for comparing
-versions based on number.</p>
+<code class="descname">LIBMEMCACHED_VERSION_HEX</code><a class="headerlink" href="#c.LIBMEMCACHED_VERSION_HEX" title="Permalink to this definition">¶</a></dt>
+<dd><p>Hex value of the version number, e.g. &quot;0x00048000&quot;.
+This can be used for comparing versions based on number.</p>
 </dd></dl>
 
 <dl class="macro">
 <dt id="c.MEMCACHED_DEFAULT_PORT">
-<code class="sig-name descname">MEMCACHED_DEFAULT_PORT</code><a class="headerlink" href="#c.MEMCACHED_DEFAULT_PORT" title="Permalink to this definition">¶</a></dt>
+<code class="descname">MEMCACHED_DEFAULT_PORT</code><a class="headerlink" href="#c.MEMCACHED_DEFAULT_PORT" title="Permalink to this definition">¶</a></dt>
 <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>
 </dd></dl>
 
 <dl class="macro">
 <dt id="c.MEMCACHED_DEFAULT_TIMEOUT">
-<code class="sig-name descname">MEMCACHED_DEFAULT_TIMEOUT</code><a class="headerlink" href="#c.MEMCACHED_DEFAULT_TIMEOUT" title="Permalink to this definition">¶</a></dt>
+<code class="descname">MEMCACHED_DEFAULT_TIMEOUT</code><a class="headerlink" href="#c.MEMCACHED_DEFAULT_TIMEOUT" title="Permalink to this definition">¶</a></dt>
 <dd><p>Default timeout of 5000 milliseconds.</p>
 </dd></dl>
 
 <dl class="macro">
 <dt id="c.MEMCACHED_DEFAULT_CONNECT_TIMEOUT">
-<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>
+<code class="descname">MEMCACHED_DEFAULT_CONNECT_TIMEOUT</code><a class="headerlink" href="#c.MEMCACHED_DEFAULT_CONNECT_TIMEOUT" title="Permalink to this definition">¶</a></dt>
 <dd><p>Default connect timeout of 4000 milliseconds.</p>
 </dd></dl>
 
 <dl class="macro">
 <dt id="c.MEMCACHED_MAX_BUFFER">
-<code class="sig-name descname">MEMCACHED_MAX_BUFFER</code><a class="headerlink" href="#c.MEMCACHED_MAX_BUFFER" title="Permalink to this definition">¶</a></dt>
+<code class="descname">MEMCACHED_MAX_BUFFER</code><a class="headerlink" href="#c.MEMCACHED_MAX_BUFFER" title="Permalink to this definition">¶</a></dt>
 <dd><p>Default size of read/write buffers (which includes the null pointer).</p>
 </dd></dl>
 
 <dl class="macro">
 <dt id="c.MEMCACHED_MAX_KEY">
-<code class="sig-name descname">MEMCACHED_MAX_KEY</code><a class="headerlink" href="#c.MEMCACHED_MAX_KEY" title="Permalink to this definition">¶</a></dt>
+<code class="descname">MEMCACHED_MAX_KEY</code><a class="headerlink" href="#c.MEMCACHED_MAX_KEY" title="Permalink to this definition">¶</a></dt>
 <dd><p>Default maximum size of a key (which includes the null pointer). Master keys
 have no limit, this only applies to keys used for storage.</p>
 </dd></dl>
 
 <dl class="macro">
 <dt id="c.MEMCACHED_MAX_NAMESPACE">
-<code class="sig-name descname">MEMCACHED_MAX_NAMESPACE</code><a class="headerlink" href="#c.MEMCACHED_MAX_NAMESPACE" title="Permalink to this definition">¶</a></dt>
+<code class="descname">MEMCACHED_MAX_NAMESPACE</code><a class="headerlink" href="#c.MEMCACHED_MAX_NAMESPACE" title="Permalink to this definition">¶</a></dt>
 <dd><p>Maximum length allowed for namespacing of a key. Defaults to 128.</p>
 </dd></dl>
 
 <dl class="macro">
 <dt id="c.MEMCACHED_MAX_HOST_LENGTH">
-<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>
+<code class="descname">MEMCACHED_MAX_HOST_LENGTH</code><a class="headerlink" href="#c.MEMCACHED_MAX_HOST_LENGTH" title="Permalink to this definition">¶</a></dt>
 <dd><p>Maximum allowed length of the hostname.</p>
 </dd></dl>
 
 <dl class="macro">
 <dt id="c.MEMCACHED_MAX_HOST_SORT_LENGTH">
-<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>
+<code class="descname">MEMCACHED_MAX_HOST_SORT_LENGTH</code><a class="headerlink" href="#c.MEMCACHED_MAX_HOST_SORT_LENGTH" title="Permalink to this definition">¶</a></dt>
 <dd><p>Length of the host string used for sorting. Used for Ketama.</p>
 </dd></dl>
 
 <dl class="macro">
 <dt id="c.MEMCACHED_MAX_INTEGER_DISPLAY_LENGTH">
-<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>
+<code class="descname">MEMCACHED_MAX_INTEGER_DISPLAY_LENGTH</code><a class="headerlink" href="#c.MEMCACHED_MAX_INTEGER_DISPLAY_LENGTH" title="Permalink to this definition">¶</a></dt>
 <dd><p>Maximum display width of an integer represented as string.</p>
 </dd></dl>
 
 <dl class="macro">
 <dt id="c.MEMCACHED_CONTINUUM_ADDITION">
-<code class="sig-name descname">MEMCACHED_CONTINUUM_ADDITION</code><a class="headerlink" href="#c.MEMCACHED_CONTINUUM_ADDITION" title="Permalink to this definition">¶</a></dt>
+<code class="descname">MEMCACHED_CONTINUUM_ADDITION</code><a class="headerlink" href="#c.MEMCACHED_CONTINUUM_ADDITION" title="Permalink to this definition">¶</a></dt>
 <dd><p>How many extra slots we should build for in the continuum, defaults to 10.</p>
 </dd></dl>
 
+<dl class="macro">
+<dt id="c.MEMCACHED_EXPIRATION_NOT_ADD">
+<code class="descname">MEMCACHED_EXPIRATION_NOT_ADD</code><a class="headerlink" href="#c.MEMCACHED_EXPIRATION_NOT_ADD" title="Permalink to this definition">¶</a></dt>
+<dd><p>Value <code class="docutils literal notranslate"><span class="pre">0xffffffffU</span></code></p>
+</dd></dl>
+
 <dl class="macro">
 <dt id="c.MEMCACHED_STRIDE">
-<code class="sig-name descname">MEMCACHED_STRIDE</code><a class="headerlink" href="#c.MEMCACHED_STRIDE" title="Permalink to this definition">¶</a></dt>
-<dd><p>This is the “stride” used in the consistent hash used between replicas.</p>
+<code class="descname">MEMCACHED_STRIDE</code><a class="headerlink" href="#c.MEMCACHED_STRIDE" title="Permalink to this definition">¶</a></dt>
+<dd><p>This is the &quot;stride&quot; used in the consistent hash used between replicas.</p>
 </dd></dl>
 
 <dl class="macro">
 <dt id="c.MEMCACHED_SERVER_FAILURE_LIMIT">
-<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>
+<code class="descname">MEMCACHED_SERVER_FAILURE_LIMIT</code><a class="headerlink" href="#c.MEMCACHED_SERVER_FAILURE_LIMIT" title="Permalink to this definition">¶</a></dt>
 <dd><p>Value 5</p>
 </dd></dl>
 
 <dl class="macro">
 <dt id="c.MEMCACHED_SERVER_FAILURE_RETRY_TIMEOUT">
-<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>
+<code class="descname">MEMCACHED_SERVER_FAILURE_RETRY_TIMEOUT</code><a class="headerlink" href="#c.MEMCACHED_SERVER_FAILURE_RETRY_TIMEOUT" title="Permalink to this definition">¶</a></dt>
 <dd><p>Value 2</p>
 </dd></dl>
 
 <dl class="macro">
 <dt id="c.MEMCACHED_SERVER_FAILURE_DEAD_TIMEOUT">
-<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>
+<code class="descname">MEMCACHED_SERVER_FAILURE_DEAD_TIMEOUT</code><a class="headerlink" href="#c.MEMCACHED_SERVER_FAILURE_DEAD_TIMEOUT" title="Permalink to this definition">¶</a></dt>
 <dd><p>Value 0</p>
 </dd></dl>
 
 <dl class="macro">
 <dt id="c.MEMCACHED_VERSION_STRING_LENGTH">
-<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>
+<code class="descname">MEMCACHED_VERSION_STRING_LENGTH</code><a class="headerlink" href="#c.MEMCACHED_VERSION_STRING_LENGTH" title="Permalink to this definition">¶</a></dt>
 <dd><p>Value 24</p>
 </dd></dl>