|
GemFire 6.6.2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Pool
A pool for connections from a client to a set of GemFire Cache Servers.
A single instance of this interface can be created using ClientCacheFactory.create()
.
Multiple instances may also be created using
PoolFactory.create(java.lang.String)
.
A PoolFactory
instance is created by calling
PoolManager.createFactory()
. So to create a default Pool
do this:
new ClientCacheFactory().create();or this:
PoolManager.createFactory().create("myPool");Instances may also be created by declaring them in cache.xml with a
pool
element.
Existing Pool instances can be found using PoolManager.find(String)
and PoolManager.getAll()
.
The pool name must be configured
on the client regions that will use this pool by calling
RegionFactory.setPoolName(java.lang.String)
.
Method Summary | |
---|---|
void |
destroy()
Destroys this pool closing any connections it produced. |
void |
destroy(boolean keepAlive)
Destroys this pool closing any connections it produced. |
int |
getFreeConnectionTimeout()
Returns the connection timeout of this pool. |
long |
getIdleTimeout()
Get the maximum connections for this pool. |
int |
getLoadConditioningInterval()
Returns the load conditioning interval of this pool. |
List<InetSocketAddress> |
getLocators()
Returns an unmodifiable list of InetSocketAddress of the
locators this pool is using. |
int |
getMaxConnections()
Get the maximum connections for this pool. |
int |
getMinConnections()
Get the minimum connections for this pool. |
boolean |
getMultiuserAuthentication()
Returns true if multiuser mode is enabled on this pool. |
String |
getName()
Get the name of the connection pool |
long |
getPingInterval()
Get the ping interval for this pool. |
boolean |
getPRSingleHopEnabled()
Returns true if single-hop optimisation is enabled on this pool. |
QueryService |
getQueryService()
Returns the QueryService for this Pool. |
int |
getReadTimeout()
Returns the read timeout of this pool. |
int |
getRetryAttempts()
Get the retry attempts for this pool. |
String |
getServerGroup()
Returns the server group of this pool. |
List<InetSocketAddress> |
getServers()
Returns an unmodifiable list of InetSocketAddress of the
servers this pool is using. |
int |
getSocketBufferSize()
Returns the socket buffer size of this pool. |
int |
getStatisticInterval()
Get the statistic interval for this pool. |
int |
getSubscriptionAckInterval()
Returns the subscription ack interval of this pool. |
boolean |
getSubscriptionEnabled()
Returns the true if a server-to-client subscriptions are enabled on this pool. |
int |
getSubscriptionMessageTrackingTimeout()
Returns the subscription message tracking timeout of this pool. |
int |
getSubscriptionRedundancy()
Returns the subscription redundancy level of this pool. |
boolean |
getThreadLocalConnections()
Returns true if thread local connections are enabled on this pool. |
boolean |
isDestroyed()
Indicates whether this Pool has been destroyed. |
void |
releaseThreadLocalConnection()
If this pool was configured to to use thread local connections, then this method will release the connection cached for the calling thread. |
Method Detail |
---|
String getName()
PoolFactory.create(java.lang.String)
int getFreeConnectionTimeout()
PoolFactory.setFreeConnectionTimeout(int)
int getLoadConditioningInterval()
PoolFactory.setLoadConditioningInterval(int)
int getSocketBufferSize()
PoolFactory.setSocketBufferSize(int)
int getReadTimeout()
PoolFactory.setReadTimeout(int)
int getMinConnections()
PoolFactory.setMinConnections(int)
int getMaxConnections()
PoolFactory.setMaxConnections(int)
long getIdleTimeout()
PoolFactory.setIdleTimeout(long)
long getPingInterval()
PoolFactory.setPingInterval(long)
int getStatisticInterval()
PoolFactory.setStatisticInterval(int)
int getRetryAttempts()
PoolFactory.setRetryAttempts(int)
boolean getThreadLocalConnections()
true
if thread local connections are enabled on this pool.
PoolFactory.setThreadLocalConnections(boolean)
boolean getSubscriptionEnabled()
PoolFactory.setSubscriptionEnabled(boolean)
boolean getPRSingleHopEnabled()
PoolFactory.setPRSingleHopEnabled(boolean)
int getSubscriptionRedundancy()
PoolFactory.setSubscriptionRedundancy(int)
int getSubscriptionMessageTrackingTimeout()
PoolFactory.setSubscriptionMessageTrackingTimeout(int)
int getSubscriptionAckInterval()
PoolFactory.setSubscriptionAckInterval(int)
String getServerGroup()
PoolFactory.setServerGroup(java.lang.String)
boolean getMultiuserAuthentication()
PoolFactory.setMultiuserAuthentication(boolean)
List<InetSocketAddress> getLocators()
InetSocketAddress
of the
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.
List<InetSocketAddress> getServers()
InetSocketAddress
of the
servers this pool is using. These servers where either
added explicitly
when the pool was created or were discovered using this pools locators
.
void destroy(boolean keepAlive)
keepAlive
- whether the server should keep the durable client's
subscriptions alive for the timeout period
IllegalStateException
- if the pool is still in usevoid destroy()
IllegalStateException
- if the pool is still in useboolean isDestroyed()
void releaseThreadLocalConnection()
QueryService getQueryService()
|
GemFire 6.6.2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |