<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>libmemcached Configuration — libmemcached 1.0.99 documentation</title>
+ <title>libmemcached Configuration — 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>
<link rel="search" title="Search" href="../search.html" />
<link rel="copyright" title="Copyright" href="../copyright.html" />
<link rel="next" title="libmemcached Constants and Defaults" href="constants.html" />
- <link rel="prev" title="Misc" href="index_misc.html" />
+ <link rel="prev" title="Miscellaneous" href="index_misc.html" />
</head>
<body class="wy-body-for-nav">
<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 current"><a class="current reference internal" href="#">Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="constants.html">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> »</li>
- <li><a href="index_misc.html">Misc</a> »</li>
+ <li><a href="index_misc.html">Miscellaneous</a> »</li>
<li>libmemcached Configuration</li>
<li class="wy-breadcrumbs-aside">
+
+ <a href="https://github.com/m6w6/libmemcached/blob/v1.x/docs/source/libmemcached/configuration.rst" class="fa fa-github"> Edit on GitHub</a>
+
+
</li>
<h1>libmemcached Configuration<a class="headerlink" href="#libmemcached-configuration" 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 <libmemcached-1.0/memcached.h></dt><dd><p>Compile and link with -lmemcached</p>
-</dd>
+<dl class="docutils">
+<dt>#include <libmemcached-1/memcached.h></dt>
+<dd>Compile and link with -lmemcached</dd>
</dl>
-<dl class="cpp function">
+<dl class="function">
<dt id="_CPPv49memcachedPKc6size_t">
-<span id="_CPPv39memcachedPKc6size_t"></span><span id="_CPPv29memcachedPKc6size_t"></span><span id="memcached__cCP.s"></span><a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<code class="sig-name descname">memcached</code><span class="sig-paren">(</span><em class="property">const</em> char *<em>string</em>, size_t <em>string_length</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv49memcachedPKc6size_t" title="Permalink to this definition">¶</a><br /></dt>
-<dd></dd></dl>
+<span id="_CPPv39memcachedPKc6size_t"></span><span id="_CPPv29memcachedPKc6size_t"></span><span id="memcached__cCP.s"></span><a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<code class="descname">memcached</code><span class="sig-paren">(</span><em class="property">const</em> char *<em>string</em>, size_t <em>string_length</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv49memcachedPKc6size_t" title="Permalink to this definition">¶</a><br /></dt>
+<dd><table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>string</strong> -- configuration string</li>
+<li><strong>string_length</strong> -- length of the configuration string without any terminating zero</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">allocated and initialized <a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_st</span></code></a> struct</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
-<dl class="cpp function">
+<dl class="function">
<dt id="_CPPv432libmemcached_check_configurationPKc6size_tPc6size_t">
-<span id="_CPPv332libmemcached_check_configurationPKc6size_tPc6size_t"></span><span id="_CPPv232libmemcached_check_configurationPKc6size_tPc6size_t"></span><span id="libmemcached_check_configuration__cCP.s.cP.s"></span><a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> <code class="sig-name descname">libmemcached_check_configuration</code><span class="sig-paren">(</span><em class="property">const</em> 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="#_CPPv432libmemcached_check_configurationPKc6size_tPc6size_t" title="Permalink to this definition">¶</a><br /></dt>
-<dd></dd></dl>
+<span id="_CPPv332libmemcached_check_configurationPKc6size_tPc6size_t"></span><span id="_CPPv232libmemcached_check_configurationPKc6size_tPc6size_t"></span><span id="libmemcached_check_configuration__cCP.s.cP.s"></span><a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> <code class="descname">libmemcached_check_configuration</code><span class="sig-paren">(</span><em class="property">const</em> 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="#_CPPv432libmemcached_check_configurationPKc6size_tPc6size_t" title="Permalink to this definition">¶</a><br /></dt>
+<dd><table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>option_string</strong> -- configuration string</li>
+<li><strong>length</strong> -- length of the configuration string without any terminating zero</li>
+<li><strong>error_buffer</strong> -- buffer used to store any error message</li>
+<li><strong>error_buffer_size</strong> -- available size of the <a class="reference internal" href="#_CPPv432libmemcached_check_configurationPKc6size_tPc6size_t" title="libmemcached_check_configuration::error_buffer"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">error_buffer</span></code></a></li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_return_t</span></code></a> indicating success</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
</div>
<div class="section" id="description">
<h3>General Options:<a class="headerlink" href="#general-options" title="Permalink to this headline">¶</a></h3>
<dl class="describe">
<dt>
-<code class="sig-name descname">--SERVER=<servername>:<optional_port>/?<optional_weight></code></dt>
+<code class="descname">--SERVER=<servername>:<optional_port>/?<optional_weight></code></dt>
<dd><p>Provide a servername to be used by the client.</p>
<p>Providing a weight will cause weighting to occur with all hosts with each
server getting a default weight of 1.</p>
<dl class="describe">
<dt>
-<code class="sig-name descname">--SOCKET=\"<filepath>/?<optional_weight>\"</code></dt>
+<code class="descname">--SOCKET="<filepath>/?<optional_weight>"</code></dt>
<dd><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>
<dl class="describe">
<dt>
-<code class="sig-name descname">--VERIFY-KEY</code></dt>
+<code class="descname">--VERIFY-KEY</code></dt>
<dd><p>Verify that keys that are being used fit within the design of the protocol
being used.</p>
</dd></dl>
<dl class="describe">
<dt>
-<code class="sig-name descname">--REMOVE_FAILED_SERVERS</code></dt>
-<dd><p>Enable the behavior <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS</span></code>.</p>
+<code class="descname">--REMOVE_FAILED_SERVERS</code></dt>
+<dd><p>Enable the behavior <a class="reference internal" href="memcached_behavior.html#_CPPv4N20memcached_behavior_t40MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERSE" title="MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS</span></code></a>.</p>
</dd></dl>
<dl class="describe">
<dt>
-<code class="sig-name descname">--BINARY-PROTOCOL</code></dt>
+<code class="descname">--BINARY-PROTOCOL</code></dt>
<dd><p>Force all connections to use the binary protocol.</p>
</dd></dl>
<dl class="describe">
<dt>
-<code class="sig-name descname">--BUFFER-REQUESTS</code></dt>
-<dd><p>Please see <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_BEHAVIOR_BUFFER_REQUESTS</span></code>.</p>
+<code class="descname">--BUFFER-REQUESTS</code></dt>
+<dd><p>Please see <a class="reference internal" href="memcached_behavior.html#_CPPv4N20memcached_behavior_t34MEMCACHED_BEHAVIOR_BUFFER_REQUESTSE" title="MEMCACHED_BEHAVIOR_BUFFER_REQUESTS"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_BEHAVIOR_BUFFER_REQUESTS</span></code></a>.</p>
</dd></dl>
<dl class="describe">
<dt>
-<code class="sig-name descname">--CONFIGURE-FILE=</code></dt>
+<code class="descname">--CONFIGURE-FILE=</code></dt>
<dd><p>Provide a configuration file to be used to load requests. Beware that by
using a configuration file <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">libmemcached</span></code> will reset <a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_st</span></code></a> based
on information only contained in the file.</p>
<dl class="describe">
<dt>
-<code class="sig-name descname">--CONNECT-TIMEOUT=</code></dt>
-<dd><p>See <a class="reference internal" href="memcached_behavior.html#_CPPv422memcached_behavior_setP12memcached_st20memcached_behavior_t8uint64_t" title="memcached_behavior_set"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_behavior_set()</span></code></a> for <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT</span></code>.</p>
+<code class="descname">--CONNECT-TIMEOUT=</code></dt>
+<dd><p>See <a class="reference internal" href="memcached_behavior.html#_CPPv422memcached_behavior_setP12memcached_st20memcached_behavior_t8uint64_t" title="memcached_behavior_set"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_behavior_set()</span></code></a> for <a class="reference internal" href="memcached_behavior.html#_CPPv4N20memcached_behavior_t34MEMCACHED_BEHAVIOR_CONNECT_TIMEOUTE" title="MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT</span></code></a>.</p>
</dd></dl>
<dl class="describe">
<dt>
-<code class="sig-name descname">--DISTRIBUTION=</code></dt>
+<code class="descname">--DISTRIBUTION=</code></dt>
<dd><p>Set the distribution model used by the client.
See <a class="reference internal" href="memcached_behavior.html#_CPPv422memcached_behavior_setP12memcached_st20memcached_behavior_t8uint64_t" title="memcached_behavior_set"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_behavior_set()</span></code></a> for more details.</p>
</dd></dl>
<dl class="describe">
<dt>
-<code class="sig-name descname">--HASH=</code></dt>
+<code class="descname">--HASH=</code></dt>
<dd><p>Set the hashing algorithm used for placing keys on servers.</p>
</dd></dl>
<dl class="describe">
<dt>
-<code class="sig-name descname">--HASH-WITH-NAMESPACE</code></dt>
+<code class="descname">--HASH-WITH-NAMESPACE</code></dt>
<dd><p>When enabled the prefix key will be added to the key when determining which
server to store the data in.</p>
</dd></dl>
<dl class="describe">
<dt>
-<code class="sig-name descname">--NOREPLY</code></dt>
+<code class="descname">--NOREPLY</code></dt>
<dd><p>Enable "no reply" for all calls that support this. It is highly recommended
that you use this option with the binary protocol only.</p>
</dd></dl>
<dl class="describe">
<dt>
-<code class="sig-name descname">--NUMBER-OF-REPLICAS=</code></dt>
+<code class="descname">--NUMBER-OF-REPLICAS=</code></dt>
<dd><p>Set the number of servers that keys will be replicated to.</p>
</dd></dl>
<dl class="describe">
<dt>
-<code class="sig-name descname">--RANDOMIZE-REPLICA-READ</code></dt>
+<code class="descname">--RANDOMIZE-REPLICA-READ</code></dt>
<dd><p>Select randomly the server within the replication pool to read from.</p>
</dd></dl>
<dl class="describe">
<dt>
-<code class="sig-name descname">--SORT-HOSTS</code></dt>
+<code class="descname">--SORT-HOSTS</code></dt>
<dd><p>When adding new servers always calculate their distribution based on sorted
naming order.</p>
</dd></dl>
<dl class="describe">
<dt>
-<code class="sig-name descname">--SUPPORT-CAS</code></dt>
-<dd><p>See <a class="reference internal" href="memcached_behavior.html#_CPPv422memcached_behavior_setP12memcached_st20memcached_behavior_t8uint64_t" title="memcached_behavior_set"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_behavior_set()</span></code></a> for <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_BEHAVIOR_SUPPORT_CAS</span></code></p>
+<code class="descname">--SUPPORT-CAS</code></dt>
+<dd><p>See <a class="reference internal" href="memcached_behavior.html#_CPPv422memcached_behavior_setP12memcached_st20memcached_behavior_t8uint64_t" title="memcached_behavior_set"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_behavior_set()</span></code></a> for <a class="reference internal" href="memcached_behavior.html#_CPPv4N20memcached_behavior_t30MEMCACHED_BEHAVIOR_SUPPORT_CASE" title="MEMCACHED_BEHAVIOR_SUPPORT_CAS"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_BEHAVIOR_SUPPORT_CAS</span></code></a></p>
</dd></dl>
<dl class="describe">
<dt>
-<code class="sig-name descname">--USE-UDP</code></dt>
-<dd><p>See <a class="reference internal" href="memcached_behavior.html#_CPPv422memcached_behavior_setP12memcached_st20memcached_behavior_t8uint64_t" title="memcached_behavior_set"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_behavior_set()</span></code></a> for <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_BEHAVIOR_USE_UDP</span></code></p>
+<code class="descname">--USE-UDP</code></dt>
+<dd><p>See <a class="reference internal" href="memcached_behavior.html#_CPPv422memcached_behavior_setP12memcached_st20memcached_behavior_t8uint64_t" title="memcached_behavior_set"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_behavior_set()</span></code></a> for <a class="reference internal" href="memcached_behavior.html#_CPPv4N20memcached_behavior_t26MEMCACHED_BEHAVIOR_USE_UDPE" title="MEMCACHED_BEHAVIOR_USE_UDP"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_BEHAVIOR_USE_UDP</span></code></a></p>
</dd></dl>
<dl class="describe">
<dt>
-<code class="sig-name descname">--NAMESPACE=</code></dt>
+<code class="descname">--NAMESPACE=</code></dt>
<dd><p>A namespace is a container that provides context for keys, only other
requests that know the namespace can access these values. This is
accomplished by prepending the namespace value to all keys.</p>
<h3>Memcached Pool Options:<a class="headerlink" href="#memcached-pool-options" title="Permalink to this headline">¶</a></h3>
<dl class="describe">
<dt>
-<code class="sig-name descname">--POOL-MIN</code></dt>
+<code class="descname">--POOL-MIN</code></dt>
<dd><p>Initial size of pool.</p>
</dd></dl>
<dl class="describe">
<dt>
-<code class="sig-name descname">--POOL-MAX</code></dt>
+<code class="descname">--POOL-MAX</code></dt>
<dd><p>Maximize size of the pool.</p>
</dd></dl>
<h3>I/O Options:<a class="headerlink" href="#i-o-options" title="Permalink to this headline">¶</a></h3>
<dl class="describe">
<dt>
-<code class="sig-name descname">--TCP-NODELAY</code></dt>
-<dd><p>See <a class="reference internal" href="memcached_behavior.html#_CPPv422memcached_behavior_setP12memcached_st20memcached_behavior_t8uint64_t" title="memcached_behavior_set"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_behavior_set()</span></code></a> for <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_BEHAVIOR_TCP_NODELAY</span></code></p>
+<code class="descname">--TCP-NODELAY</code></dt>
+<dd><p>See <a class="reference internal" href="memcached_behavior.html#_CPPv422memcached_behavior_setP12memcached_st20memcached_behavior_t8uint64_t" title="memcached_behavior_set"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_behavior_set()</span></code></a> for <a class="reference internal" href="memcached_behavior.html#_CPPv4N20memcached_behavior_t30MEMCACHED_BEHAVIOR_TCP_NODELAYE" title="MEMCACHED_BEHAVIOR_TCP_NODELAY"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_BEHAVIOR_TCP_NODELAY</span></code></a></p>
</dd></dl>
<dl class="describe">
<dt>
-<code class="sig-name descname">--TCP-KEEPALIVE</code></dt>
+<code class="descname">--TCP-KEEPALIVE</code></dt>
<dd><p>See <a class="reference internal" href="memcached_behavior.html#_CPPv422memcached_behavior_setP12memcached_st20memcached_behavior_t8uint64_t" title="memcached_behavior_set"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_behavior_set()</span></code></a> for <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_BEHAVIOR_TCP_KEEPALIVE</span></code></p>
</dd></dl>
<dl class="describe">
<dt>
-<code class="sig-name descname">--RETRY-TIMEOUT=</code></dt>
-<dd><p>See <a class="reference internal" href="memcached_behavior.html#_CPPv422memcached_behavior_setP12memcached_st20memcached_behavior_t8uint64_t" title="memcached_behavior_set"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_behavior_set()</span></code></a> for <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_BEHAVIOR_RETRY_TIMEOUT</span></code></p>
+<code class="descname">--RETRY-TIMEOUT=</code></dt>
+<dd><p>See <a class="reference internal" href="memcached_behavior.html#_CPPv422memcached_behavior_setP12memcached_st20memcached_behavior_t8uint64_t" title="memcached_behavior_set"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_behavior_set()</span></code></a> for <a class="reference internal" href="memcached_behavior.html#_CPPv4N20memcached_behavior_t32MEMCACHED_BEHAVIOR_RETRY_TIMEOUTE" title="MEMCACHED_BEHAVIOR_RETRY_TIMEOUT"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_BEHAVIOR_RETRY_TIMEOUT</span></code></a></p>
</dd></dl>
<dl class="describe">
<dt>
-<code class="sig-name descname">--SERVER-FAILURE-LIMIT=</code></dt>
-<dd><p>See <a class="reference internal" href="memcached_behavior.html#_CPPv422memcached_behavior_setP12memcached_st20memcached_behavior_t8uint64_t" title="memcached_behavior_set"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_behavior_set()</span></code></a> for <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT</span></code></p>
+<code class="descname">--SERVER-FAILURE-LIMIT=</code></dt>
+<dd><p>See <a class="reference internal" href="memcached_behavior.html#_CPPv422memcached_behavior_setP12memcached_st20memcached_behavior_t8uint64_t" title="memcached_behavior_set"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_behavior_set()</span></code></a> for <a class="reference internal" href="memcached_behavior.html#_CPPv4N20memcached_behavior_t39MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMITE" title="MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT</span></code></a></p>
</dd></dl>
<dl class="describe">
<dt>
-<code class="sig-name descname">--SND-TIMEOUT=</code></dt>
-<dd><p>See <a class="reference internal" href="memcached_behavior.html#_CPPv422memcached_behavior_setP12memcached_st20memcached_behavior_t8uint64_t" title="memcached_behavior_set"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_behavior_set()</span></code></a> for <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_BEHAVIOR_SND_TIMEOUT</span></code></p>
+<code class="descname">--SND-TIMEOUT=</code></dt>
+<dd><p>See <a class="reference internal" href="memcached_behavior.html#_CPPv422memcached_behavior_setP12memcached_st20memcached_behavior_t8uint64_t" title="memcached_behavior_set"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_behavior_set()</span></code></a> for <a class="reference internal" href="memcached_behavior.html#_CPPv4N20memcached_behavior_t30MEMCACHED_BEHAVIOR_SND_TIMEOUTE" title="MEMCACHED_BEHAVIOR_SND_TIMEOUT"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_BEHAVIOR_SND_TIMEOUT</span></code></a></p>
</dd></dl>
<dl class="describe">
<dt>
-<code class="sig-name descname">--SOCKET-RECV-SIZE=</code></dt>
-<dd><p>See <a class="reference internal" href="memcached_behavior.html#_CPPv422memcached_behavior_setP12memcached_st20memcached_behavior_t8uint64_t" title="memcached_behavior_set"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_behavior_set()</span></code></a> for <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE</span></code></p>
+<code class="descname">--SOCKET-RECV-SIZE=</code></dt>
+<dd><p>See <a class="reference internal" href="memcached_behavior.html#_CPPv422memcached_behavior_setP12memcached_st20memcached_behavior_t8uint64_t" title="memcached_behavior_set"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_behavior_set()</span></code></a> for <a class="reference internal" href="memcached_behavior.html#_CPPv4N20memcached_behavior_t35MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZEE" title="MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE</span></code></a></p>
</dd></dl>
<dl class="describe">
<dt>
-<code class="sig-name descname">--SOCKET-SEND-SIZE=</code></dt>
-<dd><p>See <a class="reference internal" href="memcached_behavior.html#_CPPv422memcached_behavior_setP12memcached_st20memcached_behavior_t8uint64_t" title="memcached_behavior_set"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_behavior_set()</span></code></a> for <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE</span></code></p>
+<code class="descname">--SOCKET-SEND-SIZE=</code></dt>
+<dd><p>See <a class="reference internal" href="memcached_behavior.html#_CPPv422memcached_behavior_setP12memcached_st20memcached_behavior_t8uint64_t" title="memcached_behavior_set"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_behavior_set()</span></code></a> for <a class="reference internal" href="memcached_behavior.html#_CPPv4N20memcached_behavior_t35MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZEE" title="MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE</span></code></a></p>
</dd></dl>
<dl class="describe">
<dt>
-<code class="sig-name descname">--POLL-TIMEOUT=</code></dt>
+<code class="descname">--POLL-TIMEOUT=</code></dt>
<dd><p>Set the timeout used by <em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/3/poll">poll(3)</a></em>.</p>
</dd></dl>
<dl class="describe">
<dt>
-<code class="sig-name descname">--IO-BYTES-WATERMARK=</code></dt>
+<code class="descname">--IO-BYTES-WATERMARK=</code></dt>
<dd></dd></dl>
<dl class="describe">
<dt>
-<code class="sig-name descname">--IO-KEY-PREFETCH=</code></dt>
+<code class="descname">--IO-KEY-PREFETCH=</code></dt>
<dd></dd></dl>
<dl class="describe">
<dt>
-<code class="sig-name descname">--IO-MSG-WATERMARK=</code></dt>
+<code class="descname">--IO-MSG-WATERMARK=</code></dt>
<dd></dd></dl>
<dl class="describe">
<dt>
-<code class="sig-name descname">--TCP-KEEPIDLE</code></dt>
+<code class="descname">--TCP-KEEPIDLE</code></dt>
<dd></dd></dl>
<dl class="describe">
<dt>
-<code class="sig-name descname">--RCV-TIMEOUT=</code></dt>
+<code class="descname">--RCV-TIMEOUT=</code></dt>
<dd></dd></dl>
</div>
<h3>Other Options:<a class="headerlink" href="#other-options" title="Permalink to this headline">¶</a></h3>
<dl class="describe">
<dt>
-<code class="sig-name descname">INCLUDE</code></dt>
+<code class="descname">INCLUDE</code></dt>
<dd><p>Include a file in configuration.
Unlike <code class="docutils literal notranslate"><span class="pre">--CONFIGURE-FILE=</span></code> this will not reset <a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_st</span></code></a>.</p>
</dd></dl>
<dl class="describe">
<dt>
-<code class="sig-name descname">RESET</code></dt>
+<code class="descname">RESET</code></dt>
<dd><p>Reset <a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_st</span></code></a> and continue to process.</p>
</dd></dl>
<dl class="describe">
<dt>
-<code class="sig-name descname">END</code></dt>
+<code class="descname">END</code></dt>
<dd><p>End configuration processing.</p>
</dd></dl>
<dl class="describe">
<dt>
-<code class="sig-name descname">ERROR</code></dt>
+<code class="descname">ERROR</code></dt>
<dd><p>End configuration processing and throw an error.</p>
</dd></dl>
</div>
<div class="section" id="environment">
<h2>ENVIRONMENT<a class="headerlink" href="#environment" title="Permalink to this headline">¶</a></h2>
-<dl class="std envvar">
+<dl class="envvar">
<dt id="envvar-LIBMEMCACHED">
-<code class="
sig-name descname">LIBMEMCACHED</code><a class="headerlink" href="#envvar-LIBMEMCACHED" title="Permalink to this definition">¶</a></dt>
+<code class="descname">LIBMEMCACHED</code><a class="headerlink" href="#envvar-LIBMEMCACHED" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</div>
<div class="section" id="return-value">
<h2>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
-<p><a class="reference internal" href="#_CPPv49memcachedPKc6size_t" title="memcached"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached()</span></code></a> returns a pointer to the memcached_st that was created (or
+<p><a class="reference internal" href="#_CPPv49memcachedPKc6size_t" title="memcached"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached()</span></code></a> returns a pointer to the <a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_st</span></code></a> that was created (or
initialized). On an allocation failure, it returns NULL.</p>
</div>
<div class="section" id="example">
<div class="section" id="see-also">
<h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
-<li><p><em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/1/memcached">memcached(1)</a></em></p></li>
-<li><p><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></p></li>
-<li><p><a class="reference internal" href="memcached_strerror.html"><span class="doc">Converting Error Codes to Messages</span></a></p></li>
+<li><em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/1/memcached">memcached(1)</a></em></li>
+<li><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></li>
+<li><a class="reference internal" href="memcached_strerror.html"><span class="doc">Converting Error Codes to Messages</span></a></li>
</ul>
</div>
</div>
<a href="constants.html" class="btn btn-neutral float-right" title="libmemcached Constants and Defaults" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="index_misc.html" class="btn btn-neutral float-left" title="Misc" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="index_misc.html" class="btn btn-neutral float-left" title="Miscellaneous" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
projects / awesomized / libmemcached / blobdiff