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

   1
   2
   3 <!DOCTYPE html>
   4 <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
   5 <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
   6 <head>
   7   <meta charset="utf-8">
   8
   9   <meta name="viewport" content="width=device-width, initial-scale=1.0">
  10
  11   <title>Managing the servers used by memcached_st &mdash; libmemcached 1.0.99 documentation</title>
  12
  13
  14
  15
  16
  17
  18
  19
  20   <script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
  21
  22
  23       <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
  24         <script type="text/javascript" src="../_static/jquery.js"></script>
  25         <script type="text/javascript" src="../_static/underscore.js"></script>
  26         <script type="text/javascript" src="../_static/doctools.js"></script>
  27         <script type="text/javascript" src="../_static/language_data.js"></script>
  28
  29     <script type="text/javascript" src="../_static/js/theme.js"></script>
  30
  31
  32
  33
  34   <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  35   <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  36     <link rel="index" title="Index" href="../genindex.html" />
  37     <link rel="search" title="Search" href="../search.html" />
  38     <link rel="copyright" title="Copyright" href="../copyright.html" />
  39     <link rel="next" title="Affecting the memcached Daemon" href="index_advanced_daemon.html" />
  40     <link rel="prev" title="Managing lists of servers" href="memcached_server_st.html" />
  41 </head>
  42
  43 <body class="wy-body-for-nav">
  44
  45
  46   <div class="wy-grid-for-nav">
  47
  48     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  49       <div class="wy-side-scroll">
  50         <div class="wy-side-nav-search" >
  51
  52
  53
  54             <a href="../index.html" class="icon icon-home"> libmemcached
  55
  56
  57
  58           </a>
  59
  60
  61
  62
  63               <div class="version">
  64                 1.0
  65               </div>
  66
  67
  68
  69
  70 <div role="search">
  71   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
  72     <input type="text" name="q" placeholder="Search docs" />
  73     <input type="hidden" name="check_keywords" value="yes" />
  74     <input type="hidden" name="area" value="default" />
  75   </form>
  76 </div>
  77
  78
  79         </div>
  80
  81         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  82
  83
  84
  85
  86
  87
  88               <p class="caption"><span class="caption-text">libmemcached</span></p>
  89 <ul class="current">
  90 <li class="toctree-l1"><a class="reference internal" href="../libmemcached.html">Introduction</a></li>
  91 <li class="toctree-l1 current"><a class="reference internal" href="index.html">libmemcached API</a><ul class="current">
  92 <li class="toctree-l2"><a class="reference internal" href="index_basics.html">Basics</a></li>
  93 <li class="toctree-l2"><a class="reference internal" href="index_data.html">Working with Data</a></li>
  94 <li class="toctree-l2"><a class="reference internal" href="index_errors.html">Messages and Errors</a></li>
  95 <li class="toctree-l2 current"><a class="reference internal" href="index_advanced.html">Advanced Topics</a><ul class="current">
  96 <li class="toctree-l3"><a class="reference internal" href="index_advanced_internals.html">Internal Behavior</a></li>
  97 <li class="toctree-l3"><a class="reference internal" href="index_advanced_aeh.html">Authentication, Encryption &amp; Hashing</a></li>
  98 <li class="toctree-l3 current"><a class="reference internal" href="index_advanced_servers.html">Servers and Server Lists</a><ul class="current">
  99 <li class="toctree-l4"><a class="reference internal" href="memcached_server_st.html">Managing lists of servers</a></li>
 100 <li class="toctree-l4 current"><a class="current reference internal" href="#">Managing the servers used by memcached_st</a></li>
 101 </ul>
 102 </li>
 103 <li class="toctree-l3"><a class="reference internal" href="index_advanced_daemon.html">Affecting the memcached Daemon</a></li>
 104 <li class="toctree-l3"><a class="reference internal" href="index_advanced_stats.html">Statistics</a></li>
 105 </ul>
 106 </li>
 107 <li class="toctree-l2"><a class="reference internal" href="index_deprecated.html">Deprecated Functionality</a></li>
 108 </ul>
 109 </li>
 110 <li class="toctree-l1"><a class="reference internal" href="index_misc.html">Misc</a></li>
 111 </ul>
 112 <p class="caption"><span class="caption-text">libmemcachedutil</span></p>
 113 <ul>
 114 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil.html">Introduction</a></li>
 115 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
 116 </ul>
 117 <p class="caption"><span class="caption-text">libhashkit</span></p>
 118 <ul>
 119 <li class="toctree-l1"><a class="reference internal" href="../libhashkit.html">Introduction</a></li>
 120 <li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a></li>
 121 </ul>
 122 <p class="caption"><span class="caption-text">Client Applications</span></p>
 123 <ul>
 124 <li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a></li>
 125 </ul>
 126 <p class="caption"><span class="caption-text">Copyright</span></p>
 127 <ul>
 128 <li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
 129 </ul>
 130
 131
 132
 133         </div>
 134       </div>
 135     </nav>
 136
 137     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 138
 139
 140       <nav class="wy-nav-top" aria-label="top navigation">
 141
 142           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 143           <a href="../index.html">libmemcached</a>
 144
 145       </nav>
 146
 147
 148       <div class="wy-nav-content">
 149
 150         <div class="rst-content">
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168 <div role="navigation" aria-label="breadcrumbs navigation">
 169
 170   <ul class="wy-breadcrumbs">
 171
 172       <li><a href="../index.html">Docs</a> &raquo;</li>
 173
 174           <li><a href="index.html">libmemcached API</a> &raquo;</li>
 175
 176           <li><a href="index_advanced.html">Advanced Topics</a> &raquo;</li>
 177
 178           <li><a href="index_advanced_servers.html">Servers and Server Lists</a> &raquo;</li>
 179
 180       <li>Managing the servers used by memcached_st</li>
 181
 182
 183       <li class="wy-breadcrumbs-aside">
 184
 185
 186
 187       </li>
 188
 189   </ul>
 190
 191
 192   <hr/>
 193 </div>
 194           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 195            <div itemprop="articleBody">
 196
 197   <div class="section" id="managing-the-servers-used-by-memcached-st">
 198 <h1>Managing the servers used by memcached_st<a class="headerlink" href="#managing-the-servers-used-by-memcached-st" title="Permalink to this headline">¶</a></h1>
 199 <div class="section" id="synopsis">
 200 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
 201 <dl class="docutils">
 202 <dt>#include &lt;libmemcached/memcached.h&gt;</dt>
 203 <dd>Compile and link with -lmemcached</dd>
 204 </dl>
 205 <dl class="function">
 206 <dt id="_CPPv422memcached_server_countP12memcached_st">
 207 <span id="_CPPv322memcached_server_countP12memcached_st"></span><span id="_CPPv222memcached_server_countP12memcached_st"></span><span id="memcached_server_count__memcached_stP"></span>uint32_t <code class="descname">memcached_server_count</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="#_CPPv422memcached_server_countP12memcached_st" title="Permalink to this definition">¶</a><br /></dt>
 208 <dd><table class="docutils field-list" frame="void" rules="none">
 209 <col class="field-name" />
 210 <col class="field-body" />
 211 <tbody valign="top">
 212 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ptr</strong> -- pointer to 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</td>
 213 </tr>
 214 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">number of configured servers</td>
 215 </tr>
 216 </tbody>
 217 </table>
 218 </dd></dl>
 219
 220 <dl class="function">
 221 <dt id="_CPPv420memcached_server_addP12memcached_stPKc9in_port_t">
 222 <span id="_CPPv320memcached_server_addP12memcached_stPKc9in_port_t"></span><span id="_CPPv220memcached_server_addP12memcached_stPKc9in_port_t"></span><span id="memcached_server_add__memcached_stP.cCP.in_port_t"></span><a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> <code class="descname">memcached_server_add</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>, <em class="property">const</em> char *<em>hostname</em>, in_port_t <em>port</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv420memcached_server_addP12memcached_stPKc9in_port_t" title="Permalink to this definition">¶</a><br /></dt>
 223 <dd><table class="docutils field-list" frame="void" rules="none">
 224 <col class="field-name" />
 225 <col class="field-body" />
 226 <tbody valign="top">
 227 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 228 <li><strong>ptr</strong> -- pointer to 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</li>
 229 <li><strong>hostname</strong> -- hostname or IP address of the TCP server to add</li>
 230 <li><strong>port</strong> -- port of the TCP server</li>
 231 </ul>
 232 </td>
 233 </tr>
 234 <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>
 235 </td>
 236 </tr>
 237 </tbody>
 238 </table>
 239 </dd></dl>
 240
 241 <dl class="function">
 242 <dt id="_CPPv424memcached_server_add_udpP12memcached_stPKc9in_port_t">
 243 <span id="_CPPv324memcached_server_add_udpP12memcached_stPKc9in_port_t"></span><span id="_CPPv224memcached_server_add_udpP12memcached_stPKc9in_port_t"></span><span id="memcached_server_add_udp__memcached_stP.cCP.in_port_t"></span><a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> <code class="descname">memcached_server_add_udp</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>, <em class="property">const</em> char *<em>hostname</em>, in_port_t <em>port</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv424memcached_server_add_udpP12memcached_stPKc9in_port_t" title="Permalink to this definition">¶</a><br /></dt>
 244 <dd><table class="docutils field-list" frame="void" rules="none">
 245 <col class="field-name" />
 246 <col class="field-body" />
 247 <tbody valign="top">
 248 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 249 <li><strong>ptr</strong> -- pointer to 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</li>
 250 <li><strong>hostname</strong> -- hostname or IP address of the UDP server to add</li>
 251 <li><strong>port</strong> -- port of the UDP server</li>
 252 </ul>
 253 </td>
 254 </tr>
 255 <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>
 256 </td>
 257 </tr>
 258 </tbody>
 259 </table>
 260 </dd></dl>
 261
 262 <dl class="function">
 263 <dt id="_CPPv432memcached_server_add_unix_socketP12memcached_stPKc">
 264 <span id="_CPPv332memcached_server_add_unix_socketP12memcached_stPKc"></span><span id="_CPPv232memcached_server_add_unix_socketP12memcached_stPKc"></span><span id="memcached_server_add_unix_socket__memcached_stP.cCP"></span><a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> <code class="descname">memcached_server_add_unix_socket</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>, <em class="property">const</em> char *<em>socket</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv432memcached_server_add_unix_socketP12memcached_stPKc" title="Permalink to this definition">¶</a><br /></dt>
 265 <dd><table class="docutils field-list" frame="void" rules="none">
 266 <col class="field-name" />
 267 <col class="field-body" />
 268 <tbody valign="top">
 269 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 270 <li><strong>ptr</strong> -- pointer to 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</li>
 271 <li><strong>socket</strong> -- path to the UNIX socket of the server to add</li>
 272 </ul>
 273 </td>
 274 </tr>
 275 <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>
 276 </td>
 277 </tr>
 278 </tbody>
 279 </table>
 280 </dd></dl>
 281
 282 <dl class="function">
 283 <dt id="_CPPv421memcached_server_pushP12memcached_stPK19memcached_server_st">
 284 <span id="_CPPv321memcached_server_pushP12memcached_stPK19memcached_server_st"></span><span id="_CPPv221memcached_server_pushP12memcached_stPK19memcached_server_st"></span><span id="memcached_server_push__memcached_stP.memcached_server_stCP"></span><a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> <code class="descname">memcached_server_push</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>, <em class="property">const</em> memcached_server_st *<em>list</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv421memcached_server_pushP12memcached_stPK19memcached_server_st" title="Permalink to this definition">¶</a><br /></dt>
 285 <dd><table class="docutils field-list" frame="void" rules="none">
 286 <col class="field-name" />
 287 <col class="field-body" />
 288 <tbody valign="top">
 289 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 290 <li><strong>ptr</strong> -- pointer to 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</li>
 291 <li><strong>list</strong> -- pre-configured list of servers to push</li>
 292 </ul>
 293 </td>
 294 </tr>
 295 <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>
 296 </td>
 297 </tr>
 298 </tbody>
 299 </table>
 300 </dd></dl>
 301
 302 <dl class="function">
 303 <dt id="_CPPv423memcached_server_by_keyP12memcached_stPKc6size_tP18memcached_return_t">
 304 <span id="_CPPv323memcached_server_by_keyP12memcached_stPKc6size_tP18memcached_return_t"></span><span id="_CPPv223memcached_server_by_keyP12memcached_stPKc6size_tP18memcached_return_t"></span><span id="memcached_server_by_key__memcached_stP.cCP.s.memcached_return_tP"></span><em class="property">const</em> memcached_instance_st *<code class="descname">memcached_server_by_key</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>, <em class="property">const</em> char *<em>key</em>, size_t <em>key_length</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="#_CPPv423memcached_server_by_keyP12memcached_stPKc6size_tP18memcached_return_t" title="Permalink to this definition">¶</a><br /></dt>
 305 <dd><table class="docutils field-list" frame="void" rules="none">
 306 <col class="field-name" />
 307 <col class="field-body" />
 308 <tbody valign="top">
 309 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 310 <li><strong>ptr</strong> -- pointer to 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</li>
 311 <li><strong>key</strong> -- key to hash and lookup a server</li>
 312 <li><strong>key_length</strong> -- length of <a class="reference internal" href="#_CPPv423memcached_server_by_keyP12memcached_stPKc6size_tP18memcached_return_t" title="memcached_server_by_key::key"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">key</span></code></a> without any terminating zero</li>
 313 <li><strong>error</strong> -- pointer to <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</li>
 314 </ul>
 315 </td>
 316 </tr>
 317 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the server instance to be used for storing/retrieving <a class="reference internal" href="#_CPPv423memcached_server_by_keyP12memcached_stPKc6size_tP18memcached_return_t" title="memcached_server_by_key::key"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">key</span></code></a></p>
 318 </td>
 319 </tr>
 320 </tbody>
 321 </table>
 322 </dd></dl>
 323
 324 <dl class="function">
 325 <dt id="_CPPv436memcached_server_get_last_disconnectPK12memcached_st">
 326 <span id="_CPPv336memcached_server_get_last_disconnectPK12memcached_st"></span><span id="_CPPv236memcached_server_get_last_disconnectPK12memcached_st"></span><span id="memcached_server_get_last_disconnect__memcached_stCP"></span><em class="property">const</em> memcached_instance_st *<code class="descname">memcached_server_get_last_disconnect</code><span class="sig-paren">(</span><em class="property">const</em> <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="#_CPPv436memcached_server_get_last_disconnectPK12memcached_st" title="Permalink to this definition">¶</a><br /></dt>
 327 <dd><table class="docutils field-list" frame="void" rules="none">
 328 <col class="field-name" />
 329 <col class="field-body" />
 330 <tbody valign="top">
 331 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ptr</strong> -- pointer to 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</td>
 332 </tr>
 333 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">the instance of the last server for which there was a connection problem</td>
 334 </tr>
 335 </tbody>
 336 </table>
 337 </dd></dl>
 338
 339 <dl class="function">
 340 <dt id="_CPPv423memcached_server_cursorPK12memcached_stPK19memcached_server_fnPv8uint32_t">
 341 <span id="_CPPv323memcached_server_cursorPK12memcached_stPK19memcached_server_fnPv8uint32_t"></span><span id="_CPPv223memcached_server_cursorPK12memcached_stPK19memcached_server_fnPv8uint32_t"></span><span id="memcached_server_cursor__memcached_stCP.memcached_server_fnCP.voidP.uint32_t"></span><a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> <code class="descname">memcached_server_cursor</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<em>ptr</em>, <em class="property">const</em> <a class="reference internal" href="#_CPPv419memcached_server_fn" title="memcached_server_fn">memcached_server_fn</a> *<em>callback</em>, void *<em>context</em>, uint32_t <em>number_of_callbacks</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv423memcached_server_cursorPK12memcached_stPK19memcached_server_fnPv8uint32_t" title="Permalink to this definition">¶</a><br /></dt>
 342 <dd><table class="docutils field-list" frame="void" rules="none">
 343 <col class="field-name" />
 344 <col class="field-body" />
 345 <tbody valign="top">
 346 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 347 <li><strong>ptr</strong> -- pointer to 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</li>
 348 <li><strong>callback</strong> -- list of <a class="reference internal" href="#_CPPv419memcached_server_fn" title="memcached_server_fn"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_server_fn</span></code></a> to be called for each server instance</li>
 349 <li><strong>context</strong> -- pointer to user supplied context for the callback</li>
 350 <li><strong>number_of_callbacks</strong> -- number of callbacks supplied</li>
 351 </ul>
 352 </td>
 353 </tr>
 354 <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>
 355 </td>
 356 </tr>
 357 </tbody>
 358 </table>
 359 </dd></dl>
 360
 361 <dl class="type">
 362 <dt id="_CPPv419memcached_server_fn">
 363 <span id="_CPPv319memcached_server_fn"></span><span id="_CPPv219memcached_server_fn"></span><span id="memcached_server_fn"></span><em class="property">typedef </em><a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> (*<code class="descname">memcached_server_fn</code>)<span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *ptr, <em class="property">const</em> memcached_instance_st *server, void *context<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv419memcached_server_fn" title="Permalink to this definition">¶</a><br /></dt>
 364 <dd><table class="docutils field-list" frame="void" rules="none">
 365 <col class="field-name" />
 366 <col class="field-body" />
 367 <tbody valign="top">
 368 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 369 <li><strong>ptr</strong> -- 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> struct</li>
 370 <li><strong>server</strong> -- pointer to <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_instance_st</span></code></li>
 371 <li><strong>context</strong> -- pointer to user supplied context</li>
 372 </ul>
 373 </td>
 374 </tr>
 375 <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>
 376 </td>
 377 </tr>
 378 </tbody>
 379 </table>
 380 </dd></dl>
 381
 382 </div>
 383 <div class="section" id="description">
 384 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
 385 <p><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">libmemcached</span></code> performs operations on a list of hosts. The order of
 386 these hosts determine routing to keys. Functions are provided to add keys to
 387 <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> structures. To manipulate lists of servers see
 388 <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_server_st</span></code>.</p>
 389 <p><a class="reference internal" href="#_CPPv422memcached_server_countP12memcached_st" title="memcached_server_count"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_server_count()</span></code></a> provides you a count of the current number of
 390 servers being used by a <a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_st</span></code></a> structure.</p>
 391 <p><a class="reference internal" href="#_CPPv420memcached_server_addP12memcached_stPKc9in_port_t" title="memcached_server_add"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_server_add()</span></code></a> pushes a single TCP server into the
 392 <a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_st</span></code></a> structure. This server will be placed at the end.
 393 Duplicate servers are allowed, so duplication is not checked. Executing this
 394 function with the <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> behavior set will result in
 395 a <a class="reference internal" href="memcached_return_t.html#_CPPv4N18memcached_return_t31MEMCACHED_INVALID_HOST_PROTOCOLE" title="MEMCACHED_INVALID_HOST_PROTOCOL"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_INVALID_HOST_PROTOCOL</span></code></a>.</p>
 396 <p><a class="reference internal" href="#_CPPv424memcached_server_add_udpP12memcached_stPKc9in_port_t" title="memcached_server_add_udp"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_server_add_udp()</span></code></a> pushes a single UDP server into the
 397 <a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_st</span></code></a> structure. This server will be placed at the end. Duplicate
 398 servers are allowed, so duplication is not checked. Executing this function
 399 without setting the <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> behavior will result in a
 400 <a class="reference internal" href="memcached_return_t.html#_CPPv4N18memcached_return_t31MEMCACHED_INVALID_HOST_PROTOCOLE" title="MEMCACHED_INVALID_HOST_PROTOCOL"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_INVALID_HOST_PROTOCOL</span></code></a>.</p>
 401 <p><a class="reference internal" href="#_CPPv432memcached_server_add_unix_socketP12memcached_stPKc" title="memcached_server_add_unix_socket"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_server_add_unix_socket()</span></code></a> pushes a single UNIX socket into the
 402 <a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_st</span></code></a> structure. This UNIX socket will be placed at the end.
 403 Duplicate servers are allowed, so duplication is not checked. The length
 404 of the filename must be one character less than <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_MAX_HOST_LENGTH</span></code>.</p>
 405 <p><a class="reference internal" href="#_CPPv421memcached_server_pushP12memcached_stPK19memcached_server_st" title="memcached_server_push"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_server_push()</span></code></a> pushes an array of <code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_server_st</span></code>
 406 into the <a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_st</span></code></a> structure. These servers will be placed at
 407 the end. Duplicate servers are allowed, so duplication is not checked. A
 408 copy is made of structure so the list provided (and any operations on
 409 the list) are not saved.</p>
 410 <p><a class="reference internal" href="#_CPPv423memcached_server_by_keyP12memcached_stPKc6size_tP18memcached_return_t" title="memcached_server_by_key"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_server_by_key()</span></code></a> allows you to provide a key and retrieve the
 411 server which would be used for assignment.</p>
 412 <p><a class="reference internal" href="#_CPPv436memcached_server_get_last_disconnectPK12memcached_st" title="memcached_server_get_last_disconnect"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_server_get_last_disconnect()</span></code></a> returns a pointer to the last
 413 server for which there was a connection problem. It does not mean this
 414 particular server is currently dead but if the library is reporting a server
 415 is, the returned server is a very good candidate.</p>
 416 <p><a class="reference internal" href="#_CPPv423memcached_server_cursorPK12memcached_stPK19memcached_server_fnPv8uint32_t" title="memcached_server_cursor"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_server_cursor()</span></code></a> takes a memcached_st and loops through the
 417 list of hosts currently in the cursor calling the list of callback
 418 functions provided. You can optionally pass in a value via
 419 context which will be provided to each callback function. An error
 420 return from any callback will terminate the loop.
 421 <a class="reference internal" href="#_CPPv423memcached_server_cursorPK12memcached_stPK19memcached_server_fnPv8uint32_t" title="memcached_server_cursor"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_server_cursor()</span></code></a> is passed the original caller
 422 <a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_st</span></code></a> in its current state.</p>
 423 </div>
 424 <div class="section" id="return-value">
 425 <h2>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
 426 <p>Varies, see particular functions.</p>
 427 </div>
 428 <div class="section" id="see-also">
 429 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
 430 <ul class="simple">
 431 <li><em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/1/memcached">memcached(1)</a></em></li>
 432 <li><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></li>
 433 <li><a class="reference internal" href="memcached_server_st.html"><span class="doc">Managing lists of servers</span></a></li>
 434 <li><a class="reference internal" href="memcached_strerror.html"><span class="doc">Converting Error Codes to Messages</span></a></li>
 435 </ul>
 436 </div>
 437 </div>
 438
 439
 440            </div>
 441
 442           </div>
 443           <footer>
 444
 445     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 446
 447         <a href="index_advanced_daemon.html" class="btn btn-neutral float-right" title="Affecting the memcached Daemon" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 448
 449
 450         <a href="memcached_server_st.html" class="btn btn-neutral float-left" title="Managing lists of servers" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 451
 452     </div>
 453
 454
 455   <hr/>
 456
 457   <div role="contentinfo">
 458     <p>
 459         &copy; <a href="../copyright.html">Copyright</a>
 460
 461     </p>
 462   </div>
 463   Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
 464
 465 </footer>
 466
 467         </div>
 468       </div>
 469
 470     </section>
 471
 472   </div>
 473
 474
 475
 476   <script type="text/javascript">
 477       jQuery(function () {
 478           SphinxRtdTheme.Navigation.enable(true);
 479       });
 480   </script>
 481
 482
 483
 484
 485
 486
 487 </body>
 488 </html>