Infinispan HotRod C++ Client  8.3.1.Final
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | List of all members
infinispan::hotrod::ConnectionPoolConfigurationBuilder Class Reference

#include <ConnectionPoolConfigurationBuilder.h>

Inheritance diagram for infinispan::hotrod::ConnectionPoolConfigurationBuilder:
infinispan::hotrod::ConfigurationChildBuilder

Public Member Functions

 ConnectionPoolConfigurationBuilder (ConfigurationBuilder &builder)
 
virtual void validate ()
 
virtual ~ConnectionPoolConfigurationBuilder ()
 
ConnectionPoolConfigurationBuilderexhaustedAction (ExhaustedAction exhaustedAction_)
 
ConnectionPoolConfigurationBuilderlifo (bool lifo_)
 
ConnectionPoolConfigurationBuildermaxActive (int maxActive_)
 
ConnectionPoolConfigurationBuildermaxTotal (int maxTotal_)
 
ConnectionPoolConfigurationBuildermaxWait (long maxWait_)
 
ConnectionPoolConfigurationBuildermaxIdle (int maxIdle_)
 
ConnectionPoolConfigurationBuilderminIdle (int minIdle_)
 
ConnectionPoolConfigurationBuildernumTestsPerEvictionRun (int numTestsPerEvictionRun_)
 
ConnectionPoolConfigurationBuildertimeBetweenEvictionRuns (int timeBetweenEvictionRuns_)
 
ConnectionPoolConfigurationBuilderminEvictableIdleTime (int minEvictableIdleTime_)
 
ConnectionPoolConfigurationBuildertestOnBorrow (bool testOnBorrow_)
 
ConnectionPoolConfigurationBuildertestOnReturn (bool testOnReturn_)
 
ConnectionPoolConfigurationBuildertestWhileIdle (bool testWhileIdle_)
 
virtual ConnectionPoolConfiguration create ()
 
virtual
ConnectionPoolConfigurationBuilder
read (ConnectionPoolConfiguration &configuration)
 
- Public Member Functions inherited from infinispan::hotrod::ConfigurationChildBuilder
 ConfigurationChildBuilder (ConfigurationBuilder &builder)
 
ServerConfigurationBuilderaddServer ()
 
ConfigurationBuilderaddServers (const std::string &servers)
 
ConnectionPoolConfigurationBuilderconnectionPool ()
 
ConfigurationBuilderconnectionTimeout (int connectionTimeout)
 
ConfigurationBuilderforceReturnValues (bool forceReturnValues)
 
ConfigurationBuilderkeySizeEstimate (int keySizeEstimate)
 
ConfigurationBuilderprotocolVersion (const std::string &protocolVersion)
 
ConfigurationBuildersocketTimeout (int socketTimeout)
 
SslConfigurationBuilderssl ()
 
ConfigurationBuildertcpNoDelay (bool tcpNoDelay)
 
ConfigurationBuildervalueSizeEstimate (int valueSizeEstimate)
 
ConfigurationBuildermaxRetries (int maxRetries_)
 
ConfigurationBuilderbalancingStrategyProducer (FailOverRequestBalancingStrategy::ProducerFn bsp)
 
Configuration build ()
 

Detailed Description

ConnectionPoolConfigurationBuilder is used to specify connection pooling properties for the HotRod client

Constructor & Destructor Documentation

infinispan::hotrod::ConnectionPoolConfigurationBuilder::ConnectionPoolConfigurationBuilder ( ConfigurationBuilder builder)
inline
virtual infinispan::hotrod::ConnectionPoolConfigurationBuilder::~ConnectionPoolConfigurationBuilder ( )
inlinevirtual

Member Function Documentation

virtual ConnectionPoolConfiguration infinispan::hotrod::ConnectionPoolConfigurationBuilder::create ( )
inlinevirtual
ConnectionPoolConfigurationBuilder& infinispan::hotrod::ConnectionPoolConfigurationBuilder::exhaustedAction ( ExhaustedAction  exhaustedAction_)
inline

Specifies what happens when asking for a connection from a server's pool, and that pool is exhausted.

Returns
ConnectionPoolConfigurationBuilder for further configuration
ConnectionPoolConfigurationBuilder& infinispan::hotrod::ConnectionPoolConfigurationBuilder::lifo ( bool  lifo_)
inline

Sets the LIFO status. True means that borrowObject returns the most recently used ("last in") idle object in a pool (if there are idle instances available). False means that pools behave as FIFO queues - objects are taken from idle object pools in the order that they are returned. The default setting is true

Returns
ConnectionPoolConfigurationBuilder for further configuration
ConnectionPoolConfigurationBuilder& infinispan::hotrod::ConnectionPoolConfigurationBuilder::maxActive ( int  maxActive_)
inline

Controls the maximum number of connections per server that are allocated (checked out to client threads, or idle in the pool) at one time. When non-positive, there is no limit to the number of connections per server. When maxActive is reached, the connection pool for that server is said to be exhausted. The default setting for this parameter is -1, i.e. there is no limit.

Returns
ConnectionPoolConfigurationBuilder for further configuration
ConnectionPoolConfigurationBuilder& infinispan::hotrod::ConnectionPoolConfigurationBuilder::maxIdle ( int  maxIdle_)
inline

Controls the maximum number of idle persistent connections, per server, at any time. When negative, there is no limit to the number of connections that may be idle per server. The default setting for this parameter is -1.

Returns
ConnectionPoolConfigurationBuilder for further configuration
ConnectionPoolConfigurationBuilder& infinispan::hotrod::ConnectionPoolConfigurationBuilder::maxTotal ( int  maxTotal_)
inline

Sets a global limit on the number persistent connections that can be in circulation within the combined set of servers. When non-positive, there is no limit to the total number of persistent connections in circulation. When maxTotal is exceeded, all connections pools are exhausted. The default setting for this parameter is -1 (no limit).

Returns
ConnectionPoolConfigurationBuilder for further configuration
ConnectionPoolConfigurationBuilder& infinispan::hotrod::ConnectionPoolConfigurationBuilder::maxWait ( long  maxWait_)
inline

The amount of time in milliseconds to wait for a connection to become available when the exhausted action is ExhaustedAction::WAIT, after which an will be thrown. If a negative value is supplied, the pool will block indefinitely.

Returns
ConnectionPoolConfigurationBuilder for further configuration
ConnectionPoolConfigurationBuilder& infinispan::hotrod::ConnectionPoolConfigurationBuilder::minEvictableIdleTime ( int  minEvictableIdleTime_)
inline

Specifies the minimum amount of time that an connection may sit idle in the pool before it is eligible for eviction due to idle time. When non-positive, no connection will be dropped from the pool due to idle time alone. This setting has no effect unless timeBetweenEvictionRuns > 0. The default setting for this parameter is 1800000ms (30 minutes).

Returns
ConnectionPoolConfigurationBuilder for further configuration
ConnectionPoolConfigurationBuilder& infinispan::hotrod::ConnectionPoolConfigurationBuilder::minIdle ( int  minIdle_)
inline

Sets a target value for the minimum number of idle connections (per server) that should always be available. If this parameter is set to a positive number and timeBetweenEvictionRuns

0, each time the idle connection eviction thread runs, it will try to create enough idle

instances so that there will be minIdle idle instances available for each server. The default setting for this parameter is 1.

Returns
ConnectionPoolConfigurationBuilder for further configuration
ConnectionPoolConfigurationBuilder& infinispan::hotrod::ConnectionPoolConfigurationBuilder::numTestsPerEvictionRun ( int  numTestsPerEvictionRun_)
inline

Indicates the maximum number of connections to test during idle eviction runs. The default setting is 3.

Returns
ConnectionPoolConfigurationBuilder for further configuration
virtual ConnectionPoolConfigurationBuilder& infinispan::hotrod::ConnectionPoolConfigurationBuilder::read ( ConnectionPoolConfiguration configuration)
inlinevirtual
ConnectionPoolConfigurationBuilder& infinispan::hotrod::ConnectionPoolConfigurationBuilder::testOnBorrow ( bool  testOnBorrow_)
inline

Indicates whether connections should be validated before being taken from the pool by sending an TCP packet to the server. Connections that fail to validate will be dropped from the pool. The default setting for this parameter is false.

Returns
ConnectionPoolConfigurationBuilder for further configuration
ConnectionPoolConfigurationBuilder& infinispan::hotrod::ConnectionPoolConfigurationBuilder::testOnReturn ( bool  testOnReturn_)
inline

Indicates whether connections should be validated when being returned to the pool sending an TCP packet to the server. Connections that fail to validate will be dropped from the pool. The default setting for this parameter is false.

Returns
ConnectionPoolConfigurationBuilder for further configuration
ConnectionPoolConfigurationBuilder& infinispan::hotrod::ConnectionPoolConfigurationBuilder::testWhileIdle ( bool  testWhileIdle_)
inline

Indicates whether or not idle connections should be validated by sending an TCP packet to the server, during idle connection eviction runs. Connections that fail to validate will be dropped from the pool. This setting has no effect unless timeBetweenEvictionRuns > 0. The default setting for this parameter is true.

Returns
ConnectionPoolConfigurationBuilder for further configuration
ConnectionPoolConfigurationBuilder& infinispan::hotrod::ConnectionPoolConfigurationBuilder::timeBetweenEvictionRuns ( int  timeBetweenEvictionRuns_)
inline

Indicates how long the eviction thread should sleep before "runs" of examining idle connections. When non-positive, no eviction thread will be launched. The default setting for this parameter is 2 minutes.

Returns
ConnectionPoolConfigurationBuilder for further configuration
virtual void infinispan::hotrod::ConnectionPoolConfigurationBuilder::validate ( )
inlinevirtual

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