|
Hazelcast C++ Client
|
HazelcastClient configuration class. More...
#include <ClientConfig.h>
Public Member Functions | |
| ClientConfig () | |
| Constructor with default values. More... | |
| ClientConfig & | addAddress (const Address &address) |
| ClientConfig & | addAddresses (const std::vector< Address > &addresses) |
| std::set< Address > | getAddresses () |
| ClientConfig & | setGroupConfig (const GroupConfig &groupConfig) |
| The Group Configuration properties like: Name and Password that is used to connect to the cluster. More... | |
| GroupConfig & | getGroupConfig () |
| ClientConfig & | setCredentials (Credentials *credentials) |
| Can be used instead of GroupConfig in Hazelcast Extensions. More... | |
| const Credentials * | getCredentials () |
| Can be used instead of GroupConfig in Hazelcast Extensions. | |
| ClientConfig & | setConnectionAttemptLimit (int connectionAttemptLimit) |
| int | getConnectionAttemptLimit () const |
| ClientConfig & | setConnectionTimeout (int connectionTimeoutInMillis) |
| Use ClientNetworkConfig#setConnectionTimeout instead . | |
| int | getConnectionTimeout () const |
| Use ClientNetworkConfig#getConnectionTimeout instead . | |
| ClientConfig & | setAttemptPeriod (int attemptPeriodInMillis) |
| int | getAttemptPeriod () const |
| ClientConfig & | setRedoOperation (bool redoOperation) |
| If true, client will redo the operations that were executing on the server and client lost the connection. More... | |
| bool | isRedoOperation () const |
| see setRedoOperation returns redoOperation | |
| bool | isSmart () const |
| ClientConfig & | setSmart (bool smart) |
| ClientConfig & | setSocketInterceptor (SocketInterceptor *socketInterceptor) |
| Will be called with the Socket, each time client creates a connection to any Member. More... | |
| SocketInterceptor * | getSocketInterceptor () |
| Will be called with the Socket, each time client creates a connection to any Member. | |
| ClientConfig & | addListener (LifecycleListener *listener) |
| Adds a listener to configuration to be registered when HazelcastClient starts. More... | |
| const std::set< LifecycleListener * > & | getLifecycleListeners () const |
| ClientConfig & | addListener (MembershipListener *listener) |
| ClientConfig & | addListener (const boost::shared_ptr< MembershipListener > &listener) |
| Adds a listener to configuration to be registered when HazelcastClient starts. More... | |
| const std::set< MembershipListener * > & | getMembershipListeners () const |
| Returns registered membershipListeners. More... | |
| const std::set< boost::shared_ptr< MembershipListener > > & | getManagedMembershipListeners () const |
| Returns registered membershipListeners. More... | |
| ClientConfig & | addListener (InitialMembershipListener *listener) |
| ClientConfig & | addListener (const boost::shared_ptr< InitialMembershipListener > &listener) |
| Adds a listener to configuration to be registered when HazelcastClient starts. More... | |
| LoadBalancer *const | getLoadBalancer () |
| Used to distribute the operations to multiple Endpoints. More... | |
| ClientConfig & | setLoadBalancer (LoadBalancer *loadBalancer) |
| Used to distribute the operations to multiple Endpoints. More... | |
| ClientConfig & | setLogLevel (LogLevel loggerLevel) |
| enum LogLevel { SEVERE, WARNING, INFO, FINEST }; set INFO to see every log. More... | |
| SerializationConfig & | getSerializationConfig () |
| ClientConfig & | setSerializationConfig (SerializationConfig const &serializationConfig) |
| SerializationConfig is used to. More... | |
| std::map< std::string, std::string > & | getProperties () |
| Gets a reference to properties map. More... | |
| ClientConfig & | setProperty (const std::string &name, const std::string &value) |
| Sets the value of a named property. More... | |
| ClientConfig & | addReliableTopicConfig (const config::ReliableTopicConfig &reliableTopicConfig) |
| Adds a ClientReliableTopicConfig. More... | |
| const config::ReliableTopicConfig * | getReliableTopicConfig (const std::string &name) |
| Gets the ClientReliableTopicConfig for a given reliable topic name. More... | |
| template<typename K , typename V > | |
| ClientConfig & | addNearCacheConfig (const boost::shared_ptr< config::NearCacheConfig< K, V > > nearCacheConfig) |
| Helper method to add a new NearCacheConfig. More... | |
| ClientConfig & | addMixedNearCacheConfig (const boost::shared_ptr< mixedtype::config::MixedNearCacheConfig > nearCacheConfig) |
| Helper method to add a new NearCacheConfig. More... | |
| template<typename K , typename V > | |
| const boost::shared_ptr< config::NearCacheConfig< K, V > > | getNearCacheConfig (const std::string &name) |
| Gets the NearCacheConfig configured for the map / cache with name. More... | |
| const boost::shared_ptr< mixedtype::config::MixedNearCacheConfig > | getMixedNearCacheConfig (const std::string &name) |
| config::ClientNetworkConfig & | getNetworkConfig () |
| Gets com.hazelcast.client.config.ClientNetworkConfig. More... | |
| ClientConfig & | setNetworkConfig (const config::ClientNetworkConfig &networkConfig) |
| Sets com.hazelcast.client.config.ClientNetworkConfig. More... | |
| const boost::shared_ptr< std::string > & | getInstanceName () const |
| void | setInstanceName (const boost::shared_ptr< std::string > &instanceName) |
| int32_t | getExecutorPoolSize () const |
| Pool size for internal ExecutorService which handles responses etc. More... | |
| void | setExecutorPoolSize (int32_t executorPoolSize) |
| Sets Client side Executor pool size. More... | |
| config::ClientConnectionStrategyConfig & | getConnectionStrategyConfig () |
| ClientConfig & | setConnectionStrategyConfig (const config::ClientConnectionStrategyConfig &connectionStrategyConfig) |
| boost::shared_ptr< config::ClientFlakeIdGeneratorConfig > | findFlakeIdGeneratorConfig (const std::string &name) |
| Returns a ClientFlakeIdGeneratorConfig configuration for the given flake ID generator name. More... | |
| boost::shared_ptr< config::ClientFlakeIdGeneratorConfig > | getFlakeIdGeneratorConfig (const std::string &name) |
| Returns the ClientFlakeIdGeneratorConfig for the given name, creating one if necessary and adding it to the collection of known configurations. More... | |
| ClientConfig & | addFlakeIdGeneratorConfig (const boost::shared_ptr< config::ClientFlakeIdGeneratorConfig > &config) |
| Adds a flake ID generator configuration. More... | |
| config::LoggerConfig & | getLoggerConfig () |
Friends | |
| class | spi::impl::ClientClusterServiceImpl |
HazelcastClient configuration class.
| hazelcast::client::ClientConfig::ClientConfig | ( | ) |
Constructor with default values.
smart(true) redoOperation(false) connectionAttemptLimit(2) attemptPeriod(3000) defaultLoadBalancer(impl::RoundRobinLB)
| ClientConfig & hazelcast::client::ClientConfig::addAddress | ( | const Address & | address | ) |
Adds an address to list of the initial addresses. Client will use this list to find a running Member, connect to it.
| address |
| ClientConfig & hazelcast::client::ClientConfig::addAddresses | ( | const std::vector< Address > & | addresses | ) |
Adds all address in given vector to list of the initial addresses. Client will use this list to find a running Member, connect to it.
| addresses | vector of addresses |
| ClientConfig & hazelcast::client::ClientConfig::addFlakeIdGeneratorConfig | ( | const boost::shared_ptr< config::ClientFlakeIdGeneratorConfig > & | config | ) |
Adds a flake ID generator configuration.
The configuration is saved under the config name, which may be a pattern with which the configuration will be obtained in the future.
| config | the flake ID configuration |
| ClientConfig & hazelcast::client::ClientConfig::addListener | ( | LifecycleListener * | listener | ) |
Adds a listener to configuration to be registered when HazelcastClient starts.
Warning 1: If listener should do a time consuming operation, off-load the operation to another thread. otherwise it will slow down the system.
Warning 2: Do not make a call to hazelcast. It can cause deadlock.
| listener | LifecycleListener *listener |
| ClientConfig & hazelcast::client::ClientConfig::addListener | ( | MembershipListener * | listener | ) |
Adds a listener to configuration to be registered when HazelcastClient starts. Warning 1: If listener should do a time consuming operation, off-load the operation to another thread. otherwise it will slow down the system.
Warning 2: Do not make a call to hazelcast. It can cause deadlock.
| listener | MembershipListener *listener |
| ClientConfig & hazelcast::client::ClientConfig::addListener | ( | const boost::shared_ptr< MembershipListener > & | listener | ) |
Adds a listener to configuration to be registered when HazelcastClient starts.
Warning 1: If listener should do a time consuming operation, off-load the operation to another thread. otherwise it will slow down the system.
Warning 2: Do not make a call to hazelcast. It can cause deadlock.
| listener | MembershipListener *listener |
| ClientConfig & hazelcast::client::ClientConfig::addListener | ( | InitialMembershipListener * | listener | ) |
Adds a listener to configuration to be registered when HazelcastClient starts.
| listener | InitialMembershipListener *listener |
| ClientConfig & hazelcast::client::ClientConfig::addListener | ( | const boost::shared_ptr< InitialMembershipListener > & | listener | ) |
Adds a listener to configuration to be registered when HazelcastClient starts.
| listener | InitialMembershipListener *listener |
|
inline |
Helper method to add a new NearCacheConfig.
| nearCacheConfig | com.hazelcast.config.NearCacheConfig to be added |
Memory ownership of the config is passed to the client config
|
inline |
Helper method to add a new NearCacheConfig.
| nearCacheConfig | com.hazelcast.config.NearCacheConfig to be added |
Memory ownership of the config is passed to the client config
| ClientConfig & hazelcast::client::ClientConfig::addReliableTopicConfig | ( | const config::ReliableTopicConfig & | reliableTopicConfig | ) |
Adds a ClientReliableTopicConfig.
| reliableTopicConfig | the ReliableTopicConfig to add |
| boost::shared_ptr< config::ClientFlakeIdGeneratorConfig > hazelcast::client::ClientConfig::findFlakeIdGeneratorConfig | ( | const std::string & | name | ) |
Returns a ClientFlakeIdGeneratorConfig configuration for the given flake ID generator name.
The name is matched by pattern to the configuration and by stripping the partition ID qualifier from the given
. If there is no config found by the name, it will return the configuration with the name
.
| name | name of the flake ID generator config |
| ConfigurationException | if ambiguous configurations are found |
| std::set< Address > hazelcast::client::ClientConfig::getAddresses | ( | ) |
Returns set of the initial addresses. Client will use this vector to find a running Member, connect to it.
| int hazelcast::client::ClientConfig::getAttemptPeriod | ( | ) | const |
Period for the next attempt to find a member to connect. (see ClientConfig::connectionAttemptLimit ).
| int hazelcast::client::ClientConfig::getConnectionAttemptLimit | ( | ) | const |
While client is trying to connect initially to one of the members in the ClientConfig::addressList, all might be not available. Instead of giving up, throwing Exception and stopping client, it will attempt to retry as much as ClientConfig::connectionAttemptLimit times.
return int connectionAttemptLimit
| int32_t hazelcast::client::ClientConfig::getExecutorPoolSize | ( | ) | const |
Pool size for internal ExecutorService which handles responses etc.
| boost::shared_ptr< config::ClientFlakeIdGeneratorConfig > hazelcast::client::ClientConfig::getFlakeIdGeneratorConfig | ( | const std::string & | name | ) |
Returns the ClientFlakeIdGeneratorConfig for the given name, creating one if necessary and adding it to the collection of known configurations.
The configuration is found by matching the the configuration name pattern to the provided
without the partition qualifier (the part of the name after
). If no configuration matches, it will create one by cloning the
configuration and add it to the configuration collection.
This method is intended to easily and fluently create and add configurations more specific than the default configuration without explicitly adding it by invoking addFlakeIdGeneratorConfig(ClientFlakeIdGeneratorConfig).
Because it adds new configurations if they are not already present, this method is intended to be used before this config is used to create a hazelcast instance. Afterwards, newly added configurations may be ignored.
| name | name of the flake ID generator config |
| ConfigurationException | if ambiguous configurations are found |
| GroupConfig & hazelcast::client::ClientConfig::getGroupConfig | ( | ) |
| const std::set< LifecycleListener * > & hazelcast::client::ClientConfig::getLifecycleListeners | ( | ) | const |
| LoadBalancer *const hazelcast::client::ClientConfig::getLoadBalancer | ( | ) |
Used to distribute the operations to multiple Endpoints.
| config::LoggerConfig & hazelcast::client::ClientConfig::getLoggerConfig | ( | ) |
| const std::set< boost::shared_ptr< MembershipListener > > & hazelcast::client::ClientConfig::getManagedMembershipListeners | ( | ) | const |
Returns registered membershipListeners.
| const std::set< MembershipListener * > & hazelcast::client::ClientConfig::getMembershipListeners | ( | ) | const |
Returns registered membershipListeners.
|
inline |
Gets the NearCacheConfig configured for the map / cache with name.
| name | name of the map / cache |
| config::ClientNetworkConfig & hazelcast::client::ClientConfig::getNetworkConfig | ( | ) |
Gets com.hazelcast.client.config.ClientNetworkConfig.
| std::map< std::string, std::string > & hazelcast::client::ClientConfig::getProperties | ( | ) |
Gets a reference to properties map.
| const config::ReliableTopicConfig * hazelcast::client::ClientConfig::getReliableTopicConfig | ( | const std::string & | name | ) |
Gets the ClientReliableTopicConfig for a given reliable topic name.
| name | the name of the reliable topic |
| SerializationConfig & hazelcast::client::ClientConfig::getSerializationConfig | ( | ) |
| bool hazelcast::client::ClientConfig::isSmart | ( | ) | const |
| ClientConfig & hazelcast::client::ClientConfig::setAttemptPeriod | ( | int | attemptPeriodInMillis | ) |
Period for the next attempt to find a member to connect. (see ClientConfig::connectionAttemptLimit ).
| attemptPeriodInMillis |
| ClientConfig & hazelcast::client::ClientConfig::setConnectionAttemptLimit | ( | int | connectionAttemptLimit | ) |
While client is trying to connect initially to one of the members in the ClientConfig::addressList, all might be not available. Instead of giving up, throwing Exception and stopping client, it will attempt to retry as much as ClientConfig::connectionAttemptLimit times.
| connectionAttemptLimit |
| ClientConfig & hazelcast::client::ClientConfig::setCredentials | ( | Credentials * | credentials | ) |
Can be used instead of GroupConfig in Hazelcast Extensions.
| void hazelcast::client::ClientConfig::setExecutorPoolSize | ( | int32_t | executorPoolSize | ) |
Sets Client side Executor pool size.
| executorPoolSize | pool size |
| ClientConfig & hazelcast::client::ClientConfig::setGroupConfig | ( | const GroupConfig & | groupConfig | ) |
The Group Configuration properties like: Name and Password that is used to connect to the cluster.
| groupConfig |
| ClientConfig & hazelcast::client::ClientConfig::setLoadBalancer | ( | LoadBalancer * | loadBalancer | ) |
Used to distribute the operations to multiple Endpoints.
If not set, RoundRobin based load balancer is used
| loadBalancer |
| ClientConfig & hazelcast::client::ClientConfig::setLogLevel | ( | LogLevel | loggerLevel | ) |
enum LogLevel { SEVERE, WARNING, INFO, FINEST }; set INFO to see every log.
set WARNING to see only possible warnings and serious errors. set SEVERE to see only serious errors set FINEST to see all messages including debug messages.
| loggerLevel | The log level to be set. |
| ClientConfig & hazelcast::client::ClientConfig::setNetworkConfig | ( | const config::ClientNetworkConfig & | networkConfig | ) |
Sets com.hazelcast.client.config.ClientNetworkConfig.
| networkConfig | com.hazelcast.client.config.ClientNetworkConfig to be set |
| ClientConfig & hazelcast::client::ClientConfig::setProperty | ( | const std::string & | name, |
| const std::string & | value | ||
| ) |
Sets the value of a named property.
| name | property name |
| value | value of the property |
| ClientConfig & hazelcast::client::ClientConfig::setRedoOperation | ( | bool | redoOperation | ) |
If true, client will redo the operations that were executing on the server and client lost the connection.
This can be because of network, or simply because the member died. However it is not clear whether the application is performed or not. For idempotent operations this is harmless, but for non idempotent ones retrying can cause to undesirable effects. Note that the redo can perform on any member.
If false, the operation will throw IOException.
| redoOperation | return itself ClientConfig |
| ClientConfig & hazelcast::client::ClientConfig::setSerializationConfig | ( | SerializationConfig const & | serializationConfig | ) |
SerializationConfig is used to.
| serializationConfig |
| ClientConfig & hazelcast::client::ClientConfig::setSmart | ( | bool | smart | ) |
If true, client will route the key based operations to owner of the key at the best effort. Note that it uses a cached version of PartitionService::getPartitions() and doesn't guarantee that the operation will always be executed on the owner. The cached table is updated every 10 seconds.
| smart |
| ClientConfig & hazelcast::client::ClientConfig::setSocketInterceptor | ( | SocketInterceptor * | socketInterceptor | ) |
Will be called with the Socket, each time client creates a connection to any Member.
1.8.14