Pivotal GemFire Native C++ Reference  10.2.0
apache::geode::client::PoolManager Class Reference

Manages creation and access to connection pools for clients. More...

Public Member Functions

void close (bool keepAlive=false)
 Unconditionally destroys all created pools that are in this manager. More...
 
PoolFactory createFactory () const
 Creates a new pool factory, which is used to configure and create new Pools. More...
 
std::shared_ptr< Poolfind (const std::shared_ptr< Region > &region) const
 Find the pool used by the given region. More...
 
std::shared_ptr< Poolfind (const std::string &name) const
 Find by name an existing connection pool returning the existing pool or nullptr if it does not exist. More...
 
const HashMapOfPools & getAll () const
 Returns a map containing all the pools in this manager. More...
 

Detailed Description

Manages creation and access to connection pools for clients.

To create a pool get a factory by calling createFactory.

To find an existing pool by name call find.

To get rid of all created pools call close.

Member Function Documentation

◆ close()

void apache::geode::client::PoolManager::close ( bool  keepAlive = false)

Unconditionally destroys all created pools that are in this manager.

Parameters
keepAlivedefines whether the server should keep the durable client's subscriptions alive for the durable-client-timeout.
See also
DistributedSystem::connect for a description of durable-client-timeout.

◆ createFactory()

PoolFactory apache::geode::client::PoolManager::createFactory ( ) const

Creates a new pool factory, which is used to configure and create new Pools.

Returns
the new pool factory

◆ find() [1/2]

std::shared_ptr<Pool> apache::geode::client::PoolManager::find ( const std::shared_ptr< Region > &  region) const

Find the pool used by the given region.

Parameters
regionis the region that is using the pool.
Returns
the pool used by that region or nullptr if the region does not have a pool.

◆ find() [2/2]

std::shared_ptr<Pool> apache::geode::client::PoolManager::find ( const std::string &  name) const

Find by name an existing connection pool returning the existing pool or nullptr if it does not exist.

Parameters
nameis the name of the connection pool
Returns
the existing connection pool or nullptr if it does not exist.

◆ getAll()

const HashMapOfPools& apache::geode::client::PoolManager::getAll ( ) const

Returns a map containing all the pools in this manager.

The keys are pool names and the values are Pool instances.

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.

Returns
a Map that is a snapshot of all the pools currently known to this manager.

Apache Geode C++ Cache API Documentation