update docs
[awesomized/libmemcached] / libmemcached / constants.html
index 929a3736fd6a06430664f172c657b391587b1f54..98cec63a948f2ff4bfdeaae8878529851f5cf7c4 100644 (file)
 <dt>#include &lt;libmemcached-1.0/memcached.h&gt;</dt><dd><p>Compile and link with -lmemcached</p>
 </dd>
 </dl>
-<dl class="macro">
+<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="sig-name descname">LIBMEMCACHED_VERSION_STRING</code><a class="headerlink" href="#c.LIBMEMCACHED_VERSION_STRING" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>String value of libmemcached version such as &quot;1.0.99&quot;</p>
 </dd></dl>
 
-<dl class="macro">
+<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
+<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>
+<dd><p>Hex value of the version number. &quot;0x00048000&quot; This can be used for comparing
 versions based on number.</p>
 </dd></dl>
 
-<dl class="macro">
+<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="sig-name descname">MEMCACHED_DEFAULT_PORT</code><a class="headerlink" href="#c.MEMCACHED_DEFAULT_PORT" title="Permalink to this definition">¶</a><br /></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">
+<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="sig-name descname">MEMCACHED_DEFAULT_TIMEOUT</code><a class="headerlink" href="#c.MEMCACHED_DEFAULT_TIMEOUT" title="Permalink to this definition">¶</a><br /></dt>
 <dd><p>Default timeout of 5000 milliseconds.</p>
 </dd></dl>
 
-<dl class="macro">
+<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="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>
 <dd><p>Default connect timeout of 4000 milliseconds.</p>
 </dd></dl>
 
-<dl class="macro">
+<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="sig-name descname">MEMCACHED_MAX_BUFFER</code><a class="headerlink" href="#c.MEMCACHED_MAX_BUFFER" title="Permalink to this definition">¶</a><br /></dt>
 <dd><p>Default size of read/write buffers (which includes the null pointer).</p>
 </dd></dl>
 
-<dl class="macro">
+<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="sig-name descname">MEMCACHED_MAX_KEY</code><a class="headerlink" href="#c.MEMCACHED_MAX_KEY" title="Permalink to this definition">¶</a><br /></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">
+<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="sig-name descname">MEMCACHED_MAX_NAMESPACE</code><a class="headerlink" href="#c.MEMCACHED_MAX_NAMESPACE" title="Permalink to this definition">¶</a><br /></dt>
 <dd><p>Maximum length allowed for namespacing of a key. Defaults to 128.</p>
 </dd></dl>
 
-<dl class="macro">
+<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="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>
 <dd><p>Maximum allowed length of the hostname.</p>
 </dd></dl>
 
-<dl class="macro">
+<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="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>
 <dd><p>Length of the host string used for sorting. Used for Ketama.</p>
 </dd></dl>
 
-<dl class="macro">
+<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="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>
 <dd><p>Maximum display width of an integer represented as string.</p>
 </dd></dl>
 
-<dl class="macro">
+<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="sig-name descname">MEMCACHED_CONTINUUM_ADDITION</code><a class="headerlink" href="#c.MEMCACHED_CONTINUUM_ADDITION" title="Permalink to this definition">¶</a><br /></dt>
 <dd><p>How many extra slots we should build for in the continuum, defaults to 10.</p>
 </dd></dl>
 
-<dl class="macro">
+<dl class="c macro">
+<dt id="c.MEMCACHED_EXPIRATION_NOT_ADD">
+<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>
+<dd><p>Value <code class="docutils literal notranslate"><span class="pre">0xffffffffU</span></code></p>
+</dd></dl>
+
+<dl class="c 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="sig-name descname">MEMCACHED_STRIDE</code><a class="headerlink" href="#c.MEMCACHED_STRIDE" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>This is the &quot;stride&quot; used in the consistent hash used between replicas.</p>
 </dd></dl>
 
-<dl class="macro">
+<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="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>
 <dd><p>Value 5</p>
 </dd></dl>
 
-<dl class="macro">
+<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="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>
 <dd><p>Value 2</p>
 </dd></dl>
 
-<dl class="macro">
+<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="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>
 <dd><p>Value 0</p>
 </dd></dl>
 
-<dl class="macro">
+<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="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>
 <dd><p>Value 24</p>
 </dd></dl>