| <!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: apache::geode::client::PoolManager Class Reference</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('a00795.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="summary"> |
| <a href="#pub-methods">Public Member Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">apache::geode::client::PoolManager Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Manages creation and access to <a class="el" href="a00787.html">connection pools</a> for clients. |
| <a href="a00795.html#details">More...</a></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a5e41e42afc795c527c89a70ba37726d5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00795.html#a5e41e42afc795c527c89a70ba37726d5">close</a> (bool keepAlive=false)</td></tr> |
| <tr class="memdesc:a5e41e42afc795c527c89a70ba37726d5"><td class="mdescLeft"> </td><td class="mdescRight">Unconditionally destroys all created pools that are in this manager. <a href="#a5e41e42afc795c527c89a70ba37726d5">More...</a><br /></td></tr> |
| <tr class="separator:a5e41e42afc795c527c89a70ba37726d5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a61497d072b714f82ae7d5ffb6ab6e79e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00791.html">PoolFactory</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00795.html#a61497d072b714f82ae7d5ffb6ab6e79e">createFactory</a> () const</td></tr> |
| <tr class="memdesc:a61497d072b714f82ae7d5ffb6ab6e79e"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new <a class="el" href="a00791.html">pool factory</a>, which is used to configure and create new <a class="el" href="a00787.html">Pool</a>s. <a href="#a61497d072b714f82ae7d5ffb6ab6e79e">More...</a><br /></td></tr> |
| <tr class="separator:a61497d072b714f82ae7d5ffb6ab6e79e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac4608378f6e787bacab2873d3eb8ce0f"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="a00787.html">Pool</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00795.html#ac4608378f6e787bacab2873d3eb8ce0f">find</a> (const std::string &name) const</td></tr> |
| <tr class="memdesc:ac4608378f6e787bacab2873d3eb8ce0f"><td class="mdescLeft"> </td><td class="mdescRight">Find by name an existing connection pool returning the existing pool or <code>nullptr</code> if it does not exist. <a href="#ac4608378f6e787bacab2873d3eb8ce0f">More...</a><br /></td></tr> |
| <tr class="separator:ac4608378f6e787bacab2873d3eb8ce0f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a07ebafa23646e94ac27004f2e0fecd93"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="a00787.html">Pool</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00795.html#a07ebafa23646e94ac27004f2e0fecd93">find</a> (const std::shared_ptr< <a class="el" href="a00815.html">Region</a> > &region) const</td></tr> |
| <tr class="memdesc:a07ebafa23646e94ac27004f2e0fecd93"><td class="mdescLeft"> </td><td class="mdescRight">Find the pool used by the given region. <a href="#a07ebafa23646e94ac27004f2e0fecd93">More...</a><br /></td></tr> |
| <tr class="separator:a07ebafa23646e94ac27004f2e0fecd93"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad015296ccdbf992ec6fa3d41a4996afe"><td class="memItemLeft" align="right" valign="top">const HashMapOfPools & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00795.html#ad015296ccdbf992ec6fa3d41a4996afe">getAll</a> () const</td></tr> |
| <tr class="memdesc:ad015296ccdbf992ec6fa3d41a4996afe"><td class="mdescLeft"> </td><td class="mdescRight">Returns a map containing all the pools in this manager. <a href="#ad015296ccdbf992ec6fa3d41a4996afe">More...</a><br /></td></tr> |
| <tr class="separator:ad015296ccdbf992ec6fa3d41a4996afe"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Manages creation and access to <a class="el" href="a00787.html">connection pools</a> for clients. </p> |
| <p>To create a pool get a factory by calling <a class="el" href="a00795.html#a61497d072b714f82ae7d5ffb6ab6e79e">createFactory</a>. </p> |
| <p>To find an existing pool by name call <a class="el" href="a00795.html#ac4608378f6e787bacab2873d3eb8ce0f">find</a>. </p> |
| <p>To get rid of all created pools call <a class="el" href="a00795.html#a5e41e42afc795c527c89a70ba37726d5">close</a>. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a5e41e42afc795c527c89a70ba37726d5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5e41e42afc795c527c89a70ba37726d5">◆ </a></span>close()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void apache::geode::client::PoolManager::close </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>keepAlive</em> = <code>false</code></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Unconditionally destroys all created pools that are in this manager. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">keepAlive</td><td>defines whether the server should keep the durable client's subscriptions alive for the <code>durable-client-timeout</code>. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section see"><dt>See also</dt><dd>DistributedSystem::connect for a description of <code>durable-client-timeout</code>. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a61497d072b714f82ae7d5ffb6ab6e79e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a61497d072b714f82ae7d5ffb6ab6e79e">◆ </a></span>createFactory()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="a00791.html">PoolFactory</a> apache::geode::client::PoolManager::createFactory </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Creates a new <a class="el" href="a00791.html">pool factory</a>, which is used to configure and create new <a class="el" href="a00787.html">Pool</a>s. </p> |
| <dl class="section return"><dt>Returns</dt><dd>the new pool factory </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ac4608378f6e787bacab2873d3eb8ce0f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac4608378f6e787bacab2873d3eb8ce0f">◆ </a></span>find() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::shared_ptr<<a class="el" href="a00787.html">Pool</a>> apache::geode::client::PoolManager::find </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>name</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Find by name an existing connection pool returning the existing pool or <code>nullptr</code> if it does not exist. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>is the name of the connection pool </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the existing connection pool or <code>nullptr</code> if it does not exist. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a07ebafa23646e94ac27004f2e0fecd93"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a07ebafa23646e94ac27004f2e0fecd93">◆ </a></span>find() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::shared_ptr<<a class="el" href="a00787.html">Pool</a>> apache::geode::client::PoolManager::find </td> |
| <td>(</td> |
| <td class="paramtype">const std::shared_ptr< <a class="el" href="a00815.html">Region</a> > & </td> |
| <td class="paramname"><em>region</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Find the pool used by the given region. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">region</td><td>is the region that is using the pool. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the pool used by that region or <code> nullptr </code> if the region does not have a pool. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ad015296ccdbf992ec6fa3d41a4996afe"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad015296ccdbf992ec6fa3d41a4996afe">◆ </a></span>getAll()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const HashMapOfPools& apache::geode::client::PoolManager::getAll </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns a map containing all the pools in this manager. </p> |
| <p>The keys are pool names and the values are <a class="el" href="a00787.html">Pool</a> instances. </p> |
| <p>The map contains the pools that this manager knows of at the time of this call. The map is free to be changed without affecting this manager. </p><dl class="section return"><dt>Returns</dt><dd>a Map that is a snapshot of all the pools currently known to this manager. </dd></dl> |
| |
| </div> |
| </div> |
| </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> |
