4 <html class=
"writer-html5" lang=
"en" >
8 <meta name=
"viewport" content=
"width=device-width, initial-scale=1.0">
10 <title>Working with memcached pools
— libmemcached
1.0.99 documentation
</title>
14 <link rel=
"stylesheet" href=
"../_static/css/theme.css" type=
"text/css" />
15 <link rel=
"stylesheet" href=
"../_static/pygments.css" type=
"text/css" />
24 <script src="../_static/js/html5shiv.min.js"></script>
28 <script type=
"text/javascript" id=
"documentation_options" data-url_root=
"../" src=
"../_static/documentation_options.js"></script>
29 <script src=
"../_static/jquery.js"></script>
30 <script src=
"../_static/underscore.js"></script>
31 <script src=
"../_static/doctools.js"></script>
32 <script src=
"../_static/language_data.js"></script>
34 <script type=
"text/javascript" src=
"../_static/js/theme.js"></script>
37 <link rel=
"index" title=
"Index" href=
"../genindex.html" />
38 <link rel=
"search" title=
"Search" href=
"../search.html" />
39 <link rel=
"copyright" title=
"Copyright" href=
"../copyright.html" />
40 <link rel=
"next" title=
"libhashkit - C/C++ hashing library" href=
"../libhashkit.html" />
41 <link rel=
"prev" title=
"libmemcachedutil API" href=
"index.html" />
44 <body class=
"wy-body-for-nav">
47 <div class=
"wy-grid-for-nav">
49 <nav data-toggle=
"wy-nav-shift" class=
"wy-nav-side">
50 <div class=
"wy-side-scroll">
51 <div class=
"wy-side-nav-search" >
55 <a href=
"../index.html" class=
"icon icon-home" alt=
"Documentation Home"> libmemcached
72 <form id=
"rtd-search-form" class=
"wy-form" action=
"../search.html" method=
"get">
73 <input type=
"text" name=
"q" placeholder=
"Search docs" />
74 <input type=
"hidden" name=
"check_keywords" value=
"yes" />
75 <input type=
"hidden" name=
"area" value=
"default" />
83 <div class=
"wy-menu wy-menu-vertical" data-spy=
"affix" role=
"navigation" aria-label=
"main navigation">
90 <p class=
"caption"><span class=
"caption-text">libmemcached
</span></p>
92 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcached.html">Introduction
</a></li>
93 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcached/index.html">libmemcached API
</a></li>
94 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcached/index_misc.html">Misc
</a></li>
96 <p class=
"caption"><span class=
"caption-text">libmemcachedutil
</span></p>
98 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcachedutil.html">Introduction
</a></li>
99 <li class=
"toctree-l1 current"><a class=
"reference internal" href=
"index.html">libmemcachedutil API
</a><ul class=
"current">
100 <li class=
"toctree-l2 current"><a class=
"current reference internal" href=
"#">Working with memcached pools
</a></li>
104 <p class=
"caption"><span class=
"caption-text">libhashkit
</span></p>
106 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libhashkit.html">Introduction
</a></li>
107 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libhashkit/index.html">libhashkit API
</a></li>
109 <p class=
"caption"><span class=
"caption-text">Client Applications
</span></p>
111 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../bin/index.html">Client Applications
</a></li>
113 <p class=
"caption"><span class=
"caption-text">Copyright
</span></p>
115 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../copyright.html">Copyright
</a></li>
125 <section data-toggle=
"wy-nav-shift" class=
"wy-nav-content-wrap">
128 <nav class=
"wy-nav-top" aria-label=
"top navigation">
130 <i data-toggle=
"wy-nav-top" class=
"fa fa-bars"></i>
131 <a href=
"../index.html">libmemcached
</a>
136 <div class=
"wy-nav-content">
138 <div class=
"rst-content">
156 <div role=
"navigation" aria-label=
"breadcrumbs navigation">
158 <ul class=
"wy-breadcrumbs">
160 <li><a href=
"../index.html" class=
"icon icon-home"></a> »</li>
162 <li><a href=
"index.html">libmemcachedutil API
</a> »</li>
164 <li>Working with memcached pools
</li>
167 <li class=
"wy-breadcrumbs-aside">
178 <div role=
"main" class=
"document" itemscope=
"itemscope" itemtype=
"http://schema.org/Article">
179 <div itemprop=
"articleBody">
181 <div class=
"section" id=
"working-with-memcached-pools">
182 <h1>Working with memcached pools
<a class=
"headerlink" href=
"#working-with-memcached-pools" title=
"Permalink to this headline">¶
</a></h1>
183 <div class=
"section" id=
"synopsis">
184 <h2>SYNOPSIS
<a class=
"headerlink" href=
"#synopsis" title=
"Permalink to this headline">¶
</a></h2>
186 <dt>#include
<libmemcachedutil-
1.0/pool.h
></dt><dd><p>Compile and link with -lmemcachedutil -lmemcached
</p>
189 <dl class=
"cpp type">
190 <dt id=
"_CPPv417memcached_pool_st">
191 <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>
194 <dl class=
"cpp function">
195 <dt id=
"_CPPv414memcached_poolPKc6size_t">
196 <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>
197 <dd><dl class=
"field-list simple">
198 <dt class=
"field-odd">Parameters
</dt>
199 <dd class=
"field-odd"><ul class=
"simple">
200 <li><p><strong>option_string
</strong> --
<a class=
"reference internal" href=
"../libmemcached/configuration.html"><span class=
"doc">configuration
</span></a> string
</p></li>
201 <li><p><strong>option_string_length
</strong> -- length of
<code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">options_string
</span></code> without any trailing zero byte
</p></li>
204 <dt class=
"field-even">Returns
</dt>
205 <dd class=
"field-even"><p>allocated and initialized
<a class=
"reference internal" href=
"#_CPPv417memcached_pool_st" title=
"memcached_pool_st"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_pool_st
</span></code></a> instance on success or nullptr on failure
</p>
210 <dl class=
"cpp function">
211 <dt id=
"_CPPv422memcached_pool_destroyP17memcached_pool_st">
212 <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>
213 <dd><dl class=
"field-list simple">
214 <dt class=
"field-odd">Parameters
</dt>
215 <dd class=
"field-odd"><p><strong>pool
</strong> -- initialized
<a class=
"reference internal" href=
"#_CPPv417memcached_pool_st" title=
"memcached_pool_st"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_pool_st
</span></code></a> instance to free
</p>
217 <dt class=
"field-even">Returns
</dt>
218 <dd class=
"field-even"><p>pointer to the 'master'
<a class=
"reference internal" href=
"../libmemcached/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> instance by legacy
</p>
223 <dl class=
"cpp function">
224 <dt id=
"_CPPv420memcached_pool_fetchP17memcached_pool_stP8timespecP18memcached_return_t">
225 <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>pool
</em>,
<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>
226 <dd><div class=
"versionadded">
227 <p><span class=
"versionmodified added">New in version
0.53:
</span>Synonym for memcached_pool_pop
</p>
229 <dl class=
"field-list simple">
230 <dt class=
"field-odd">Parameters
</dt>
231 <dd class=
"field-odd"><ul class=
"simple">
232 <li><p><strong>pool
</strong> -- initialized
<a class=
"reference internal" href=
"#_CPPv417memcached_pool_st" title=
"memcached_pool_st"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_pool_st
</span></code></a> instance
</p></li>
233 <li><p><strong>relative_time
</strong> -- time to block thread and wait for a connection to become available when pool size is exceeded, unless nullptr
</p></li>
234 <li><p><strong>rc
</strong> -- out pointer to
<a class=
"reference internal" href=
"../libmemcached/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></p></li>
237 <dt class=
"field-even">Returns
</dt>
238 <dd class=
"field-even"><p>pointer to an available
<a class=
"reference internal" href=
"../libmemcached/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> instance
</p>
243 <dl class=
"cpp function">
244 <dt id=
"_CPPv422memcached_pool_releaseP17memcached_pool_stP12memcached_st">
245 <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>
246 <dd><div class=
"versionadded">
247 <p><span class=
"versionmodified added">New in version
0.53:
</span>Synonym for memcached_pool_push.
</p>
249 <dl class=
"field-list simple">
250 <dt class=
"field-odd">Parameters
</dt>
251 <dd class=
"field-odd"><ul class=
"simple">
252 <li><p><strong>pool
</strong> -- initialized
<a class=
"reference internal" href=
"#_CPPv417memcached_pool_st" title=
"memcached_pool_st"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_pool_st
</span></code></a> instance
</p></li>
253 <li><p><strong>mmc
</strong> -- the
<a class=
"reference internal" href=
"../libmemcached/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> instance to return to the pool
</p></li>
256 <dt class=
"field-even">Returns
</dt>
257 <dd class=
"field-even"><p><a class=
"reference internal" href=
"../libmemcached/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>
262 <dl class=
"cpp function">
263 <dt id=
"_CPPv427memcached_pool_behavior_setP17memcached_pool_st20memcached_behavior_t8uint64_t">
264 <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>
265 <dd><dl class=
"field-list simple">
266 <dt class=
"field-odd">Parameters
</dt>
267 <dd class=
"field-odd"><ul class=
"simple">
268 <li><p><strong>pool
</strong> -- initialized
<a class=
"reference internal" href=
"#_CPPv417memcached_pool_st" title=
"memcached_pool_st"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_pool_st
</span></code></a> instance
</p></li>
269 <li><p><strong>flag
</strong> -- the
<a class=
"reference internal" href=
"../libmemcached/memcached_behavior.html"><span class=
"doc">behavior
</span></a> to change
</p></li>
270 <li><p><strong>value
</strong> -- the value to set for
<a class=
"reference internal" href=
"#_CPPv427memcached_pool_behavior_setP17memcached_pool_st20memcached_behavior_t8uint64_t" title=
"memcached_pool_behavior_set::flag"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">flag
</span></code></a></p></li>
273 <dt class=
"field-even">Returns
</dt>
274 <dd class=
"field-even"><p><a class=
"reference internal" href=
"../libmemcached/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>
279 <dl class=
"cpp function">
280 <dt id=
"_CPPv427memcached_pool_behavior_getP17memcached_pool_st20memcached_behavior_tP8uint64_t">
281 <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>
282 <dd><dl class=
"field-list simple">
283 <dt class=
"field-odd">Parameters
</dt>
284 <dd class=
"field-odd"><ul class=
"simple">
285 <li><p><strong>pool
</strong> -- initialized
<a class=
"reference internal" href=
"#_CPPv417memcached_pool_st" title=
"memcached_pool_st"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_pool_st
</span></code></a> instance
</p></li>
286 <li><p><strong>flag
</strong> -- the
<a class=
"reference internal" href=
"../libmemcached/memcached_behavior.html"><span class=
"doc">behavior
</span></a> to read
</p></li>
287 <li><p><strong>value
</strong> -- out pointer to receive the set value of
<a class=
"reference internal" href=
"#_CPPv427memcached_pool_behavior_getP17memcached_pool_st20memcached_behavior_tP8uint64_t" title=
"memcached_pool_behavior_get::flag"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">flag
</span></code></a></p></li>
290 <dt class=
"field-even">Returns
</dt>
291 <dd class=
"field-even"><p><a class=
"reference internal" href=
"../libmemcached/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 <dl class=
"cpp function">
297 <dt id=
"_CPPv421memcached_pool_createP12memcached_stii">
298 <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>
299 <dd><div class=
"deprecated">
300 <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-any docutils literal notranslate"><span class=
"pre">memcached_pool()
</span></code></a></p>
304 <dl class=
"cpp function">
305 <dt id=
"_CPPv418memcached_pool_popP17memcached_pool_stbP18memcached_return_t">
306 <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>
307 <dd><div class=
"deprecated">
308 <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-any docutils literal notranslate"><span class=
"pre">memcached_pool_fetch()
</span></code></a></p>
312 <dl class=
"cpp function">
313 <dt id=
"_CPPv419memcached_pool_pushP17memcached_pool_stP12memcached_st">
314 <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>
315 <dd><div class=
"deprecated">
316 <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-any docutils literal notranslate"><span class=
"pre">memcached_pool_release()
</span></code></a></p>
321 <div class=
"section" id=
"description">
322 <h2>DESCRIPTION
<a class=
"headerlink" href=
"#description" title=
"Permalink to this headline">¶
</a></h2>
323 <p><a class=
"reference internal" href=
"#_CPPv414memcached_poolPKc6size_t" title=
"memcached_pool"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_pool()
</span></code></a> is used to create a connection pool of objects you may use to
324 remove the overhead of using memcached_clone for short lived
<a class=
"reference internal" href=
"../libmemcached/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>
325 objects. Please see
<a class=
"reference internal" href=
"../libmemcached/configuration.html"><span class=
"doc">libmemcached Configuration
</span></a> for details on the
326 format of the configuration string.
</p>
327 <p><a class=
"reference internal" href=
"#_CPPv422memcached_pool_destroyP17memcached_pool_st" title=
"memcached_pool_destroy"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_pool_destroy()
</span></code></a> is used to destroy the connection pool created with
328 <a class=
"reference internal" href=
"#_CPPv421memcached_pool_createP12memcached_stii" title=
"memcached_pool_create"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_pool_create()
</span></code></a> and release all allocated resources. It will return the
329 pointer to the
<a class=
"reference internal" href=
"../libmemcached/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> structure passed as an argument to
330 <a class=
"reference internal" href=
"#_CPPv421memcached_pool_createP12memcached_stii" title=
"memcached_pool_create"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_pool_create()
</span></code></a>, and returns the ownership of the pointer to the caller
331 when created with
<a class=
"reference internal" href=
"#_CPPv421memcached_pool_createP12memcached_stii" title=
"memcached_pool_create"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_pool_create()
</span></code></a>, otherwise NULL is returned..
</p>
332 <p><a class=
"reference internal" href=
"#_CPPv420memcached_pool_fetchP17memcached_pool_stP8timespecP18memcached_return_t" title=
"memcached_pool_fetch"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_pool_fetch()
</span></code></a> is used to fetch a connection structure from the
333 connection pool. The relative_time argument specifies if the function should
334 block and wait for a connection structure to be available if we try to exceed
335 the maximum size. You need to specify time in relative time.
</p>
336 <p><a class=
"reference internal" href=
"#_CPPv422memcached_pool_releaseP17memcached_pool_stP12memcached_st" title=
"memcached_pool_release"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_pool_release()
</span></code></a> is used to return a connection structure back to the
338 <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-any 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-any docutils literal notranslate"><span class=
"pre">memcached_pool_behavior_set()
</span></code></a> is used to
339 get/set behavior flags on all connections in the pool.
</p>
340 <p>Both
<a class=
"reference internal" href=
"#_CPPv422memcached_pool_releaseP17memcached_pool_stP12memcached_st" title=
"memcached_pool_release"><code class=
"xref cpp cpp-any 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-any docutils literal notranslate"><span class=
"pre">memcached_pool_fetch()
</span></code></a> are thread safe.
</p>
342 <div class=
"section" id=
"return-value">
343 <h2>RETURN VALUE
<a class=
"headerlink" href=
"#return-value" title=
"Permalink to this headline">¶
</a></h2>
344 <p><a class=
"reference internal" href=
"#_CPPv422memcached_pool_destroyP17memcached_pool_st" title=
"memcached_pool_destroy"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_pool_destroy()
</span></code></a> returns the pointer (and ownership) to the
345 <a class=
"reference internal" href=
"../libmemcached/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> structure used to create the pool. If connections are in use it
347 <p><a class=
"reference internal" href=
"#_CPPv418memcached_pool_popP17memcached_pool_stbP18memcached_return_t" title=
"memcached_pool_pop"><code class=
"xref cpp cpp-any 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-any docutils literal notranslate"><span class=
"pre">memcached_st
</span></code></a> structure from the
348 pool (or NULL if an allocation cannot be satisfied).
</p>
349 <p><a class=
"reference internal" href=
"#_CPPv422memcached_pool_releaseP17memcached_pool_stP12memcached_st" title=
"memcached_pool_release"><code class=
"xref cpp cpp-any 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>
350 <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-any 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-any docutils literal notranslate"><span class=
"pre">memcached_pool_behavior_get()
</span></code></a> return
351 <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>
352 <p><a class=
"reference internal" href=
"#_CPPv420memcached_pool_fetchP17memcached_pool_stP8timespecP18memcached_return_t" title=
"memcached_pool_fetch"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_pool_fetch()
</span></code></a> may return
<a class=
"reference internal" href=
"../libmemcached/memcached_return_t.html#_CPPv4N18memcached_return_t17MEMCACHED_TIMEOUTE" title=
"MEMCACHED_TIMEOUT"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">MEMCACHED_TIMEOUT
</span></code></a> if a timeout occurs while
353 waiting for a free
<a class=
"reference internal" href=
"../libmemcached/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> instance,
<a class=
"reference internal" href=
"../libmemcached/memcached_return_t.html#_CPPv4N18memcached_return_t18MEMCACHED_NOTFOUNDE" title=
"MEMCACHED_NOTFOUND"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">MEMCACHED_NOTFOUND
</span></code></a> if no
<a class=
"reference internal" href=
"../libmemcached/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>
354 instance was available, respectively.
</p>
355 <div class=
"admonition note">
356 <p class=
"admonition-title">Note
</p>
357 <p>If any method returns
<code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">MEMCACHED_IN_PROGRESS
</span></code> then a lock on the pool could not
359 <p>If any of the parameters passed to any of these functions is
360 invalid,
<a class=
"reference internal" href=
"../libmemcached/memcached_return_t.html#_CPPv4N18memcached_return_t27MEMCACHED_INVALID_ARGUMENTSE" title=
"MEMCACHED_INVALID_ARGUMENTS"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">MEMCACHED_INVALID_ARGUMENTS
</span></code></a> will be returned.
</p>
363 <div class=
"section" id=
"see-also">
364 <h2>SEE ALSO
<a class=
"headerlink" href=
"#see-also" title=
"Permalink to this headline">¶
</a></h2>
366 <li><p><em class=
"manpage"><a class=
"manpage reference external" href=
"https://linux.die.net/man/1/memcached">memcached(
1)
</a></em></p></li>
367 <li><p><a class=
"reference internal" href=
"../libmemcached.html"><span class=
"doc">C/C++ Client Library for memcached
</span></a></p></li>
368 <li><p><a class=
"reference internal" href=
"../libmemcached/configuration.html"><span class=
"doc">libmemcached Configuration
</span></a></p></li>
369 <li><p><a class=
"reference internal" href=
"../libmemcached/memcached_strerror.html"><span class=
"doc">Converting Error Codes to Messages
</span></a></p></li>
380 <div class=
"rst-footer-buttons" role=
"navigation" aria-label=
"footer navigation">
382 <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>
385 <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>
392 <div role=
"contentinfo">
396 © <a href=
"../copyright.html">Copyright
</a>
403 Built with
<a href=
"http://sphinx-doc.org/">Sphinx
</a> using a
405 <a href=
"https://github.com/rtfd/sphinx_rtd_theme">theme
</a>
407 provided by
<a href=
"https://readthedocs.org">Read the Docs
</a>.
419 <script type=
"text/javascript">
421 SphinxRtdTheme.Navigation.enable(true);