A pool of connections. More...

Public Member Functions
void	Destroy ()
	Destroys this pool closing any connections it produced. More...

void	Destroy (Boolean keepAlive)
	Destroys this pool closing any connections it produced. More...

QueryService ^	GetQueryService ()
	Returns the QueryService for this Pool. More...

Properties
Boolean	Destroyed `[get]`
	Indicates whether this Pool has been destroyed. More...

TimeSpan	FreeConnectionTimeout `[get]`
	Returns the connection timeout of this pool. More...

TimeSpan	IdleTimeout `[get]`
	Get the Idle connection timeout for this pool. More...

TimeSpan	LoadConditioningInterval `[get]`
	Returns the load conditioning interval of this pool. More...

array< String^>^	Locators `[get]`
	Returns an unmodifiable list of locators this pool is using. More...

Int32	MaxConnections `[get]`
	Get the maximum connections for this pool. More...

Int32	MinConnections `[get]`
	Get the minimum connections for this pool. More...

bool	MultiuserAuthentication `[get]`
	Returns true if multiuser authentication is enabled on this pool. More...

String^	Name `[get]`
	Get the name of the pool More...

Int32	PendingEventCount `[get]`
	Returns the approximate number of pending subscription events maintained at server for this durable client pool at the time it (re)connected to the server. More...

TimeSpan	PingInterval `[get]`
	Get the ping interval for this pool. More...

Boolean	PRSingleHopEnabled `[get]`
	Returns the true if a pr-single-hop is set to true on this pool. More...

TimeSpan	ReadTimeout `[get]`
	Returns the read timeout of this pool. More...

Int32	RetryAttempts `[get]`
	Get the retry attempts for this pool. More...

String^	ServerGroup `[get]`
	Returns the server group of this pool. More...

array< String^>^	Servers `[get]`
	Returns an unmodifiable list of servers this pool is using. More...

Int32	SocketBufferSize `[get]`
	Returns the socket buffer size of this pool. More...

TimeSpan	StatisticInterval `[get]`
	Get the statistic interval for this pool. More...

TimeSpan	SubscriptionAckInterval `[get]`
	Returns the subscription ack interval of this pool. More...

Boolean	SubscriptionEnabled `[get]`
	Returns the true if a server-to-client subscriptions are enabled on this pool. More...

TimeSpan	SubscriptionMessageTrackingTimeout `[get]`
	Returns the subscription message tracking timeout of this pool. More...

Int32	SubscriptionRedundancy `[get]`
	Returns the subscription redundancy level of this pool. More...

Boolean	ThreadLocalConnections `[get]`
	Returns the true if ThreadLocalConnections are enabled on this pool. More...

TimeSpan	UpdateLocatorListInterval `[get]`
	Get the update locator list interval for this pool. More...

Detailed Description

A pool of connections.

A pool of connections from a Geode client to a set of Geode servers.

Member Function Documentation

◆ Destroy() [1/2]

void Apache::Geode::Client::Pool::Destroy ( )

Destroys this pool closing any connections it produced.

Exceptions

IllegalStateException if the pool is still in use

◆ Destroy() [2/2]

void Apache::Geode::Client::Pool::Destroy ( Boolean keepAlive )

Destroys this pool closing any connections it produced.

Parameters

keepAlive whether the server should keep the durable client's subscriptions alive for the timeout period

Exceptions

IllegalStateException if the pool is still in use

◆ GetQueryService()

QueryService ^ Apache::Geode::Client::Pool::GetQueryService ( )

Returns the QueryService for this Pool.

The query operations performed using this QueryService will be executed on the servers that are associated with this pool. To perform Query operation on the local cache obtain the QueryService instance from the Cache.

Property Documentation

◆ Destroyed

Boolean Apache::Geode::Client::Pool::Destroyed

get

Indicates whether this Pool has been destroyed.

◆ FreeConnectionTimeout

TimeSpan Apache::Geode::Client::Pool::FreeConnectionTimeout

get

Returns the connection timeout of this pool.

◆ IdleTimeout

TimeSpan Apache::Geode::Client::Pool::IdleTimeout

get

Get the Idle connection timeout for this pool.

◆ LoadConditioningInterval

TimeSpan Apache::Geode::Client::Pool::LoadConditioningInterval

get

Returns the load conditioning interval of this pool.

◆ Locators

array< String^>^ Apache::Geode::Client::Pool::Locators

get

Returns an unmodifiable list of locators this pool is using.

Each locator is either one added explicitly when the pool was created or were discovered using the explicit locators.

If a pool has no locators then it can not discover servers or locators at runtime.

◆ MaxConnections

Int32 Apache::Geode::Client::Pool::MaxConnections

get

Get the maximum connections for this pool.

◆ MinConnections

Int32 Apache::Geode::Client::Pool::MinConnections

get

Get the minimum connections for this pool.

◆ MultiuserAuthentication

bool Apache::Geode::Client::Pool::MultiuserAuthentication

get

Returns

true

if multiuser authentication is enabled on this pool.

◆ Name

String^ Apache::Geode::Client::Pool::Name

get

Get the name of the pool

◆ PendingEventCount

Int32 Apache::Geode::Client::Pool::PendingEventCount

get

Returns the approximate number of pending subscription events maintained at server for this durable client pool at the time it (re)connected to the server.

Server would start dispatching these events to this durable client pool when it receives Cache#readyForEvents() from it.

Durable clients can call this method on reconnect to assess the amount of 'stale' data i.e. events accumulated at server while this client was away and, importantly, before calling Cache#readyForEvents().

Any number of invocations of this method during a single session will return the same value.

It may return a zero value if there are no events pending at server for this client pool. A negative value returned tells us that no queue was available at server for this client pool.

A value -1 indicates that this client pool reconnected to server after its 'durable-client-timeout' period elapsed and hence its subscription queue at server was removed, possibly causing data loss.

A value -2 indicates that this client pool connected to server for the first time.

Returns: int The number of subscription events maintained at server for this durable client pool at the time this pool (re)connected. A negative value indicates no queue was found for this client pool.

Exceptions

IllegalStateException If called by a non-durable client or if invoked any time after invocation of Cache#readyForEvents().

Since: 8.1

◆ PingInterval

TimeSpan Apache::Geode::Client::Pool::PingInterval

get

Get the ping interval for this pool.

◆ PRSingleHopEnabled

Boolean Apache::Geode::Client::Pool::PRSingleHopEnabled

get

Returns the true if a pr-single-hop is set to true on this pool.

◆ ReadTimeout

TimeSpan Apache::Geode::Client::Pool::ReadTimeout

get

Returns the read timeout of this pool.

◆ RetryAttempts

Int32 Apache::Geode::Client::Pool::RetryAttempts

get

Get the retry attempts for this pool.

◆ ServerGroup

String^ Apache::Geode::Client::Pool::ServerGroup

get

Returns the server group of this pool.

◆ Servers

array< String^>^ Apache::Geode::Client::Pool::Servers

get

Returns an unmodifiable list of servers this pool is using.

These servers were added explicitly when the pool was created.

◆ SocketBufferSize

Int32 Apache::Geode::Client::Pool::SocketBufferSize

get

Returns the socket buffer size of this pool.

◆ StatisticInterval

TimeSpan Apache::Geode::Client::Pool::StatisticInterval

get

Get the statistic interval for this pool.

◆ SubscriptionAckInterval

TimeSpan Apache::Geode::Client::Pool::SubscriptionAckInterval

get

Returns the subscription ack interval of this pool.

◆ SubscriptionEnabled

Boolean Apache::Geode::Client::Pool::SubscriptionEnabled

get

Returns the true if a server-to-client subscriptions are enabled on this pool.

◆ SubscriptionMessageTrackingTimeout

TimeSpan Apache::Geode::Client::Pool::SubscriptionMessageTrackingTimeout

get

Returns the subscription message tracking timeout of this pool.

◆ SubscriptionRedundancy

Int32 Apache::Geode::Client::Pool::SubscriptionRedundancy

get

Returns the subscription redundancy level of this pool.

◆ ThreadLocalConnections

Boolean Apache::Geode::Client::Pool::ThreadLocalConnections

get

Returns the true if ThreadLocalConnections are enabled on this pool.

◆ UpdateLocatorListInterval

TimeSpan Apache::Geode::Client::Pool::UpdateLocatorListInterval

get

Get the update locator list interval for this pool.

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ Destroy() [1/2]

◆ Destroy() [2/2]

◆ GetQueryService()

Property Documentation

◆ Destroyed

◆ FreeConnectionTimeout

◆ IdleTimeout

◆ LoadConditioningInterval

◆ Locators

◆ MaxConnections

◆ MinConnections

◆ MultiuserAuthentication

◆ Name

◆ PendingEventCount

◆ PingInterval

◆ PRSingleHopEnabled

◆ ReadTimeout

◆ RetryAttempts

◆ ServerGroup

◆ Servers

◆ SocketBufferSize

◆ StatisticInterval

◆ SubscriptionAckInterval

◆ SubscriptionEnabled

◆ SubscriptionMessageTrackingTimeout

◆ SubscriptionRedundancy

◆ ThreadLocalConnections

◆ UpdateLocatorListInterval