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

#include <Configuration.h>

Public Member Functions

 Configuration (const std::string &_protocolVersion, const ConnectionPoolConfiguration &_connectionPoolConfiguration, int _connectionTimeout, bool _forceReturnValue, int _keySizeEstimate, std::map< std::string, std::vector< ServerConfiguration > > _serversConfiguration, int _socketTimeout, const SslConfiguration _sslConfiguration, bool _tcpNoDelay, int _valueSizeEstimate, int _maxRetries, NearCacheConfiguration _nearCacheConfiguration, FailOverRequestBalancingStrategy::ProducerFn bsp=0, const event::EventMarshaller &eventMarshaller=event::JBasicEventMarshaller())
 
 Configuration (const std::string &_protocolVersion, const ConnectionPoolConfiguration &_connectionPoolConfiguration, int _connectionTimeout, bool _forceReturnValue, int _keySizeEstimate, std::map< std::string, std::vector< ServerConfiguration > > _serversConfiguration, int _socketTimeout, const SecurityConfiguration _securityConfiguration, bool _tcpNoDelay, int _valueSizeEstimate, int _maxRetries, NearCacheConfiguration _nearCacheConfiguration, FailOverRequestBalancingStrategy::ProducerFn bsp=0, const event::EventMarshaller &eventMarshaller=event::JBasicEventMarshaller())
 
HR_EXTERN const std::string & getProtocolVersion () const
 
HR_EXTERN const char * getProtocolVersionCString () const
 
HR_EXTERN const
ConnectionPoolConfiguration
getConnectionPoolConfiguration () const
 
HR_EXTERN const int & getConnectionTimeout () const
 
HR_EXTERN const bool & isForceReturnValue () const
 
HR_EXTERN const int & getKeySizeEstimate () const
 
std::map< std::string,
std::vector
< ServerConfiguration > > 
getServersMapConfiguration () const
 
HR_EXTERN const int & getSocketTimeout () const
 
HR_EXTERN const SslConfigurationgetSslConfiguration () const
 
HR_EXTERN const bool & isTcpNoDelay () const
 
HR_EXTERN const int & getValueSizeEstimate () const
 
HR_EXTERN const int & getMaxRetries () const
 
HR_EXTERN
FailOverRequestBalancingStrategy::ProducerFn 
getBalancingStrategy () const
 
const SslConfigurationgetSslConfiguration ()
 
HR_EXTERN const
event::EventMarshaller & 
getEventMarshaller () const
 
const NearCacheConfigurationgetNearCacheConfiguration () const
 
const SecurityConfigurationgetSecurityConfiguration () const
 

Static Public Attributes

static HR_EXTERN const char * PROTOCOL_VERSION_10
 
static HR_EXTERN const char * PROTOCOL_VERSION_11
 
static HR_EXTERN const char * PROTOCOL_VERSION_12
 
static HR_EXTERN const char * PROTOCOL_VERSION_13
 
static HR_EXTERN const char * PROTOCOL_VERSION_20
 
static HR_EXTERN const char * PROTOCOL_VERSION_21
 
static HR_EXTERN const char * PROTOCOL_VERSION_22
 
static HR_EXTERN const char * PROTOCOL_VERSION_23
 
static HR_EXTERN const char * PROTOCOL_VERSION_24
 
static HR_EXTERN const char * PROTOCOL_VERSION_25
 
static HR_EXTERN const char * PROTOCOL_VERSION_26
 
static HR_EXTERN const char * DEFAULT_CLUSTER_NAME
 

Detailed Description

Configuration object along with its builder represent the preferred approach of configuring RemoteCacheManager. Usually applications configure an ConfigurationBuilder object and build a Configuration from it invoking ConfigurationBuilder.create().

Constructor & Destructor Documentation

infinispan::hotrod::Configuration::Configuration ( const std::string &  _protocolVersion,
const ConnectionPoolConfiguration _connectionPoolConfiguration,
int  _connectionTimeout,
bool  _forceReturnValue,
int  _keySizeEstimate,
std::map< std::string, std::vector< ServerConfiguration > >  _serversConfiguration,
int  _socketTimeout,
const SslConfiguration  _sslConfiguration,
bool  _tcpNoDelay,
int  _valueSizeEstimate,
int  _maxRetries,
NearCacheConfiguration  _nearCacheConfiguration,
FailOverRequestBalancingStrategy::ProducerFn  bsp = 0,
const event::EventMarshaller &  eventMarshaller = event::JBasicEventMarshaller() 
)
inline
infinispan::hotrod::Configuration::Configuration ( const std::string &  _protocolVersion,
const ConnectionPoolConfiguration _connectionPoolConfiguration,
int  _connectionTimeout,
bool  _forceReturnValue,
int  _keySizeEstimate,
std::map< std::string, std::vector< ServerConfiguration > >  _serversConfiguration,
int  _socketTimeout,
const SecurityConfiguration  _securityConfiguration,
bool  _tcpNoDelay,
int  _valueSizeEstimate,
int  _maxRetries,
NearCacheConfiguration  _nearCacheConfiguration,
FailOverRequestBalancingStrategy::ProducerFn  bsp = 0,
const event::EventMarshaller &  eventMarshaller = event::JBasicEventMarshaller() 
)
inline

Member Function Documentation

HR_EXTERN FailOverRequestBalancingStrategy::ProducerFn infinispan::hotrod::Configuration::getBalancingStrategy ( ) const
HR_EXTERN const ConnectionPoolConfiguration& infinispan::hotrod::Configuration::getConnectionPoolConfiguration ( ) const

Gets the ConnectionPoolConfiguration instance for this Configuration.

Returns
ConnectionPoolConfiguration for further connection pool configuration
HR_EXTERN const int& infinispan::hotrod::Configuration::getConnectionTimeout ( ) const

Gets the connection timeout for this Configuration.

Returns
connection timeout in milliseconds
HR_EXTERN const event::EventMarshaller& infinispan::hotrod::Configuration::getEventMarshaller ( ) const
HR_EXTERN const int& infinispan::hotrod::Configuration::getKeySizeEstimate ( ) const

Returns the marshalled size estimate for keys in the remote cache.

Returns
estimated size (bytes) of keys in remote cache
HR_EXTERN const int& infinispan::hotrod::Configuration::getMaxRetries ( ) const

Returns the maximum number of retries for each request.

Returns
the maximum number of retries for each request.
const NearCacheConfiguration& infinispan::hotrod::Configuration::getNearCacheConfiguration ( ) const
inline
HR_EXTERN const std::string& infinispan::hotrod::Configuration::getProtocolVersion ( ) const
inline

DEPRECATED. Use getProtocolVersionCString(). In the future, this should return either const char * or std::string

HR_EXTERN const char* infinispan::hotrod::Configuration::getProtocolVersionCString ( ) const

Gets the protocol version for this Configuration.

Returns
String representation of the protocol version
const SecurityConfiguration& infinispan::hotrod::Configuration::getSecurityConfiguration ( ) const
inline
std::map<std::string, std::vector<ServerConfiguration> > infinispan::hotrod::Configuration::getServersMapConfiguration ( ) const
inline

Returns the vector of the failover server configurations where each server configuration instance describes a HotRod server address and port.

Returns
vector of server configurations
HR_EXTERN const int& infinispan::hotrod::Configuration::getSocketTimeout ( ) const

Returns socket timeout of underlying TCP connection(s)

Returns
socket timeout in milliseconds
HR_EXTERN const SslConfiguration& infinispan::hotrod::Configuration::getSslConfiguration ( ) const

Returns SSL configuration for the underlying TCP connections

Returns
SSL configuration
const SslConfiguration& infinispan::hotrod::Configuration::getSslConfiguration ( )
inline
HR_EXTERN const int& infinispan::hotrod::Configuration::getValueSizeEstimate ( ) const

Returns the marshalled size estimate for values in the remote cache.

Returns
estimated size (bytes) of values in remote cache
HR_EXTERN const bool& infinispan::hotrod::Configuration::isForceReturnValue ( ) const

Returns whether to force returning values on all cache operations that optionally return a value.

Returns
true if forcing return value is turned on, false otherwise
HR_EXTERN const bool& infinispan::hotrod::Configuration::isTcpNoDelay ( ) const

Returns true if TCP no delay is turned on for underlying TCP connections

Returns
true if TCP no delay is turned on

Member Data Documentation

HR_EXTERN const char* infinispan::hotrod::Configuration::DEFAULT_CLUSTER_NAME
static
HR_EXTERN const char* infinispan::hotrod::Configuration::PROTOCOL_VERSION_10
static
HR_EXTERN const char* infinispan::hotrod::Configuration::PROTOCOL_VERSION_11
static
HR_EXTERN const char* infinispan::hotrod::Configuration::PROTOCOL_VERSION_12
static
HR_EXTERN const char* infinispan::hotrod::Configuration::PROTOCOL_VERSION_13
static
HR_EXTERN const char* infinispan::hotrod::Configuration::PROTOCOL_VERSION_20
static
HR_EXTERN const char* infinispan::hotrod::Configuration::PROTOCOL_VERSION_21
static
HR_EXTERN const char* infinispan::hotrod::Configuration::PROTOCOL_VERSION_22
static
HR_EXTERN const char* infinispan::hotrod::Configuration::PROTOCOL_VERSION_23
static
HR_EXTERN const char* infinispan::hotrod::Configuration::PROTOCOL_VERSION_24
static
HR_EXTERN const char* infinispan::hotrod::Configuration::PROTOCOL_VERSION_25
static
HR_EXTERN const char* infinispan::hotrod::Configuration::PROTOCOL_VERSION_26
static

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