blob: 3758dbe162771abd4f5044a78cb3a8e54423beef [file] [log] [blame]
<!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 .NET 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&amp;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 .NET Reference
&#160;<span id="projectnumber">1.13.0</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&amp;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&amp;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&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('a01078.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>This interface provides for the configuration and creation of instances of <a class="el" href="a01074.html" title="This interface provides for the configuration and creation of instances of Pool.">PoolFactory</a>.
<a href="a01078.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:a90b9384d4329209c55e58d5f80ba1c7d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01078.html#a90b9384d4329209c55e58d5f80ba1c7d">Close</a> (Boolean KeepAlive)</td></tr>
<tr class="memdesc:a90b9384d4329209c55e58d5f80ba1c7d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys all created pools. <a href="#a90b9384d4329209c55e58d5f80ba1c7d">More...</a><br /></td></tr>
<tr class="separator:a90b9384d4329209c55e58d5f80ba1c7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c516526a3e55b4d7fcf6275e73c5c45"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01078.html#a1c516526a3e55b4d7fcf6275e73c5c45">Close</a> ()</td></tr>
<tr class="memdesc:a1c516526a3e55b4d7fcf6275e73c5c45"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys all created pools. <a href="#a1c516526a3e55b4d7fcf6275e73c5c45">More...</a><br /></td></tr>
<tr class="separator:a1c516526a3e55b4d7fcf6275e73c5c45"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a36a85202133bcfb6d1f71e5250e51af4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a01074.html">PoolFactory</a> ^&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01078.html#a36a85202133bcfb6d1f71e5250e51af4">CreateFactory</a> ()</td></tr>
<tr class="memdesc:a36a85202133bcfb6d1f71e5250e51af4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new <a class="el" href="a01074.html" title="This interface provides for the configuration and creation of instances of Pool.">PoolFactory</a> which is used to configure and create Pools. <a href="#a36a85202133bcfb6d1f71e5250e51af4">More...</a><br /></td></tr>
<tr class="separator:a36a85202133bcfb6d1f71e5250e51af4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad7bf770c82823801c44db5e7e5de6eed"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a01070.html">Pool</a> ^&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01078.html#ad7bf770c82823801c44db5e7e5de6eed">Find</a> (String^ name)</td></tr>
<tr class="memdesc:ad7bf770c82823801c44db5e7e5de6eed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find by name an existing connection pool. <a href="#ad7bf770c82823801c44db5e7e5de6eed">More...</a><br /></td></tr>
<tr class="separator:ad7bf770c82823801c44db5e7e5de6eed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af8660489e268a53761db260e5bda4246"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a01070.html">Pool</a> ^&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01078.html#af8660489e268a53761db260e5bda4246">Find</a> (Client::Region&lt; Object^, Object^&gt;^ region)</td></tr>
<tr class="memdesc:af8660489e268a53761db260e5bda4246"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find the pool used by the given region. <a href="#af8660489e268a53761db260e5bda4246">More...</a><br /></td></tr>
<tr class="separator:af8660489e268a53761db260e5bda4246"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afbc4919559fb1f753897c7a6948ccc07"><td class="memItemLeft" align="right" valign="top">const Dictionary&lt; String^, <a class="el" href="a01070.html">Pool</a>^&gt; ^&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01078.html#afbc4919559fb1f753897c7a6948ccc07">GetAll</a> ()</td></tr>
<tr class="memdesc:afbc4919559fb1f753897c7a6948ccc07"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a map containing all the pools in this manager. <a href="#afbc4919559fb1f753897c7a6948ccc07">More...</a><br /></td></tr>
<tr class="separator:afbc4919559fb1f753897c7a6948ccc07"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This interface provides for the configuration and creation of instances of <a class="el" href="a01074.html" title="This interface provides for the configuration and creation of instances of Pool.">PoolFactory</a>. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a90b9384d4329209c55e58d5f80ba1c7d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a90b9384d4329209c55e58d5f80ba1c7d">&#9670;&nbsp;</a></span>Close() <span class="overload">[1/2]</span></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">Boolean&#160;</td>
<td class="paramname"><em>KeepAlive</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroys all created pools. </p>
</div>
</div>
<a id="a1c516526a3e55b4d7fcf6275e73c5c45"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c516526a3e55b4d7fcf6275e73c5c45">&#9670;&nbsp;</a></span>Close() <span class="overload">[2/2]</span></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="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroys all created pools. </p>
</div>
</div>
<a id="a36a85202133bcfb6d1f71e5250e51af4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a36a85202133bcfb6d1f71e5250e51af4">&#9670;&nbsp;</a></span>CreateFactory()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a01074.html">PoolFactory</a> ^ Apache::Geode::Client::PoolManager::CreateFactory </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new <a class="el" href="a01074.html" title="This interface provides for the configuration and creation of instances of Pool.">PoolFactory</a> which is used to configure and create Pools. </p>
</div>
</div>
<a id="ad7bf770c82823801c44db5e7e5de6eed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7bf770c82823801c44db5e7e5de6eed">&#9670;&nbsp;</a></span>Find() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a01070.html">Pool</a> ^ Apache::Geode::Client::PoolManager::Find </td>
<td>(</td>
<td class="paramtype">String^&#160;</td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Find by name an existing connection pool. </p>
</div>
</div>
<a id="af8660489e268a53761db260e5bda4246"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af8660489e268a53761db260e5bda4246">&#9670;&nbsp;</a></span>Find() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a01070.html">Pool</a> ^ Apache::Geode::Client::PoolManager::Find </td>
<td>(</td>
<td class="paramtype">Client::Region&lt; Object^, Object^&gt;^&#160;</td>
<td class="paramname"><em>region</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Find the pool used by the given region. </p>
</div>
</div>
<a id="afbc4919559fb1f753897c7a6948ccc07"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afbc4919559fb1f753897c7a6948ccc07">&#9670;&nbsp;</a></span>GetAll()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const Dictionary&lt;String^, <a class="el" href="a01070.html">Pool</a>^&gt; ^ Apache::Geode::Client::PoolManager::GetAll </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></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="a01070.html" title="A pool of connections.">Pool</a> instances. </p>
</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 .NET API Documentation</small></address>