A pool of connections. More...

Inherits IDisposable.

Inherited by Pool.

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

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

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

void	ReadyForEvents ()
	Send ReadyForEvents message. More...

Properties
string	Name `[get]`
	Get the name of the pool More...

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

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

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

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

string	SniProxyHost `[get]`
	Get the host name for the pool's SniProxy. More...

int	SniProxyPort `[get]`
	Get the host port for the pool's SniProxy. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

IReadOnlyCollection< string >	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. More...

IReadOnlyCollection< string >	Servers `[get]`
	Returns an unmodifiable list of servers this pool is using. These servers were added explicitly when the pool was created. More...

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

int	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. More...

Detailed Description

A pool of connections.

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

Member Function Documentation

◆ Destroy() [1/2]

void IPool.Destroy ( )

Destroys this pool closing any connections it produced.

◆ Destroy() [2/2]

void IPool.Destroy ( bool 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

◆ GetQueryService()

IQueryService IPool.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.

◆ ReadyForEvents()

void IPool.ReadyForEvents ( )

Send ReadyForEvents message.

Property Documentation

◆ Destroyed

bool IPool.Destroyed

get

Indicates whether this Pool has been destroyed.

◆ FreeConnectionTimeout

TimeSpan IPool.FreeConnectionTimeout

get

Returns the connection timeout of this pool.

◆ IdleTimeout

TimeSpan IPool.IdleTimeout

get

Get the Idle connection timeout for this pool.

◆ LoadConditioningInterval

TimeSpan IPool.LoadConditioningInterval

get

Returns the load conditioning interval of this pool.

◆ Locators

IReadOnlyCollection<string> IPool.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

int IPool.MaxConnections

get

Get the maximum connections for this pool.

◆ MinConnections

int IPool.MinConnections

get

Get the minimum connections for this pool.

◆ Name

string IPool.Name

get

Get the name of the pool

◆ PendingEventCount

int IPool.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().

◆ PingInterval

TimeSpan IPool.PingInterval

get

Get the ping interval for this pool.

◆ PRSingleHopEnabled

bool IPool.PRSingleHopEnabled

get

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

◆ ReadTimeout

TimeSpan IPool.ReadTimeout

get

Returns the read timeout of this pool.

◆ RetryAttempts

int IPool.RetryAttempts

get

Get the retry attempts for this pool.

◆ ServerGroup

string IPool.ServerGroup

get

Returns the server group of this pool.

◆ Servers

IReadOnlyCollection<string> IPool.Servers

get

Returns an unmodifiable list of servers this pool is using. These servers were added explicitly when the pool was created.

◆ SniProxyHost

string IPool.SniProxyHost

get

Get the host name for the pool's SniProxy.

◆ SniProxyPort

int IPool.SniProxyPort

get

Get the host port for the pool's SniProxy.

◆ SocketBufferSize

int IPool.SocketBufferSize

get

Returns the socket buffer size of this pool.

◆ StatisticInterval

TimeSpan IPool.StatisticInterval

get

Get the statistic interval for this pool.

◆ SubscriptionAckInterval

TimeSpan IPool.SubscriptionAckInterval

get

Returns the subscription ack interval of this pool.

◆ SubscriptionEnabled

bool IPool.SubscriptionEnabled

get

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

◆ SubscriptionMessageTrackingTimeout

TimeSpan IPool.SubscriptionMessageTrackingTimeout

get

Returns the subscription message tracking timeout of this pool.

◆ SubscriptionRedundancy

int IPool.SubscriptionRedundancy

get

Returns the subscription redundancy level of this pool.

◆ UpdateLocatorListInterval

TimeSpan IPool.UpdateLocatorListInterval

get

Get the update locator list interval for this pool.

The documentation for this interface was generated from the following file:

gemfire.client/Interfaces/IPool.cs

VMware Tanzu GemFire .NET Client API Reference

Public Member Functions

Properties