docs/geode-native/cpp/113/connection-pools/client-pool-api.html - geode-site - Git at Google

 <!doctype html>
 <html>
 <head>
   <meta charset="utf-8">
   <!-- Always force latest IE rendering engine or request Chrome Frame -->
   <meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible">


   <link href='https://fonts.googleapis.com/css?family=Source+Sans+Pro:300,300italic,400italic,400,600' rel='stylesheet' type='text/css'>
   <!-- Use title if it's in the page YAML frontmatter -->
   <title>
       Native Client Pool API |
     Geode Native C++ Docs
   </title>
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   <link href="/stylesheets/all.css" rel="stylesheet" media="screen, print" />
   <link href="/stylesheets/print.css" rel="stylesheet" media="print" />
   <link href='/images/favicon.ico' rel='shortcut icon'>

   <script src="/javascripts/all.js"></script>

 </head>

 <body class="docs docs_geode-native docs_geode-native_cpp docs_geode-native_cpp_113 docs_geode-native_cpp_113_connection-pools docs_geode-native_cpp_113_connection-pools_client-pool-api has-subnav">

 <div class="viewport">
   <div class='wrap'>
     <script type="text/javascript">
       document.domain = "apache.org";
     </script>

     <!--
 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.
 -->
 <header class="header header-layout">
   <h1 class="logo">
     <a href="/">
         <img src="/images/Apache_Geode_logo_symbol_white.png" style="width:30px;">
       Apache Geode Native C++ Documentation
     </a>
   </h1>
   <div class="header-links js-bar-links">
     <div class="btn-menu" data-behavior="MenuMobile"></div>
     <div class="header-item"><a href="http://geode.apache.org">Back to Product Page</a></div>
     <div class="header-item">
       <a href="http://geode.apache.org/community" target="_blank">Community</a>
     </div>
   </div>
 </header>


     <div class="container">

       <!--googleoff: index-->
       <!--
 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.
 -->
 <div id="sub-nav" class="js-sidenav nav-container" role="navigation">
 <a class="sidenav-title" data-behavior="SubMenuMobile">Doc Index</a>
   <div class="nav-content">
   <ul>
     <li>
       <a href="/docs/geode-native/cpp/113/about-client-users-guide.html">Apache Geode Native Documentation</a>
     </li>
     <li class="has_submenu">
       <a href="/docs/geode-native/cpp/113/getting-started/getting-started-nc-client.html">Getting Started with the Native Library</a>
       <ul>
         <li>
           <a href="/docs/geode-native/cpp/113/getting-started/getting-started-nc-client.html#set_up_dev_environment">Set Up Your Development Environment</a>
         </li>
         <li>
           <a href="/docs/geode-native/cpp/113/getting-started/getting-started-nc-client.html#establish_cluster_access">Establish Access to a Geode Cluster</a>
         </li>
         <li>
           <a href="/docs/geode-native/cpp/113/getting-started/getting-started-nc-client.html#app_dev_walkthroughs">Application Development Walkthroughs</a>
         </li>
         <li>
           <a href="/docs/geode-native/cpp/113/getting-started/getting-started-nc-client.html#programming_examples">Programming Examples</a>
         </li>
         <li>
           <a href="/docs/geode-native/cpp/113/getting-started/put-get-example.html">Put/Get/Remove Examples</a>
         </li>
       </ul>
     </li>
     <li class="has_submenu">
       <a href="/docs/geode-native/cpp/113/configuring/configuration.html">Configuring a Client Application</a>
       <ul>
         <li>
           <a href="/docs/geode-native/cpp/113/configuring/system-level-configuration.html">System Level Configuration</a>
         </li>
       </ul>
     </li>

     <li>
       <a href="/docs/geode-native/cpp/113/configuring/config-client-cache.html">Configuring the Client Cache</a>
     </li>
     <li class="has_submenu">
       <a href="/docs/geode-native/cpp/113/regions/regions.html">Configuring Regions</a>
       <ul>
         <li>
         <a href="/docs/geode-native/cpp/113/regions/registering-interest-for-entries.html">Registering Interest for Entries</a>
         </li>
         <li>
         <a href="/docs/geode-native/cpp/113/regions/region-attributes.html">Region Attributes</a>
         </li>
       </ul>
     </li>

     <li class="has_submenu">
         <a href="/docs/geode-native/cpp/113/connection-pools/configuring-pools.html">Configuring Pools</a>
         <ul>
             <li>
                 <a href="/docs/geode-native/cpp/113/connection-pools/client-pool-api.html">Native Client Pool API</a>
             </li>
             <li>
                 <a href="/docs/geode-native/cpp/113/connection-pools/configuring-pools-attributes-example.html">Pool Configuration Example and Settings</a>
             </li>
             <li>
                 <a href="/docs/geode-native/cpp/113/connection-pools/subscription-properties.html">Subscription Properties</a>
             </li>
         </ul>
     </li>

     <li>
       <a href="/docs/geode-native/cpp/113/serialization/data-serialization.html">Serializing Data</a>
     </li>

     <li>
       <a href="/docs/geode-native/cpp/113/remote-queries.html">Remote Queries</a>
     </li>

     <li>
       <a href="/docs/geode-native/cpp/113/continuous-queries.html">Continuous Queries</a>
     </li>

     <li class="has_submenu">
       <a href="/docs/geode-native/cpp/113/security/security.html">Security: Authentication and Encryption</a>
       <ul>
         <li>
         <a href="/docs/geode-native/cpp/113/security/authentication.html">Authentication</a>
         </li>
         <li>
         <a href="/docs/geode-native/cpp/113/security/sslclientserver.html">TLS/SSL Client-Server Communication Encryption</a>
         </li>
       </ul>
     </li>

     <li>
       <a href="/docs/geode-native/cpp/113/function-execution.html">Function Execution</a>
     </li>

     <li>
       <a href="/docs/geode-native/cpp/113/transactions.html">Transactions</a>
     </li>
     <li>
       <a href="/docs/geode-native/cpp/113/configuring/sysprops.html">System Properties</a>
     </li>
     <li>
       <a href="/docs/geode-native/cpp/113/client-cache-ref.html">Client Cache XML Reference</a>
     </li>
   </ul>
   </div>
 </div>

       <!--googleon: index-->

       <main class="content content-layout" id="js-content" role="main">
         <a id="top"></a>
         <!--
 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.
 -->
 <span style="font-weight:200;font-size:31px;" style="float:left;">
     <img src="/images/Apache_Geode_logo_symbol.png" style="height:26px;">
   Apache Geode Native C++
 </span>
   <span class="local-header version-info" style="float:right;">
     <a href="https://cwiki.apache.org/confluence/display/GEODE/Release+Notes">CHANGELOG</a>
   </span>

         <!--
 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.
 -->
   <h1 class="title-container" >
     Native Client Pool API
   </h1>

           <div id="js-quick-links" >

           </div>
         <div class="to-top" id="js-to-top">
           <a href="#top" title="back to top"></a>
         </div>
         <!--
 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.
 -->

 <p>The native client API allows your clients to create and manage connection pools. The server side does not have an API.</p>

 <p>The primary native client API for pool management is <code>Apache.Geode.Client.Cache</code>. For complete information on the classes and interfaces described here, see the API documentation.</p>

 <p><strong>Apache.Geode.Client.Cache</strong></p>

 <ul>
 <li>  <code>Pool</code> interface. API to retrieve pool attributes.</li>
 <li>  <code>PoolFactory</code> interface. API to configure pool attributes.</li>
 <li>  <code>PoolManager</code> interface. API to create a <code>PoolFactory</code> object and to find the pool objects.</li>
 <li>  <code>AttributesFactory</code> class. Has a new method <code>setPoolname</code> which assigns a pool to a region. Operations performed on the configured region use connections from the pool.</li>
 </ul>

 <p><strong>Note:</strong>
 A region can have a pool attached to it. A pool may have multiple regions attached to it.</p>


       </main>
     </div>
   </div>
 </div>

 <div id="scrim"></div>

 <div class="container">
   <footer class="site-footer-links">
     <!--
 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.
 -->
 <div class="copyright">
   <a href='/'>Apache Geode Documentation</a>
   &copy; 2021 <a href='http://www.apache.org/'>The Apache Software Foundation</a>.
 </div>
 <div class="support">
   Need help? <a href="http://geode.apache.org/community" target="_blank">Visit the Community</a>
 </div>

   </footer>
 </div><!--end of container-->

 </body>
 </html>
	<!doctype html>
	<html>
	<head>
	<meta charset="utf-8">
	<!-- Always force latest IE rendering engine or request Chrome Frame -->
	<meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible">


	<link href='https://fonts.googleapis.com/css?family=Source+Sans+Pro:300,300italic,400italic,400,600' rel='stylesheet' type='text/css'>
	<!-- Use title if it's in the page YAML frontmatter -->
	<title>
	Native Client Pool API \|
	Geode Native C++ Docs
	</title>
	<meta name="viewport" content="width=device-width, initial-scale=1.0">
	<link href="/stylesheets/all.css" rel="stylesheet" media="screen, print" />
	<link href="/stylesheets/print.css" rel="stylesheet" media="print" />
	<link href='/images/favicon.ico' rel='shortcut icon'>

	<script src="/javascripts/all.js"></script>

	</head>

	<body class="docs docs_geode-native docs_geode-native_cpp docs_geode-native_cpp_113 docs_geode-native_cpp_113_connection-pools docs_geode-native_cpp_113_connection-pools_client-pool-api has-subnav">

	<div class="viewport">
	<div class='wrap'>
	<script type="text/javascript">
	document.domain = "apache.org";
	</script>

	<!--
	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.
	-->
	<header class="header header-layout">
	<h1 class="logo">
	<a href="/">
	<img src="/images/Apache_Geode_logo_symbol_white.png" style="width:30px;">
	Apache Geode Native C++ Documentation
	</a>
	</h1>
	<div class="header-links js-bar-links">
	<div class="btn-menu" data-behavior="MenuMobile"></div>
	<div class="header-item"><a href="http://geode.apache.org">Back to Product Page</a></div>
	<div class="header-item">
	<a href="http://geode.apache.org/community" target="_blank">Community</a>
	</div>
	</div>
	</header>


	<div class="container">

	<!--googleoff: index-->
	<!--
	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.
	-->
	<div id="sub-nav" class="js-sidenav nav-container" role="navigation">
	<a class="sidenav-title" data-behavior="SubMenuMobile">Doc Index</a>
	<div class="nav-content">
	<ul>
	<li>
	<a href="/docs/geode-native/cpp/113/about-client-users-guide.html">Apache Geode Native Documentation</a>
	</li>
	<li class="has_submenu">
	<a href="/docs/geode-native/cpp/113/getting-started/getting-started-nc-client.html">Getting Started with the Native Library</a>
	<ul>
	<li>
	<a href="/docs/geode-native/cpp/113/getting-started/getting-started-nc-client.html#set_up_dev_environment">Set Up Your Development Environment</a>
	</li>
	<li>
	<a href="/docs/geode-native/cpp/113/getting-started/getting-started-nc-client.html#establish_cluster_access">Establish Access to a Geode Cluster</a>
	</li>
	<li>
	<a href="/docs/geode-native/cpp/113/getting-started/getting-started-nc-client.html#app_dev_walkthroughs">Application Development Walkthroughs</a>
	</li>
	<li>
	<a href="/docs/geode-native/cpp/113/getting-started/getting-started-nc-client.html#programming_examples">Programming Examples</a>
	</li>
	<li>
	<a href="/docs/geode-native/cpp/113/getting-started/put-get-example.html">Put/Get/Remove Examples</a>
	</li>
	</ul>
	</li>
	<li class="has_submenu">
	<a href="/docs/geode-native/cpp/113/configuring/configuration.html">Configuring a Client Application</a>
	<ul>
	<li>
	<a href="/docs/geode-native/cpp/113/configuring/system-level-configuration.html">System Level Configuration</a>
	</li>
	</ul>
	</li>

	<li>
	<a href="/docs/geode-native/cpp/113/configuring/config-client-cache.html">Configuring the Client Cache</a>
	</li>
	<li class="has_submenu">
	<a href="/docs/geode-native/cpp/113/regions/regions.html">Configuring Regions</a>
	<ul>
	<li>
	<a href="/docs/geode-native/cpp/113/regions/registering-interest-for-entries.html">Registering Interest for Entries</a>
	</li>
	<li>
	<a href="/docs/geode-native/cpp/113/regions/region-attributes.html">Region Attributes</a>
	</li>
	</ul>
	</li>

	<li class="has_submenu">
	<a href="/docs/geode-native/cpp/113/connection-pools/configuring-pools.html">Configuring Pools</a>
	<ul>
	<li>
	<a href="/docs/geode-native/cpp/113/connection-pools/client-pool-api.html">Native Client Pool API</a>
	</li>
	<li>
	<a href="/docs/geode-native/cpp/113/connection-pools/configuring-pools-attributes-example.html">Pool Configuration Example and Settings</a>
	</li>
	<li>
	<a href="/docs/geode-native/cpp/113/connection-pools/subscription-properties.html">Subscription Properties</a>
	</li>
	</ul>
	</li>

	<li>
	<a href="/docs/geode-native/cpp/113/serialization/data-serialization.html">Serializing Data</a>
	</li>

	<li>
	<a href="/docs/geode-native/cpp/113/remote-queries.html">Remote Queries</a>
	</li>

	<li>
	<a href="/docs/geode-native/cpp/113/continuous-queries.html">Continuous Queries</a>
	</li>

	<li class="has_submenu">
	<a href="/docs/geode-native/cpp/113/security/security.html">Security: Authentication and Encryption</a>
	<ul>
	<li>
	<a href="/docs/geode-native/cpp/113/security/authentication.html">Authentication</a>
	</li>
	<li>
	<a href="/docs/geode-native/cpp/113/security/sslclientserver.html">TLS/SSL Client-Server Communication Encryption</a>
	</li>
	</ul>
	</li>

	<li>
	<a href="/docs/geode-native/cpp/113/function-execution.html">Function Execution</a>
	</li>

	<li>
	<a href="/docs/geode-native/cpp/113/transactions.html">Transactions</a>
	</li>
	<li>
	<a href="/docs/geode-native/cpp/113/configuring/sysprops.html">System Properties</a>
	</li>
	<li>
	<a href="/docs/geode-native/cpp/113/client-cache-ref.html">Client Cache XML Reference</a>
	</li>
	</ul>
	</div>
	</div>

	<!--googleon: index-->

	<main class="content content-layout" id="js-content" role="main">
	<a id="top"></a>
	<!--
	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.
	-->
	<span style="font-weight:200;font-size:31px;" style="float:left;">
	<img src="/images/Apache_Geode_logo_symbol.png" style="height:26px;">
	Apache Geode Native C++
	</span>
	<span class="local-header version-info" style="float:right;">
	<a href="https://cwiki.apache.org/confluence/display/GEODE/Release+Notes">CHANGELOG</a>
	</span>

	<!--
	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.
	-->
	<h1 class="title-container" >
	Native Client Pool API
	</h1>

	<div id="js-quick-links" >

	</div>
	<div class="to-top" id="js-to-top">
	<a href="#top" title="back to top"></a>
	</div>
	<!--
	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.
	-->

	<p>The native client API allows your clients to create and manage connection pools. The server side does not have an API.</p>

	<p>The primary native client API for pool management is <code>Apache.Geode.Client.Cache</code>. For complete information on the classes and interfaces described here, see the API documentation.</p>

	<p><strong>Apache.Geode.Client.Cache</strong></p>

	<ul>
	<li> <code>Pool</code> interface. API to retrieve pool attributes.</li>
	<li> <code>PoolFactory</code> interface. API to configure pool attributes.</li>
	<li> <code>PoolManager</code> interface. API to create a <code>PoolFactory</code> object and to find the pool objects.</li>
	<li> <code>AttributesFactory</code> class. Has a new method <code>setPoolname</code> which assigns a pool to a region. Operations performed on the configured region use connections from the pool.</li>
	</ul>

	<p><strong>Note:</strong>
	A region can have a pool attached to it. A pool may have multiple regions attached to it.</p>



	</main>
	</div>
	</div>
	</div>

	<div id="scrim"></div>

	<div class="container">
	<footer class="site-footer-links">
	<!--
	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.
	-->
	<div class="copyright">
	<a href='/'>Apache Geode Documentation</a>
	© 2021 <a href='http://www.apache.org/'>The Apache Software Foundation</a>.
	</div>
	<div class="support">
	Need help? <a href="http://geode.apache.org/community" target="_blank">Visit the Community</a>
	</div>

	</footer>
	</div><!--end of container-->

	</body>
	</html>