| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.15"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Apache Geode Native C++ Reference: Pool.hpp Source File</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript" src="navtreedata.js"></script> |
| <script type="text/javascript" src="navtree.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(initResizable); |
| /* @license-end */</script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">Apache Geode Native C++ Reference |
|  <span id="projectnumber">1.13.1</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.15 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></div> |
| </div><!-- top --> |
| <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| <div id="nav-tree"> |
| <div id="nav-tree-contents"> |
| <div id="nav-sync" class="sync"></div> |
| </div> |
| </div> |
| <div id="splitbar" style="-moz-user-select:none;" |
| class="ui-resizable-handle"> |
| </div> |
| </div> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('a00185_source.html','');}); |
| /* @license-end */ |
| </script> |
| <div id="doc-content"> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">Pool.hpp</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="a00185.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * this work for additional information regarding copyright ownership.</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * (the "License"); you may not use this file except in compliance with</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * limitations under the License.</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> */</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef GEODE_POOL_H_</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define GEODE_POOL_H_</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <chrono></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <iosfwd></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="a00023.html">Cache.hpp</a>"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "<a class="code" href="a00050.html">CacheFactory.hpp</a>"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "<a class="code" href="a00026.html">CacheableBuiltins.hpp</a>"</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include "internal/chrono/duration.hpp"</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "internal/geode_base.hpp"</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include "internal/geode_globals.hpp"</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">namespace </span>apache {</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">namespace </span>geode {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">namespace </span>client {</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">class </span>AuthenticatedView;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">class </span>Cache;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">class </span>CacheFactory;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">class </span>PoolAttributes;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">class </span>CacheImpl;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">class </span>Properties;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">class </span>QueryService;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="a00787.html"> 63</a></span> <span class="keyword">class </span>APACHE_GEODE_EXPORT <a class="code" href="a00787.html">Pool</a> : <span class="keyword">public</span> std::enable_shared_from_this<Pool> {</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">virtual</span> <span class="keyword">const</span> std::string& getName() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  std::chrono::milliseconds getFreeConnectionTimeout() <span class="keyword">const</span>;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  std::chrono::milliseconds getLoadConditioningInterval() <span class="keyword">const</span>;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordtype">int</span> getSocketBufferSize() <span class="keyword">const</span>;</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  std::chrono::milliseconds getReadTimeout() <span class="keyword">const</span>;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordtype">int</span> getMinConnections() <span class="keyword">const</span>;</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keywordtype">int</span> getMaxConnections() <span class="keyword">const</span>;</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> </div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  std::chrono::milliseconds getIdleTimeout() <span class="keyword">const</span>;</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  std::chrono::milliseconds getPingInterval() <span class="keyword">const</span>;</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  std::chrono::milliseconds getUpdateLocatorListInterval() <span class="keyword">const</span>;</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> </div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  std::chrono::milliseconds getStatisticInterval() <span class="keyword">const</span>;</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keywordtype">int</span> getRetryAttempts() <span class="keyword">const</span>;</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <span class="keywordtype">bool</span> getSubscriptionEnabled() <span class="keyword">const</span>;</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> </div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <span class="keywordtype">int</span> getSubscriptionRedundancy() <span class="keyword">const</span>;</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> </div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  std::chrono::milliseconds getSubscriptionMessageTrackingTimeout() <span class="keyword">const</span>;</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> </div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  std::chrono::milliseconds getSubscriptionAckInterval() <span class="keyword">const</span>;</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> </div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  <span class="keyword">const</span> std::string& getServerGroup() <span class="keyword">const</span>;</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> </div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  <span class="keywordtype">bool</span> getThreadLocalConnections() <span class="keyword">const</span>;</div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> </div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  <span class="keywordtype">bool</span> getMultiuserAuthentication() <span class="keyword">const</span>;</div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span> </div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  <span class="keywordtype">bool</span> getPRSingleHopEnabled() <span class="keyword">const</span>;</div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> </div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> releaseThreadLocalConnection() = 0;</div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span> </div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  <span class="keyword">virtual</span> <span class="keyword">const</span> std::shared_ptr<CacheableStringArray> getLocators() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span> </div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  <span class="keyword">virtual</span> <span class="keyword">const</span> std::shared_ptr<CacheableStringArray> getServers() = 0;</div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span> </div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> destroy(<span class="keywordtype">bool</span> keepAlive = <span class="keyword">false</span>) = 0;</div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span> </div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> isDestroyed() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span> </div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span>  <span class="keyword">virtual</span> std::shared_ptr<QueryService> getQueryService() = 0;</div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span> </div><div class="line"><a name="l00250"></a><span class="lineno"> 250</span>  <span class="keyword">virtual</span> ~<a class="code" href="a00787.html">Pool</a>();</div><div class="line"><a name="l00251"></a><span class="lineno"> 251</span> </div><div class="line"><a name="l00284"></a><span class="lineno"> 284</span>  <span class="keywordtype">int</span> getPendingEventCount() <span class="keyword">const</span>;</div><div class="line"><a name="l00285"></a><span class="lineno"> 285</span> </div><div class="line"><a name="l00286"></a><span class="lineno"> 286</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00287"></a><span class="lineno"> 287</span>  <span class="keyword">explicit</span> <a class="code" href="a00787.html">Pool</a>(std::shared_ptr<PoolAttributes> attr);</div><div class="line"><a name="l00288"></a><span class="lineno"> 288</span>  std::shared_ptr<PoolAttributes> m_attrs;</div><div class="line"><a name="l00289"></a><span class="lineno"> 289</span> </div><div class="line"><a name="l00290"></a><span class="lineno"> 290</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00301"></a><span class="lineno"> 301</span>  <span class="keyword">virtual</span> <a class="code" href="a00279.html">AuthenticatedView</a> createAuthenticatedView(</div><div class="line"><a name="l00302"></a><span class="lineno"> 302</span>  std::shared_ptr<Properties> credentials, CacheImpl* cacheImpl);</div><div class="line"><a name="l00303"></a><span class="lineno"> 303</span> </div><div class="line"><a name="l00304"></a><span class="lineno"> 304</span>  <a class="code" href="a00787.html">Pool</a>(<span class="keyword">const</span> <a class="code" href="a00787.html">Pool</a>&);</div><div class="line"><a name="l00305"></a><span class="lineno"> 305</span> </div><div class="line"><a name="l00306"></a><span class="lineno"> 306</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="a00791.html">PoolFactory</a>;</div><div class="line"><a name="l00307"></a><span class="lineno"> 307</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="a00371.html">CacheFactory</a>;</div><div class="line"><a name="l00308"></a><span class="lineno"> 308</span>  <span class="keyword">friend</span> <span class="keyword">class </span>CacheImpl;</div><div class="line"><a name="l00309"></a><span class="lineno"> 309</span> };</div><div class="line"><a name="l00310"></a><span class="lineno"> 310</span> </div><div class="line"><a name="l00311"></a><span class="lineno"> 311</span> } <span class="comment">// namespace client</span></div><div class="line"><a name="l00312"></a><span class="lineno"> 312</span> } <span class="comment">// namespace geode</span></div><div class="line"><a name="l00313"></a><span class="lineno"> 313</span> } <span class="comment">// namespace apache</span></div><div class="line"><a name="l00314"></a><span class="lineno"> 314</span> </div><div class="line"><a name="l00315"></a><span class="lineno"> 315</span> <span class="preprocessor">#endif // GEODE_POOL_H_</span></div><div class="ttc" id="a00791_html"><div class="ttname"><a href="a00791.html">apache::geode::client::PoolFactory</a></div><div class="ttdoc">This interface provides for the configuration and creation of instances of Pool.</div><div class="ttdef"><b>Definition:</b> PoolFactory.hpp:68</div></div> |
| <div class="ttc" id="a00023_html"><div class="ttname"><a href="a00023.html">Cache.hpp</a></div></div> |
| <div class="ttc" id="a00050_html"><div class="ttname"><a href="a00050.html">CacheFactory.hpp</a></div></div> |
| <div class="ttc" id="a00279_html"><div class="ttname"><a href="a00279.html">apache::geode::client::AuthenticatedView</a></div><div class="ttdoc">Creates an authenticated cache view to allow credential based access to region services.</div><div class="ttdef"><b>Definition:</b> AuthenticatedView.hpp:46</div></div> |
| <div class="ttc" id="a00787_html"><div class="ttname"><a href="a00787.html">apache::geode::client::Pool</a></div><div class="ttdoc">A pool of connections to connect from a client to a set of Geode Cache Servers.</div><div class="ttdef"><b>Definition:</b> Pool.hpp:63</div></div> |
| <div class="ttc" id="a00026_html"><div class="ttname"><a href="a00026.html">CacheableBuiltins.hpp</a></div><div class="ttdoc">Contains generic template definitions for Cacheable types and instantiations for built-in types.</div></div> |
| <div class="ttc" id="a00371_html"><div class="ttname"><a href="a00371.html">apache::geode::client::CacheFactory</a></div><div class="ttdoc">Top level class for configuring and using Geode on a client.This should be called once to create Cach...</div><div class="ttdef"><b>Definition:</b> CacheFactory.hpp:48</div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| http://www.apache.org/licenses/LICENSE-2.0 |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| --> |
| <HR><address style="align: right;"><small>Apache Geode C++ Cache API Documentation</small></address> |