GemStone::GemFire::Cache::Generic::Pool Class Reference

Inherits GemStone::GemFire::Cache::Generic::Internal::SBWrap< gemfire::Pool >.


Detailed Description

A pool of connections.

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

Public Member Functions

void Destroy ()
void Destroy (Boolean keepAlive)
template<class TKey, class TResult>
QueryService< TKey,
TResult >^ 
GetQueryService ()

Protected Member Functions

void _SetNativePtr (gemfire::Pool *nativeptr)
void AssignPtr (gemfire::Pool *nativeptr)
void InternalCleanup ()
void SetPtr (gemfire::Pool *nativeptr)

Properties

Boolean Destroyed [get]
Int32 FreeConnectionTimeout [get]
Int32 IdleTimeout [get]
Int32 LoadConditioningInterval [get]
array< String^ >^ Locators [get]
Int32 MaxConnections [get]
Int32 MinConnections [get]
bool MultiuserAuthentication [get]
String^  Name [get]
Int32 PendingEventCount [get]
Int32 PingInterval [get]
Boolean PRSingleHopEnabled [get]
Int32 ReadTimeout [get]
Int32 RetryAttempts [get]
String^  ServerGroup [get]
array< String^ >^ Servers [get]
Int32 SocketBufferSize [get]
Int32 StatisticInterval [get]
Int32 SubscriptionAckInterval [get]
Boolean SubscriptionEnabled [get]
Int32 SubscriptionMessageTrackingTimeout [get]
Int32 SubscriptionRedundancy [get]
Boolean ThreadLocalConnections [get]
Int32 UpdateLocatorListInterval [get]


Member Function Documentation

void GemStone::GemFire::Cache::Generic::Internal::SBWrap< gemfire::Pool >::_SetNativePtr ( gemfire::Pool *  nativeptr  )  [inline, protected, inherited]

Set the native pointer to the new object without doing a preserveSB(). DO NOT USE UNLESS YOU KNOW WHAT YOU ARE DOING.

void GemStone::GemFire::Cache::Generic::Internal::SBWrap< gemfire::Pool >::AssignPtr ( gemfire::Pool *  nativeptr  )  [inline, protected, inherited]

Used to assign the native pointer to a new object.

Note the order of preserveSB() and releaseSB(). This handles the corner case when m_nativeptr is same as nativeptr.

void GemStone::GemFire::Cache::Generic::Pool::Destroy (  ) 

Destroys this pool closing any connections it produced.

Exceptions:
IllegalStateException if the pool is still in use

void GemStone::GemFire::Cache::Generic::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

template<class TKey, class TResult>
QueryService<TKey, TResult> ^ GemStone::GemFire::Cache::Generic::Pool::GetQueryService (  )  [explicit]

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.

void GemStone::GemFire::Cache::Generic::Internal::SBWrap< gemfire::Pool >::InternalCleanup (  )  [inline, protected, inherited]

Internal cleanup function invoked by dispose/finalizer.

void GemStone::GemFire::Cache::Generic::Internal::SBWrap< gemfire::Pool >::SetPtr ( gemfire::Pool *  nativeptr  )  [inline, protected, inherited]

Used to set the native pointer to a new object. This should only be used when you know that the underlying object is NULL.


Property Documentation

Boolean GemStone::GemFire::Cache::Generic::Pool::Destroyed [get]

Indicates whether this Pool has been destroyed.

Int32 GemStone::GemFire::Cache::Generic::Pool::FreeConnectionTimeout [get]

Returns the connection timeout of this pool.

Int32 GemStone::GemFire::Cache::Generic::Pool::IdleTimeout [get]

Get the Idle connection timeout for this pool.

Int32 GemStone::GemFire::Cache::Generic::Pool::LoadConditioningInterval [get]

Returns the load conditioning interval of this pool.

array< String^>^ GemStone::GemFire::Cache::Generic::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.

Int32 GemStone::GemFire::Cache::Generic::Pool::MaxConnections [get]

Get the maximum connections for this pool.

Int32 GemStone::GemFire::Cache::Generic::Pool::MinConnections [get]

Get the minimum connections for this pool.

bool GemStone::GemFire::Cache::Generic::Pool::MultiuserAuthentication [get]

Returns true if multiuser authentication is enabled on this pool.

String^ GemStone::GemFire::Cache::Generic::Pool::Name [get]

Get the name of the pool

Int32 GemStone::GemFire::Cache::Generic::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

Int32 GemStone::GemFire::Cache::Generic::Pool::PingInterval [get]

Get the ping interval for this pool.

Boolean GemStone::GemFire::Cache::Generic::Pool::PRSingleHopEnabled [get]

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

Int32 GemStone::GemFire::Cache::Generic::Pool::ReadTimeout [get]

Returns the read timeout of this pool.

Int32 GemStone::GemFire::Cache::Generic::Pool::RetryAttempts [get]

Get the retry attempts for this pool.

String^ GemStone::GemFire::Cache::Generic::Pool::ServerGroup [get]

Returns the server group of this pool.

array< String^>^ GemStone::GemFire::Cache::Generic::Pool::Servers [get]

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

Int32 GemStone::GemFire::Cache::Generic::Pool::SocketBufferSize [get]

Returns the socket buffer size of this pool.

Int32 GemStone::GemFire::Cache::Generic::Pool::StatisticInterval [get]

Get the statistic interval for this pool.

Int32 GemStone::GemFire::Cache::Generic::Pool::SubscriptionAckInterval [get]

Returns the subscription ack interval of this pool.

Boolean GemStone::GemFire::Cache::Generic::Pool::SubscriptionEnabled [get]

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

Int32 GemStone::GemFire::Cache::Generic::Pool::SubscriptionMessageTrackingTimeout [get]

Returns the subscription message tracking timeout of this pool.

Int32 GemStone::GemFire::Cache::Generic::Pool::SubscriptionRedundancy [get]

Returns the subscription redundancy level of this pool.

Boolean GemStone::GemFire::Cache::Generic::Pool::ThreadLocalConnections [get]

Returns the true if ThreadLocalConnections are enabled on this pool.

Int32 GemStone::GemFire::Cache::Generic::Pool::UpdateLocatorListInterval [get]

Get the update locator list interval for this pool.


GemFire C++ Cache .NET API Documentation