<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Managing lists of servers — libmemcached 1.0.99 documentation</title>
+ <title>Managing lists of servers — libmemcached-awesome 1.1.4 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="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="copyright" title="Copyright" href="../copyright.html" />
- <link rel="next" title="Manipulate the server information stored in memcached_st" href="memcached_servers.html" />
+ <link rel="next" title="Managing the servers used by memcached_st" href="memcached_servers.html" />
<link rel="prev" title="Servers and Server Lists" href="index_advanced_servers.html" />
</head>
- <a href="../index.html" class="icon icon-home"> libmemcached
+ <a href="../index.html" class="icon icon-home"> libmemcached-awesome
<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 current"><a class="reference internal" href="index.html">libmemcached API</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="index_basics.html">Basics</a></li>
<li class="toctree-l2"><a class="reference internal" href="index_data.html">Working with Data</a></li>
<li class="toctree-l2"><a class="reference internal" href="index_errors.html">Messages and Errors</a></li>
-<li class="toctree-l2 current"><a class="reference internal" href="index_advanced.html">Advanced Topics</a></li>
-<li class="toctree-l2"><a class="reference internal" href="index_deprecated.html">Deprecated Functionality</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="index_misc.html">Misc</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="configuration.html">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>
-<li class="toctree-l2"><a class="reference internal" href="versioning.html">Versioning</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index_advanced.html">Advanced Topics</a><ul class="current">
+<li class="toctree-l3"><a class="reference internal" href="index_advanced_internals.html">Internal Behavior</a></li>
+<li class="toctree-l3"><a class="reference internal" href="index_advanced_aeh.html">Authentication, Encryption & Hashing</a></li>
+<li class="toctree-l3 current"><a class="reference internal" href="index_advanced_servers.html">Servers and Server Lists</a><ul class="current">
+<li class="toctree-l4 current"><a class="current reference internal" href="#">Managing lists of servers</a></li>
+<li class="toctree-l4"><a class="reference internal" href="memcached_servers.html">Managing the servers used by memcached_st</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><ul>
-<li class="toctree-l2"><a class="reference internal" href="../libmemcachedutil/memcached_pool.html">Working with memcached pools</a></li>
+<li class="toctree-l3"><a class="reference internal" href="index_advanced_daemon.html">Affecting the memcached Daemon</a></li>
+<li class="toctree-l3"><a class="reference internal" href="index_advanced_stats.html">Statistics</a></li>
</ul>
</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><ul>
-<li class="toctree-l2"><a class="reference internal" href="../libhashkit/hashkit_create.html">Creating a hashkit structure</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../libhashkit/hashkit_function.html">Set Hash Function</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../libhashkit/hashkit_functions.html">Available Hashes</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../libhashkit/hashkit_value.html">Generate hash value</a></li>
+<li class="toctree-l2"><a class="reference internal" href="index_deprecated.html">Deprecated Functionality</a></li>
</ul>
</li>
+<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"><a class="reference internal" href="index_misc.html">Miscellaneous</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><ul>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memcapable.html">memcapable - Checking a Memcached server capabilities and compatibility</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memcat.html">memcat - “cat” data from a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memcp.html">memcp - Copy data to a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memdump.html">memdump - Dumping your server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memerror.html">memerror - translate an error code to a string</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memflush.html">memflush - flush all data from a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memrm.html">memrm - Remove data from a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memslap.html">memslap - Load testing and benchmarking a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memaslap.html">memaslap - Load testing and benchmarking a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memstat.html">memstat - Gather statistics from a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memexist.html">memexist - Check for the existence of a key</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memparse.html">memparse - Parse an option string</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memping.html">memping - Test to see if a server is available.</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memtouch.html">memtouch - Touches a key.</a></li>
-</ul>
-</li>
+<li class="toctree-l1"><a class="reference internal" href="../changelogs.html">Change Logs</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../issues.html">Known issues</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
</ul>
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
- <a href="../index.html">libmemcached</a>
+ <a href="../index.html">libmemcached-awesome</a>
</nav>
<li class="wy-breadcrumbs-aside">
+
+ <a href="https://github.com/awesomized/libmemcached/blob/v1.x/docs/source/libmemcached/memcached_server_st.rst" class="fa fa-github"> Edit on GitHub</a>
+
+
</li>
<h1>Managing lists of servers<a class="headerlink" href="#managing-lists-of-servers" 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/memcached.h></dt><dd><p>Compile and link with -lmemcached</p>
-</dd>
+<dl class="docutils">
+<dt>#include <libmemcached/memcached.h></dt>
+<dd>Compile and link with -lmemcached</dd>
</dl>
<dl class="type">
<dt id="c.memcached_instance_st">
-struct <a class="reference internal" href="#c.memcached_instance_st" title="memcached_instance_st">memcached_instance_st</a> <code class="sig-name descname">memcached_instance_st</code><a class="headerlink" href="#c.memcached_instance_st" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="type">
-<dt id="c.memcached_server_list_st">
-struct <a class="reference internal" href="#c.memcached_server_list_st" title="memcached_server_list_st">memcached_server_list_st</a> <code class="sig-name descname">memcached_server_list_st</code><a class="headerlink" href="#c.memcached_server_list_st" title="Permalink to this definition">¶</a></dt>
+struct <a class="reference internal" href="#c.memcached_instance_st" title="memcached_instance_st">memcached_instance_st</a> <code class="descname">memcached_instance_st</code><a class="headerlink" href="#c.memcached_instance_st" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="type">
<dt id="c.memcached_server_st">
-struct <a class="reference internal" href="#c.memcached_server_st" title="memcached_server_st">memcached_server_st</a> <code class="
sig-name descname">memcached_server_st</code><a class="headerlink" href="#c.memcached_server_st" title="Permalink to this definition">¶</a></dt>
+struct <a class="reference internal" href="#c.memcached_server_st" title="memcached_server_st">memcached_server_st</a> <code class="descname">memcached_server_st</code><a class="headerlink" href="#c.memcached_server_st" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
-<dl class="function">
-<dt id="_CPPv421memcached_server_listP12memcached_st">
-<span id="_CPPv321memcached_server_listP12memcached_st"></span><span id="_CPPv221memcached_server_listP12memcached_st"></span><span id="memcached_server_list__memcached_stP"></span><em class="property">const</em> memcached_instance_st *<code class="sig-name descname">memcached_server_list</code><span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<em>ptr</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv421memcached_server_listP12memcached_st" title="Permalink to this definition">¶</a><br /></dt>
+<dl class="type">
+<dt id="c.memcached_server_list_st">
+struct <a class="reference internal" href="#c.memcached_server_st" title="memcached_server_st">memcached_server_st</a> *<code class="descname">memcached_server_list_st</code><a class="headerlink" href="#c.memcached_server_list_st" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="_CPPv426memcached_server_list_free24memcached_server_list_st">
-<span id="_CPPv326memcached_server_list_free24memcached_server_list_st"></span><span id="_CPPv226memcached_server_list_free24memcached_server_list_st"></span><span id="memcached_server_list_free__memcached_server_list_st"></span>void <code class="sig-name descname">memcached_server_list_free</code><span class="sig-paren">(</span>memcached_server_list_st <em>list</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv426memcached_server_list_free24memcached_server_list_st" title="Permalink to this definition">¶</a><br /></dt>
-<dd></dd></dl>
+<span id="_CPPv326memcached_server_list_free24memcached_server_list_st"></span><span id="_CPPv226memcached_server_list_free24memcached_server_list_st"></span><span id="memcached_server_list_free__memcached_server_list_st"></span>void <code class="descname">memcached_server_list_free</code><span class="sig-paren">(</span>memcached_server_list_st <em>list</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv426memcached_server_list_free24memcached_server_list_st" 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"><strong>list</strong> -- instance of initialized <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_server_list_st</span></code> object</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
<dl class="function">
<dt id="_CPPv428memcached_server_list_append24memcached_server_list_stPKc9in_port_tP18memcached_return_t">
-<span id="_CPPv328memcached_server_list_append24memcached_server_list_stPKc9in_port_tP18memcached_return_t"></span><span id="_CPPv228memcached_server_list_append24memcached_server_list_stPKc9in_port_tP18memcached_return_t"></span><span id="memcached_server_list_append__memcached_server_list_st.cCP.in_port_t.memcached_return_tP"></span>memcached_server_list_st <code class="sig-name descname">memcached_server_list_append</code><span class="sig-paren">(</span>memcached_server_list_st <em>list</em>, <em class="property">const</em> char *<em>hostname</em>, in_port_t <em>port</em>, <a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> *<em>error</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv428memcached_server_list_append24memcached_server_list_stPKc9in_port_tP18memcached_return_t" title="Permalink to this definition">¶</a><br /></dt>
-<dd></dd></dl>
+<span id="_CPPv328memcached_server_list_append24memcached_server_list_stPKc9in_port_tP18memcached_return_t"></span><span id="_CPPv228memcached_server_list_append24memcached_server_list_stPKc9in_port_tP18memcached_return_t"></span><span id="memcached_server_list_append__memcached_server_list_st.cCP.in_port_t.memcached_return_tP"></span>memcached_server_list_st <code class="descname">memcached_server_list_append</code><span class="sig-paren">(</span>memcached_server_list_st <em>list</em>, <em class="property">const</em> char *<em>hostname</em>, in_port_t <em>port</em>, <a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> *<em>error</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv428memcached_server_list_append24memcached_server_list_stPKc9in_port_tP18memcached_return_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>list</strong> -- instance of an existing <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_server_list_st</span></code> or nullptr to create one</li>
+<li><strong>hostname</strong> -- the hostname or path to the socket, defaults to localhost if null</li>
+<li><strong>port</strong> -- the port to use, defaults to 11211 if 0</li>
+<li><strong>error</strong> -- pointer to store any <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> error indicating success</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">new instance of <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_server_list_st</span></code> on success or nullptr on failure</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
<dl class="function">
<dt id="_CPPv427memcached_server_list_count24memcached_server_list_st">
-<span id="_CPPv327memcached_server_list_count24memcached_server_list_st"></span><span id="_CPPv227memcached_server_list_count24memcached_server_list_st"></span><span id="memcached_server_list_count__memcached_server_list_st"></span>uint32_t <code class="sig-name descname">memcached_server_list_count</code><span class="sig-paren">(</span>memcached_server_list_st <em>list</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv427memcached_server_list_count24memcached_server_list_st" title="Permalink to this definition">¶</a><br /></dt>
-<dd></dd></dl>
+<span id="_CPPv327memcached_server_list_count24memcached_server_list_st"></span><span id="_CPPv227memcached_server_list_count24memcached_server_list_st"></span><span id="memcached_server_list_count__memcached_server_list_st"></span>uint32_t <code class="descname">memcached_server_list_count</code><span class="sig-paren">(</span>memcached_server_list_st <em>list</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv427memcached_server_list_count24memcached_server_list_st" 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"><strong>list</strong> -- instance of <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_server_list_st</span></code></td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">count of servers in the list</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
<dl class="function">
<dt id="_CPPv422memcached_server_errorPK21memcached_instance_st">
-<span id="_CPPv322memcached_server_errorPK21memcached_instance_st"></span><span id="_CPPv222memcached_server_errorPK21memcached_instance_st"></span><span id="memcached_server_error__memcached_instance_stCP"></span><em class="property">const</em> char *<code class="sig-name descname">memcached_server_error</code><span class="sig-paren">(</span><em class="property">const</em> memcached_instance_st *<em>instance</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv422memcached_server_errorPK21memcached_instance_st" title="Permalink to this definition">¶</a><br /></dt>
-<dd></dd></dl>
+<span id="_CPPv322memcached_server_errorPK21memcached_instance_st"></span><span id="_CPPv222memcached_server_errorPK21memcached_instance_st"></span><span id="memcached_server_error__memcached_instance_stCP"></span><em class="property">const</em> char *<code class="descname">memcached_server_error</code><span class="sig-paren">(</span><em class="property">const</em> memcached_instance_st *<em>instance</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv422memcached_server_errorPK21memcached_instance_st" 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"><strong>instance</strong> -- pointer to an initialized <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_instance_st</span></code> object</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">last error message sent from the server to the client</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
<dl class="function">
<dt id="_CPPv428memcached_server_error_resetPK21memcached_instance_st">
-<span id="_CPPv328memcached_server_error_resetPK21memcached_instance_st"></span><span id="_CPPv228memcached_server_error_resetPK21memcached_instance_st"></span><span id="memcached_server_error_reset__memcached_instance_stCP"></span>void <code class="
sig-name descname">memcached_server_error_reset</code><span class="sig-paren">(</span><em class="property">const</em> memcached_instance_st *<em>list</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv428memcached_server_error_resetPK21memcached_instance_st" title="Permalink to this definition">¶</a><br /></dt>
+<span id="_CPPv328memcached_server_error_resetPK21memcached_instance_st"></span><span id="_CPPv228memcached_server_error_resetPK21memcached_instance_st"></span><span id="memcached_server_error_reset__memcached_instance_stCP"></span>void <code class="descname">memcached_server_error_reset</code><span class="sig-paren">(</span><em class="property">const</em> memcached_instance_st *<em>list</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv428memcached_server_error_resetPK21memcached_instance_st" title="Permalink to this definition">¶</a><br /></dt>
<dd><div class="deprecated">
-<p><span class="versionmodified deprecated">Deprecated since version 0.39.</span></p>
+<p><span class="versionmodified">Deprecated since version 0.39.</span></p>
</div>
</dd></dl>
<dl class="function">
<dt id="_CPPv423memcached_servers_parsev">
-<span id="_CPPv323memcached_servers_parsev"></span><span id="_CPPv223memcached_servers_parsev"></span><span id="memcached_servers_parse"></span>void <code class="
sig-name descname">memcached_servers_parse</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv423memcached_servers_parsev" title="Permalink to this definition">¶</a><br /></dt>
+<span id="_CPPv323memcached_servers_parsev"></span><span id="_CPPv223memcached_servers_parsev"></span><span id="memcached_servers_parse"></span>void <code class="descname">memcached_servers_parse</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv423memcached_servers_parsev" title="Permalink to this definition">¶</a><br /></dt>
<dd><div class="deprecated">
-<p><span class="versionmodified deprecated">Deprecated since version 0.39.</span></p>
+<p><span class="versionmodified">Deprecated since version 0.39.</span></p>
</div>
+<p>See <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>
</div>
<div class="section" id="description">
<h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
-<p>libmemcached(3) operates on a list of hosts which are stored in
+<p><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">libmemcached</span></code> operates on a list of hosts which are stored in
<code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_server_st</span></code> structures. You should not modify these structures
-directly. Functions are provided to modify these structures (and more can be
-added, just ask!).</p>
-<p><a class="reference internal" href="#_CPPv421memcached_server_listP12memcached_st" title="memcached_server_list"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_server_list()</span></code></a> is used to provide an array of all defined hosts. This was incorrectly documented as “requiring free” up till version 0.39.</p>
-<p><a class="reference internal" href="#_CPPv426memcached_server_list_free24memcached_server_list_st" title="memcached_server_list_free"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_server_list_free()</span></code></a> deallocates all memory associated with the array of <code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_server_st</span></code> that you passed to it.</p>
+directly. Functions are provided to modify these structures.</p>
+<p><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_server_list()</span></code> is used to provide an array of all defined hosts.
+This was incorrectly documented as "requiring free" up till version 0.39.</p>
+<p><a class="reference internal" href="#_CPPv426memcached_server_list_free24memcached_server_list_st" title="memcached_server_list_free"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_server_list_free()</span></code></a> deallocates all memory associated with the
+array of <code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_server_st</span></code> that you passed to it.</p>
<p><a class="reference internal" href="#_CPPv428memcached_server_list_append24memcached_server_list_stPKc9in_port_tP18memcached_return_t" title="memcached_server_list_append"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_server_list_append()</span></code></a> adds a server to the end of a
<code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_server_st</span></code> array. On error null will be returned and the
<a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_return_t</span></code></a> pointer you passed into the function will be set with the appropriate error. If the value of port is zero, it is set to the default
port of a memcached server.</p>
<p>DEPRECATED <a class="reference internal" href="#_CPPv423memcached_servers_parsev" title="memcached_servers_parse"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_servers_parse()</span></code></a>, please see <a class="reference internal" href="configuration.html#_CPPv49memcachedPKc6size_t" title="memcached"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached()</span></code></a></p>
-<p><a class="reference internal" href="#_CPPv422memcached_server_errorPK21memcached_instance_st" title="memcached_server_error"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_server_error()</span></code></a> can be used to look at the text of the last error message sent by the server to to the client.</p>
+<p><a class="reference internal" href="#_CPPv422memcached_server_errorPK21memcached_instance_st" title="memcached_server_error"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_server_error()</span></code></a> can be used to look at the text of the last
+error message sent by the server to to the client.</p>
<p>Before version 0.39 theses functions used a memcached_server_st *. In 0.39
-memcached_server_st * was aliased to <code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_server_list_st</span></code>. This was done for a style reason to help clean up some concepts in the code.</p>
+memcached_server_st * was aliased to <code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_server_list_st</span></code>.
+This was done for a style reason to help clean up some concepts in the code.</p>
</div>
-<div class="section" id="return">
-<h2>RETURN<a class="headerlink" href="#return" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="return-value">
+<h2>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
<p>Varies, see particular functions.</p>
</div>
<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><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_servers.html"><span class="doc">Managing the servers used by memcached_st</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>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="memcached_servers.html" class="btn btn-neutral float-right" title="Manipulate the server information stored in memcached_st" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="memcached_servers.html" class="btn btn-neutral float-right" title="Managing the servers used by memcached_st" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="index_advanced_servers.html" class="btn btn-neutral float-left" title="Servers and Server Lists" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
projects / awesomized / libmemcached / blobdiff