git.m6w6.name Git - m6w6/libmemcached/blob - libmemcachedutil/memcached_pool.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>Working with memcached pools &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 src="../_static/jquery.js"></script>
  25         <script src="../_static/underscore.js"></script>
  26         <script src="../_static/doctools.js"></script>
  27         <script 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="libhashkit - C/C++ hashing library" href="../libhashkit.html" />
  40     <link rel="prev" title="libmemcachedutil API" href="index.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>
  90 <li class="toctree-l1"><a class="reference internal" href="../libmemcached.html">Introduction</a></li>
  91 <li class="toctree-l1"><a class="reference internal" href="../libmemcached/index.html">libmemcached API</a><ul>
  92 <li class="toctree-l2"><a class="reference internal" href="../libmemcached/index_basics.html">Basics</a></li>
  93 <li class="toctree-l2"><a class="reference internal" href="../libmemcached/index_data.html">Working with Data</a></li>
  94 <li class="toctree-l2"><a class="reference internal" href="../libmemcached/index_errors.html">Messages and Errors</a></li>
  95 <li class="toctree-l2"><a class="reference internal" href="../libmemcached/index_advanced.html">Advanced Topics</a></li>
  96 <li class="toctree-l2"><a class="reference internal" href="../libmemcached/index_deprecated.html">Deprecated Functionality</a></li>
  97 </ul>
  98 </li>
  99 <li class="toctree-l1"><a class="reference internal" href="../libmemcached/index_misc.html">Misc</a><ul>
 100 <li class="toctree-l2"><a class="reference internal" href="../libmemcached/configuration.html">Configuration</a></li>
 101 <li class="toctree-l2"><a class="reference internal" href="../libmemcached/constants.html">Constants</a></li>
 102 <li class="toctree-l2"><a class="reference internal" href="../libmemcached/examples.html">Examples</a></li>
 103 <li class="toctree-l2"><a class="reference internal" href="../libmemcached/versioning.html">Versioning</a></li>
 104 </ul>
 105 </li>
 106 </ul>
 107 <p class="caption"><span class="caption-text">libmemcachedutil</span></p>
 108 <ul class="current">
 109 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil.html">Introduction</a></li>
 110 <li class="toctree-l1 current"><a class="reference internal" href="index.html">libmemcachedutil API</a><ul class="current">
 111 <li class="toctree-l2 current"><a class="current reference internal" href="#">Working with memcached pools</a></li>
 112 </ul>
 113 </li>
 114 </ul>
 115 <p class="caption"><span class="caption-text">libhashkit</span></p>
 116 <ul>
 117 <li class="toctree-l1"><a class="reference internal" href="../libhashkit.html">Introduction</a></li>
 118 <li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a><ul>
 119 <li class="toctree-l2"><a class="reference internal" href="../libhashkit/hashkit_create.html">Creating a hashkit structure</a></li>
 120 <li class="toctree-l2"><a class="reference internal" href="../libhashkit/hashkit_function.html">Set Hash Function</a></li>
 121 <li class="toctree-l2"><a class="reference internal" href="../libhashkit/hashkit_functions.html">Available Hashes</a></li>
 122 <li class="toctree-l2"><a class="reference internal" href="../libhashkit/hashkit_value.html">Generate hash value</a></li>
 123 </ul>
 124 </li>
 125 </ul>
 126 <p class="caption"><span class="caption-text">Client Applications</span></p>
 127 <ul>
 128 <li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a><ul>
 129 <li class="toctree-l2"><a class="reference internal" href="../bin/memcapable.html">memcapable - Checking a Memcached server capabilities and compatibility</a></li>
 130 <li class="toctree-l2"><a class="reference internal" href="../bin/memcat.html">memcat - “cat” data from a server</a></li>
 131 <li class="toctree-l2"><a class="reference internal" href="../bin/memcp.html">memcp - Copy data to a server</a></li>
 132 <li class="toctree-l2"><a class="reference internal" href="../bin/memdump.html">memdump - Dumping your server</a></li>
 133 <li class="toctree-l2"><a class="reference internal" href="../bin/memerror.html">memerror - translate an error code to a string</a></li>
 134 <li class="toctree-l2"><a class="reference internal" href="../bin/memflush.html">memflush - flush all data from a server</a></li>
 135 <li class="toctree-l2"><a class="reference internal" href="../bin/memrm.html">memrm - Remove data from a server</a></li>
 136 <li class="toctree-l2"><a class="reference internal" href="../bin/memslap.html">memslap - Load testing  and benchmarking a server</a></li>
 137 <li class="toctree-l2"><a class="reference internal" href="../bin/memaslap.html">memaslap - Load testing  and benchmarking a server</a></li>
 138 <li class="toctree-l2"><a class="reference internal" href="../bin/memstat.html">memstat - Gather statistics from a server</a></li>
 139 <li class="toctree-l2"><a class="reference internal" href="../bin/memexist.html">memexist - Check for the existence of a key</a></li>
 140 <li class="toctree-l2"><a class="reference internal" href="../bin/memparse.html">memparse - Parse an option string</a></li>
 141 <li class="toctree-l2"><a class="reference internal" href="../bin/memping.html">memping - Test to see if a server is available.</a></li>
 142 <li class="toctree-l2"><a class="reference internal" href="../bin/memtouch.html">memtouch - Touches a key.</a></li>
 143 </ul>
 144 </li>
 145 </ul>
 146
 147
 148
 149         </div>
 150       </div>
 151     </nav>
 152
 153     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 154
 155
 156       <nav class="wy-nav-top" aria-label="top navigation">
 157
 158           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 159           <a href="../index.html">libmemcached</a>
 160
 161       </nav>
 162
 163
 164       <div class="wy-nav-content">
 165
 166         <div class="rst-content">
 167
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184 <div role="navigation" aria-label="breadcrumbs navigation">
 185
 186   <ul class="wy-breadcrumbs">
 187
 188       <li><a href="../index.html">Docs</a> &raquo;</li>
 189
 190           <li><a href="index.html">libmemcachedutil API</a> &raquo;</li>
 191
 192       <li>Working with memcached pools</li>
 193
 194
 195       <li class="wy-breadcrumbs-aside">
 196
 197
 198
 199       </li>
 200
 201   </ul>
 202
 203
 204   <hr/>
 205 </div>
 206           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 207            <div itemprop="articleBody">
 208
 209   <div class="section" id="working-with-memcached-pools">
 210 <h1>Working with memcached pools<a class="headerlink" href="#working-with-memcached-pools" title="Permalink to this headline">¶</a></h1>
 211 <div class="section" id="synopsis">
 212 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
 213 <dl class="simple">
 214 <dt>#include &lt;libmemcached/memcached_pool.h&gt;</dt><dd><p>Compile and link with -lmemcachedutil -lmemcached</p>
 215 </dd>
 216 </dl>
 217 <dl class="type">
 218 <dt id="_CPPv417memcached_pool_st">
 219 <span id="_CPPv317memcached_pool_st"></span><span id="_CPPv217memcached_pool_st"></span><span id="memcached_pool_st"></span><em class="property">typedef </em><em class="property">struct</em> <a class="reference internal" href="#_CPPv417memcached_pool_st" title="memcached_pool_st">memcached_pool_st</a> <code class="sig-name descname">memcached_pool_st</code><a class="headerlink" href="#_CPPv417memcached_pool_st" title="Permalink to this definition">¶</a><br /></dt>
 220 <dd></dd></dl>
 221
 222 <dl class="function">
 223 <dt id="_CPPv414memcached_poolPKc6size_t">
 224 <span id="_CPPv314memcached_poolPKc6size_t"></span><span id="_CPPv214memcached_poolPKc6size_t"></span><span id="memcached_pool__cCP.s"></span><a class="reference internal" href="#_CPPv417memcached_pool_st" title="memcached_pool_st">memcached_pool_st</a> *<code class="sig-name descname">memcached_pool</code><span class="sig-paren">(</span><em class="property">const</em> char *<em>option_string</em>, size_t <em>option_string_length</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv414memcached_poolPKc6size_t" title="Permalink to this definition">¶</a><br /></dt>
 225 <dd></dd></dl>
 226
 227 <dl class="function">
 228 <dt id="_CPPv422memcached_pool_destroyP17memcached_pool_st">
 229 <span id="_CPPv322memcached_pool_destroyP17memcached_pool_st"></span><span id="_CPPv222memcached_pool_destroyP17memcached_pool_st"></span><span id="memcached_pool_destroy__memcached_pool_stP"></span><a class="reference internal" href="../libmemcached/memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<code class="sig-name descname">memcached_pool_destroy</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv417memcached_pool_st" title="memcached_pool_st">memcached_pool_st</a> *<em>pool</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv422memcached_pool_destroyP17memcached_pool_st" title="Permalink to this definition">¶</a><br /></dt>
 230 <dd></dd></dl>
 231
 232 <dl class="function">
 233 <dt id="_CPPv420memcached_pool_fetchP17memcached_pool_stP8timespecP18memcached_return_t">
 234 <span id="_CPPv320memcached_pool_fetchP17memcached_pool_stP8timespecP18memcached_return_t"></span><span id="_CPPv220memcached_pool_fetchP17memcached_pool_stP8timespecP18memcached_return_t"></span><span id="memcached_pool_fetch__memcached_pool_stP.timespecP.memcached_return_tP"></span><a class="reference internal" href="../libmemcached/memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<code class="sig-name descname">memcached_pool_fetch</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv417memcached_pool_st" title="memcached_pool_st">memcached_pool_st</a> *, <em class="property">struct</em> timespec *<em>relative_time</em>, <a class="reference internal" href="../libmemcached/memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> *<em>rc</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv420memcached_pool_fetchP17memcached_pool_stP8timespecP18memcached_return_t" title="Permalink to this definition">¶</a><br /></dt>
 235 <dd></dd></dl>
 236
 237 <div class="versionadded">
 238 <p><span class="versionmodified added">New in version 0.53: </span>Synonym for memcached_pool_pop</p>
 239 </div>
 240 <dl class="function">
 241 <dt id="_CPPv422memcached_pool_releaseP17memcached_pool_stP12memcached_st">
 242 <span id="_CPPv322memcached_pool_releaseP17memcached_pool_stP12memcached_st"></span><span id="_CPPv222memcached_pool_releaseP17memcached_pool_stP12memcached_st"></span><span id="memcached_pool_release__memcached_pool_stP.memcached_stP"></span><a class="reference internal" href="../libmemcached/memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> <code class="sig-name descname">memcached_pool_release</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv417memcached_pool_st" title="memcached_pool_st">memcached_pool_st</a> *<em>pool</em>, <a class="reference internal" href="../libmemcached/memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<em>mmc</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv422memcached_pool_releaseP17memcached_pool_stP12memcached_st" title="Permalink to this definition">¶</a><br /></dt>
 243 <dd></dd></dl>
 244
 245 <div class="versionadded">
 246 <p><span class="versionmodified added">New in version 0.53: </span>Synonym for memcached_pool_push.</p>
 247 </div>
 248 <dl class="function">
 249 <dt id="_CPPv427memcached_pool_behavior_setP17memcached_pool_st20memcached_behavior_t8uint64_t">
 250 <span id="_CPPv327memcached_pool_behavior_setP17memcached_pool_st20memcached_behavior_t8uint64_t"></span><span id="_CPPv227memcached_pool_behavior_setP17memcached_pool_st20memcached_behavior_t8uint64_t"></span><span id="memcached_pool_behavior_set__memcached_pool_stP.memcached_behavior_t.uint64_t"></span><a class="reference internal" href="../libmemcached/memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> <code class="sig-name descname">memcached_pool_behavior_set</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv417memcached_pool_st" title="memcached_pool_st">memcached_pool_st</a> *<em>pool</em>, <a class="reference internal" href="../libmemcached/memcached_behavior.html#_CPPv420memcached_behavior_t" title="memcached_behavior_t">memcached_behavior_t</a> <em>flag</em>, uint64_t <em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv427memcached_pool_behavior_setP17memcached_pool_st20memcached_behavior_t8uint64_t" title="Permalink to this definition">¶</a><br /></dt>
 251 <dd></dd></dl>
 252
 253 <dl class="function">
 254 <dt id="_CPPv427memcached_pool_behavior_getP17memcached_pool_st20memcached_behavior_tP8uint64_t">
 255 <span id="_CPPv327memcached_pool_behavior_getP17memcached_pool_st20memcached_behavior_tP8uint64_t"></span><span id="_CPPv227memcached_pool_behavior_getP17memcached_pool_st20memcached_behavior_tP8uint64_t"></span><span id="memcached_pool_behavior_get__memcached_pool_stP.memcached_behavior_t.uint64_tP"></span><a class="reference internal" href="../libmemcached/memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> <code class="sig-name descname">memcached_pool_behavior_get</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv417memcached_pool_st" title="memcached_pool_st">memcached_pool_st</a> *<em>pool</em>, <a class="reference internal" href="../libmemcached/memcached_behavior.html#_CPPv420memcached_behavior_t" title="memcached_behavior_t">memcached_behavior_t</a> <em>flag</em>, uint64_t *<em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv427memcached_pool_behavior_getP17memcached_pool_st20memcached_behavior_tP8uint64_t" title="Permalink to this definition">¶</a><br /></dt>
 256 <dd></dd></dl>
 257
 258 <dl class="function">
 259 <dt id="_CPPv421memcached_pool_createP12memcached_stii">
 260 <span id="_CPPv321memcached_pool_createP12memcached_stii"></span><span id="_CPPv221memcached_pool_createP12memcached_stii"></span><span id="memcached_pool_create__memcached_stP.i.i"></span><a class="reference internal" href="#_CPPv417memcached_pool_st" title="memcached_pool_st">memcached_pool_st</a> *<code class="sig-name descname">memcached_pool_create</code><span class="sig-paren">(</span><a class="reference internal" href="../libmemcached/memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<em>mmc</em>, int <em>initial</em>, int <em>max</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv421memcached_pool_createP12memcached_stii" title="Permalink to this definition">¶</a><br /></dt>
 261 <dd></dd></dl>
 262
 263 <div class="deprecated">
 264 <p><span class="versionmodified deprecated">Deprecated since version 0.46: </span>Use <a class="reference internal" href="#_CPPv414memcached_poolPKc6size_t" title="memcached_pool"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_pool()</span></code></a></p>
 265 </div>
 266 <dl class="function">
 267 <dt id="_CPPv418memcached_pool_popP17memcached_pool_stbP18memcached_return_t">
 268 <span id="_CPPv318memcached_pool_popP17memcached_pool_stbP18memcached_return_t"></span><span id="_CPPv218memcached_pool_popP17memcached_pool_stbP18memcached_return_t"></span><span id="memcached_pool_pop__memcached_pool_stP.b.memcached_return_tP"></span><a class="reference internal" href="../libmemcached/memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<code class="sig-name descname">memcached_pool_pop</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv417memcached_pool_st" title="memcached_pool_st">memcached_pool_st</a> *<em>pool</em>, bool <em>block</em>, <a class="reference internal" href="../libmemcached/memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> *<em>rc</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv418memcached_pool_popP17memcached_pool_stbP18memcached_return_t" title="Permalink to this definition">¶</a><br /></dt>
 269 <dd></dd></dl>
 270
 271 <div class="deprecated">
 272 <p><span class="versionmodified deprecated">Deprecated since version 0.53: </span>Use <a class="reference internal" href="#_CPPv420memcached_pool_fetchP17memcached_pool_stP8timespecP18memcached_return_t" title="memcached_pool_fetch"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_pool_fetch()</span></code></a></p>
 273 </div>
 274 <dl class="function">
 275 <dt id="_CPPv419memcached_pool_pushP17memcached_pool_stP12memcached_st">
 276 <span id="_CPPv319memcached_pool_pushP17memcached_pool_stP12memcached_st"></span><span id="_CPPv219memcached_pool_pushP17memcached_pool_stP12memcached_st"></span><span id="memcached_pool_push__memcached_pool_stP.memcached_stP"></span><a class="reference internal" href="../libmemcached/memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> <code class="sig-name descname">memcached_pool_push</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv417memcached_pool_st" title="memcached_pool_st">memcached_pool_st</a> *<em>pool</em>, <a class="reference internal" href="../libmemcached/memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<em>mmc</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv419memcached_pool_pushP17memcached_pool_stP12memcached_st" title="Permalink to this definition">¶</a><br /></dt>
 277 <dd></dd></dl>
 278
 279 <div class="deprecated">
 280 <p><span class="versionmodified deprecated">Deprecated since version 0.53: </span>Use <a class="reference internal" href="#_CPPv422memcached_pool_releaseP17memcached_pool_stP12memcached_st" title="memcached_pool_release"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_pool_release()</span></code></a></p>
 281 </div>
 282 </div>
 283 <div class="section" id="description">
 284 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
 285 <p><a class="reference internal" href="#_CPPv414memcached_poolPKc6size_t" title="memcached_pool"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_pool()</span></code></a> is used to create a connection pool of objects you
 286 may use to remove the overhead of using memcached_clone for short lived
 287 <a class="reference internal" href="../libmemcached/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> objects. Please see <a class="reference internal" href="../libmemcached/configuration.html"><span class="doc">libmemcached Configuration</span></a>
 288 for details on the format of the configuration string.</p>
 289 <p><a class="reference internal" href="#_CPPv422memcached_pool_destroyP17memcached_pool_st" title="memcached_pool_destroy"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_pool_destroy()</span></code></a> is used to destroy the connection pool
 290 created with <a class="reference internal" href="#_CPPv421memcached_pool_createP12memcached_stii" title="memcached_pool_create"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_pool_create()</span></code></a> and release all allocated
 291 resources. It will return the pointer to the <a class="reference internal" href="../libmemcached/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
 292 passed as an argument to <a class="reference internal" href="#_CPPv421memcached_pool_createP12memcached_stii" title="memcached_pool_create"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_pool_create()</span></code></a>, and returns the
 293 ownership of the pointer to the caller when created with
 294 <a class="reference internal" href="#_CPPv421memcached_pool_createP12memcached_stii" title="memcached_pool_create"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_pool_create()</span></code></a>, otherwise NULL is returned..</p>
 295 <p><a class="reference internal" href="#_CPPv420memcached_pool_fetchP17memcached_pool_stP8timespecP18memcached_return_t" title="memcached_pool_fetch"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_pool_fetch()</span></code></a> is used to fetch a connection structure from the
 296 connection pool. The relative_time argument specifies if the function should
 297 block and wait for a connection structure to be available if we try
 298 to exceed the maximum size. You need to specify time in relative time.</p>
 299 <p><a class="reference internal" href="#_CPPv422memcached_pool_releaseP17memcached_pool_stP12memcached_st" title="memcached_pool_release"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_pool_release()</span></code></a> is used to return a connection structure back
 300 to the pool.</p>
 301 <p><a class="reference internal" href="#_CPPv427memcached_pool_behavior_getP17memcached_pool_st20memcached_behavior_tP8uint64_t" title="memcached_pool_behavior_get"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_pool_behavior_get()</span></code></a> and <a class="reference internal" href="#_CPPv427memcached_pool_behavior_setP17memcached_pool_st20memcached_behavior_t8uint64_t" title="memcached_pool_behavior_set"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_pool_behavior_set()</span></code></a>
 302 is used to get/set behavior flags on all connections in the pool.</p>
 303 <p>Both <a class="reference internal" href="#_CPPv422memcached_pool_releaseP17memcached_pool_stP12memcached_st" title="memcached_pool_release"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_pool_release()</span></code></a> and <a class="reference internal" href="#_CPPv420memcached_pool_fetchP17memcached_pool_stP8timespecP18memcached_return_t" title="memcached_pool_fetch"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_pool_fetch()</span></code></a> are
 304 thread safe.</p>
 305 </div>
 306 <div class="section" id="return">
 307 <h2>RETURN<a class="headerlink" href="#return" title="Permalink to this headline">¶</a></h2>
 308 <p><a class="reference internal" href="#_CPPv422memcached_pool_destroyP17memcached_pool_st" title="memcached_pool_destroy"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_pool_destroy()</span></code></a> returns the pointer (and ownership) to the
 309 <a class="reference internal" href="../libmemcached/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 used to create the pool. If connections are in
 310 use it returns NULL.</p>
 311 <p><a class="reference internal" href="#_CPPv418memcached_pool_popP17memcached_pool_stbP18memcached_return_t" title="memcached_pool_pop"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_pool_pop()</span></code></a> returns a pointer to a <a class="reference internal" href="../libmemcached/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>
 312 structure from the pool (or NULL if an allocation cannot be satisfied).</p>
 313 <p><a class="reference internal" href="#_CPPv422memcached_pool_releaseP17memcached_pool_stP12memcached_st" title="memcached_pool_release"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_pool_release()</span></code></a> returns <a class="reference internal" href="../libmemcached/memcached_return_t.html#_CPPv4N18memcached_return_t17MEMCACHED_SUCCESSE" title="MEMCACHED_SUCCESS"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_SUCCESS</span></code></a> upon success.</p>
 314 <p><a class="reference internal" href="#_CPPv427memcached_pool_behavior_getP17memcached_pool_st20memcached_behavior_tP8uint64_t" title="memcached_pool_behavior_get"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_pool_behavior_get()</span></code></a> and <a class="reference internal" href="#_CPPv427memcached_pool_behavior_getP17memcached_pool_st20memcached_behavior_tP8uint64_t" title="memcached_pool_behavior_get"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_pool_behavior_get()</span></code></a>
 315 returns <a class="reference internal" href="../libmemcached/memcached_return_t.html#_CPPv4N18memcached_return_t17MEMCACHED_SUCCESSE" title="MEMCACHED_SUCCESS"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_SUCCESS</span></code></a> upon success.</p>
 316 <p>If any methods returns MEMCACHED_IN_PROGRESS then a lock on the pool could not
 317 be obtained. If any of the parameters passed to any of these functions is
 318 invalid, MEMCACHED_INVALID_ARGUMENTS will be returned.</p>
 319 <p>memcached_pool_fetch may return MEMCACHED_TIMEOUT if a timeout occurs while
 320 waiting for a free memcached_st. MEMCACHED_NOTFOUND if no memcached_st was
 321 available.</p>
 322 </div>
 323 <div class="section" id="see-also">
 324 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
 325 <ul class="simple">
 326 <li><p><em class="manpage"><a class="manpage reference external" href="http://man7.org/linux/man-pages/man1/memcached.1.html">memcached(1)</a></em></p></li>
 327 <li><p><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></p></li>
 328 <li><p><a class="reference internal" href="../libmemcached/configuration.html"><span class="doc">libmemcached Configuration</span></a></p></li>
 329 <li><p><a class="reference internal" href="../libmemcached/memcached_strerror.html"><span class="doc">Converting Error Codes to Messages</span></a></p></li>
 330 </ul>
 331 </div>
 332 </div>
 333
 334
 335            </div>
 336
 337           </div>
 338           <footer>
 339
 340     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 341
 342         <a href="../libhashkit.html" class="btn btn-neutral float-right" title="libhashkit - C/C++ hashing library" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 343
 344
 345         <a href="index.html" class="btn btn-neutral float-left" title="libmemcachedutil API" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 346
 347     </div>
 348
 349
 350   <hr/>
 351
 352   <div role="contentinfo">
 353     <p>
 354         &copy; <a href="../copyright.html">Copyright</a>
 355
 356     </p>
 357   </div>
 358   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>.
 359
 360 </footer>
 361
 362         </div>
 363       </div>
 364
 365     </section>
 366
 367   </div>
 368
 369
 370
 371   <script type="text/javascript">
 372       jQuery(function () {
 373           SphinxRtdTheme.Navigation.enable(true);
 374       });
 375   </script>
 376
 377
 378
 379
 380
 381
 382 </body>
 383 </html>