apache::geode::client::PoolManager Class Reference

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

#include <PoolManager.hpp>

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

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

keepAlive

defines 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

region

is 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

name	is 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.