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

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

Static Public Member Functions
static void	close (bool keepAlive=false)
	Unconditionally destroys all created pools that are in this manager. More...
static PoolFactoryPtr	createFactory ()
	Creates a new pool factory, which is used to configure and create new Pools. More...
static PoolPtr	find (const char *name)
	Find by name an existing connection pool returning the existing pool or NULLPTR if it does not exist. More...
static PoolPtr	find (RegionPtr region)
	Find the pool used by the given region. More...
static const HashMapOfPools &	getAll ()
	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

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

static

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.

static PoolFactoryPtr apache::geode::client::PoolManager::createFactory ( )

static

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

Returns

the new pool factory

static PoolPtr apache::geode::client::PoolManager::find ( const char *  name )

static

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.

static PoolPtr apache::geode::client::PoolManager::find ( RegionPtr  region )

static

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.

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

static

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.