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

#include <ConfigurationBuilder.h>

Public Member Functions

 ConfigurationBuilder ()
 
void validate ()
 
ClusterConfigurationBuilder addCluster (const std::string &clusterName)
 
ServerConfigurationBuilderaddServer ()
 
ConfigurationBuilderaddServers (std::string servers)
 
ConnectionPoolConfigurationBuilderconnectionPool ()
 
ConfigurationBuilderconnectionTimeout (int connectionTimeout_)
 
ConfigurationBuilderforceReturnValues (bool forceReturnValues_)
 
ConfigurationBuilderkeySizeEstimate (int keySizeEstimate_)
 
ConfigurationBuilderprotocolVersion (const std::string &protocolVersion_)
 
ConfigurationBuildersocketTimeout (int socketTimeout_)
 
SslConfigurationBuilderssl ()
 
NearCacheConfigurationBuildernearCache ()
 
ConfigurationBuildertcpNoDelay (bool tcpNoDelay_)
 
ConfigurationBuildervalueSizeEstimate (int valueSizeEstimate_)
 
ConfigurationBuildermaxRetries (int maxRetries_)
 
ConfigurationBuilderbalancingStrategyProducer (FailOverRequestBalancingStrategy::ProducerFn bsp)
 
Configuration build ()
 
Configuration create ()
 
ConfigurationBuilderread (Configuration &configuration)
 
SecurityConfigurationBuildersecurity ()
 
bool isTransactional () const
 
ConfigurationBuildersetTransactional (bool transactional)
 

Detailed Description

ConfigurationBuilder is used to generate immutable Configuration objects that are in turn used to configure RemoteCacheManager instances.

Constructor & Destructor Documentation

infinispan::hotrod::ConfigurationBuilder::ConfigurationBuilder ( )
inline

Member Function Documentation

ClusterConfigurationBuilder infinispan::hotrod::ConfigurationBuilder::addCluster ( const std::string &  clusterName)
inline

Add a new cluster to the configuration builder

Parameters
clusterNamethe name of the new cluster
Returns
a ClusterConfigurationBuilder object usable to configure the new cluster
ServerConfigurationBuilder& infinispan::hotrod::ConfigurationBuilder::addServer ( )
inline

Adds a server to this Configuration. ServerConfigurationBuilder is in turn used to actually configure a server.

Returns
ServerConfigurationBuilder instance to be used for server configuration
ConfigurationBuilder& infinispan::hotrod::ConfigurationBuilder::addServers ( std::string  servers)
inline

Adds multiple servers to this Configuration. ConfigurationBuilder is in turn used to actually configure added servers as well as other configuration settings.

Returns
ConfigurationBuilder instance to be used for server configuration
ConfigurationBuilder& infinispan::hotrod::ConfigurationBuilder::balancingStrategyProducer ( FailOverRequestBalancingStrategy::ProducerFn  bsp)
inline
Configuration infinispan::hotrod::ConfigurationBuilder::build ( )
inline

Build and returns an actual Configuration instance to be used for configuration of RemoteCacheManager.

Returns
Configuration instance to be used for RemoteCacheManager configuration
ConnectionPoolConfigurationBuilder& infinispan::hotrod::ConfigurationBuilder::connectionPool ( )
inline

Configures connection pool.

Returns
ConnectionPoolConfigurationBuilder instance to be used for pool configuration
ConfigurationBuilder& infinispan::hotrod::ConfigurationBuilder::connectionTimeout ( int  connectionTimeout_)
inline

Configures underlying TCP connection timeout. Default is 60000 msec

Returns
ConfigurationBuilder instance to be used for configuration
Configuration infinispan::hotrod::ConfigurationBuilder::create ( )
inline

Same as build method create returns an actual Configuration instance to be used for configuration of RemoteCacheManager.

Returns
Configuration instance to be used for RemoteCacheManager configuration
ConfigurationBuilder& infinispan::hotrod::ConfigurationBuilder::forceReturnValues ( bool  forceReturnValues_)
inline

Configures whether or not to force returning values on all cache operations that optionally return a value. Default is false.

Returns
ConfigurationBuilder instance to be used for configuration
bool infinispan::hotrod::ConfigurationBuilder::isTransactional ( ) const
inline
ConfigurationBuilder& infinispan::hotrod::ConfigurationBuilder::keySizeEstimate ( int  keySizeEstimate_)
inline

Sets the marshalled size estimate for keys in the remote cache. Default is 64 bytes.

Returns
ConfigurationBuilder instance to be used for further configuration
ConfigurationBuilder& infinispan::hotrod::ConfigurationBuilder::maxRetries ( int  maxRetries_)
inline

Sets the maximum number of retries for each request. A valid value should be greater or equals than 0 (zero). Zero means no retry will made in case of a network failure. It defaults to 10.

Returns
ConfigurationBuilder instance to be used for further configuration
NearCacheConfigurationBuilder& infinispan::hotrod::ConfigurationBuilder::nearCache ( )
inline

Returns NearCacheConfigurationBuilder for near cache enabling and configuration.

Returns
NearCacheConfigurationBuilder instance to be used for configuration
ConfigurationBuilder& infinispan::hotrod::ConfigurationBuilder::protocolVersion ( const std::string &  protocolVersion_)
inline

Sets the protocol version for this ConfigurationBuilder. Protocol version is either: Configuration::PROTOCOL_VERSION_10 or Configuration::PROTOCOL_VERSION_11 or Configuration::PROTOCOL_VERSION_12. Default is PROTOCOL_VERSION_12.

Returns
ConfigurationBuilder instance to be used for further configuration
ConfigurationBuilder& infinispan::hotrod::ConfigurationBuilder::read ( Configuration configuration)
inline

Reads the given Configuration objects and returns a ConfigurationBuilder for further configuration or creation of the given Configuration object copies.

Returns
ConfigurationBuilder instance to be used for further configuration
SecurityConfigurationBuilder& infinispan::hotrod::ConfigurationBuilder::security ( )
inline

Return the builder related to autentication and TLS

Returns
a SecurityConfigurationBuilder object
ConfigurationBuilder& infinispan::hotrod::ConfigurationBuilder::setTransactional ( bool  transactional)
inline
ConfigurationBuilder& infinispan::hotrod::ConfigurationBuilder::socketTimeout ( int  socketTimeout_)
inline

Sets the socket timeout for the underlying connections in this ConfigurationBuilder. Default is 60000 msec.

Returns
ConfigurationBuilder instance to be used for further configuration
SslConfigurationBuilder& infinispan::hotrod::ConfigurationBuilder::ssl ( )
inline

Returns SslConfigurationBuilder for SSL configurations of the underlying sockets.

Returns
SslConfigurationBuilder instance to be used for SSL configuration
ConfigurationBuilder& infinispan::hotrod::ConfigurationBuilder::tcpNoDelay ( bool  tcpNoDelay_)
inline

Set tcpNoDelay for this ConfigurationBuilder. Default is true.

Returns
ConfigurationBuilder instance to be used for further configuration
void infinispan::hotrod::ConfigurationBuilder::validate ( )
inline
ConfigurationBuilder& infinispan::hotrod::ConfigurationBuilder::valueSizeEstimate ( int  valueSizeEstimate_)
inline

Sets the marshalled estimate of the values in this cache. Default is 512 bytes.

Returns
ConfigurationBuilder instance to be used for further configuration

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