Hazelcast C++ Client
ClientConfig.h
1 /*
2  * Copyright (c) 2008-2018, Hazelcast, Inc. All Rights Reserved.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 #ifndef HAZELCAST_CLIENT_CONFIG
17 #define HAZELCAST_CLIENT_CONFIG
18 
19 #include <vector>
20 #include <set>
21 #include <boost/shared_ptr.hpp>
22 
23 #include "hazelcast/client/Address.h"
24 #include "hazelcast/client/GroupConfig.h"
25 #include "hazelcast/client/SerializationConfig.h"
26 #include "hazelcast/client/Credentials.h"
27 #include "hazelcast/client/SocketInterceptor.h"
28 #include "hazelcast/client/LoadBalancer.h"
29 #include "hazelcast/client/impl/RoundRobinLB.h"
30 #include "hazelcast/util/ILogger.h"
31 #include "hazelcast/util/SynchronizedMap.h"
32 #include "hazelcast/client/config/ReliableTopicConfig.h"
33 #include "hazelcast/client/config/NearCacheConfig.h"
34 #include "hazelcast/client/config/ClientNetworkConfig.h"
35 #include "hazelcast/client/config/ClientConnectionStrategyConfig.h"
36 #include "hazelcast/client/config/ClientFlakeIdGeneratorConfig.h"
37 #include "hazelcast/client/config/matcher/MatchingPointConfigPatternMatcher.h"
38 #include "hazelcast/client/internal/config/ConfigUtils.h"
39 
40 #if defined(WIN32) || defined(_WIN32) || defined(WIN64) || defined(_WIN64)
41 #pragma warning(push)
42 #pragma warning(disable: 4251) //for dll export
43 #endif
44 
45 namespace hazelcast {
46  namespace client {
47  class MembershipListener;
48 
49  class InitialMembershipListener;
50 
51  class LifecycleListener;
52 
53  class InitialMembershipEvent;
54 
58  class HAZELCAST_API ClientConfig {
59  friend class spi::impl::ClientClusterServiceImpl;
60  public:
61 
70  ClientConfig();
71 
81  ClientConfig &addAddress(const Address &address);
82 
92  ClientConfig &addAddresses(const std::vector<Address> &addresses);
93 
102  std::set<Address> getAddresses();
103 
111  ClientConfig &setGroupConfig(const GroupConfig &groupConfig);
112 
117  GroupConfig &getGroupConfig();
118 
124  ClientConfig &setCredentials(Credentials *credentials);
125 
129  const Credentials *getCredentials();
130 
141  ClientConfig &setConnectionAttemptLimit(int connectionAttemptLimit);
142 
152  int getConnectionAttemptLimit() const;
153 
158  ClientConfig &setConnectionTimeout(int connectionTimeoutInMillis);
159 
164  int getConnectionTimeout() const;
165 
174  ClientConfig &setAttemptPeriod(int attemptPeriodInMillis);
175 
183  int getAttemptPeriod() const;
184 
196  ClientConfig &setRedoOperation(bool redoOperation);
197 
203  bool isRedoOperation() const;
204 
211  bool isSmart() const;
212 
225  ClientConfig &setSmart(bool smart);
226 
232  ClientConfig &setSocketInterceptor(SocketInterceptor *socketInterceptor);
233 
237  SocketInterceptor *getSocketInterceptor();
238 
249  ClientConfig &addListener(LifecycleListener *listener);
250 
255  const std::set<LifecycleListener *> &getLifecycleListeners() const;
256 
269  ClientConfig &addListener(MembershipListener *listener);
270 
281  ClientConfig &addListener(const boost::shared_ptr<MembershipListener> &listener);
282 
288  const std::set<MembershipListener *> &getMembershipListeners() const;
289 
296  const std::set<boost::shared_ptr<MembershipListener> > &getManagedMembershipListeners() const;
297 
306  ClientConfig &addListener(InitialMembershipListener *listener);
307 
314  ClientConfig &addListener(const boost::shared_ptr<InitialMembershipListener> &listener);
315 
321  LoadBalancer *const getLoadBalancer();
322 
331  ClientConfig &setLoadBalancer(LoadBalancer *loadBalancer);
332 
343  ClientConfig &setLogLevel(LogLevel loggerLevel);
344 
349  SerializationConfig &getSerializationConfig();
350 
360  ClientConfig &setSerializationConfig(SerializationConfig const &serializationConfig);
361 
367  std::map<std::string, std::string> &getProperties();
368 
378  ClientConfig &setProperty(const std::string &name, const std::string &value);
379 
386  ClientConfig &addReliableTopicConfig(const config::ReliableTopicConfig &reliableTopicConfig);
387 
394  const config::ReliableTopicConfig *getReliableTopicConfig(const std::string &name);
395 
405  template <typename K, typename V>
406  ClientConfig &addNearCacheConfig(const boost::shared_ptr<config::NearCacheConfig<K, V> > nearCacheConfig) {
407  nearCacheConfigMap.put(nearCacheConfig->getName(), nearCacheConfig);
408  return *this;
409  }
410 
420  ClientConfig &addMixedNearCacheConfig(const boost::shared_ptr<mixedtype::config::MixedNearCacheConfig> nearCacheConfig) {
421  nearCacheConfigMap.put(nearCacheConfig->getName(), nearCacheConfig);
422  return *this;
423  }
424 
432  template <typename K, typename V>
433  const boost::shared_ptr<config::NearCacheConfig<K, V> > getNearCacheConfig(const std::string &name) {
434  boost::shared_ptr<config::NearCacheConfigBase> nearCacheConfig = internal::config::ConfigUtils::lookupByPattern<config::NearCacheConfigBase>(
435  configPatternMatcher, nearCacheConfigMap, name);
436  if (nearCacheConfig.get() == NULL) {
437  nearCacheConfig = nearCacheConfigMap.get("default");
438  }
439  // not needed for c++ client since it is always native memory
440  //initDefaultMaxSizeForOnHeapMaps(nearCacheConfig);
441  return boost::static_pointer_cast<config::NearCacheConfig<K, V> >(nearCacheConfig);
442  }
443 
444  const boost::shared_ptr<mixedtype::config::MixedNearCacheConfig> getMixedNearCacheConfig(const std::string &name);
445 
452  config::ClientNetworkConfig &getNetworkConfig();
453 
461  ClientConfig &setNetworkConfig(const config::ClientNetworkConfig &networkConfig);
462 
463  const boost::shared_ptr<std::string> &getInstanceName() const;
464 
465  void setInstanceName(const boost::shared_ptr<std::string> &instanceName);
466 
472  int32_t getExecutorPoolSize() const;
473 
480  void setExecutorPoolSize(int32_t executorPoolSize);
481 
482  config::ClientConnectionStrategyConfig &getConnectionStrategyConfig();
483 
484  ClientConfig &
485  setConnectionStrategyConfig(const config::ClientConnectionStrategyConfig &connectionStrategyConfig);
486 
502  boost::shared_ptr<config::ClientFlakeIdGeneratorConfig> findFlakeIdGeneratorConfig(const std::string &name);
503 
529  boost::shared_ptr<config::ClientFlakeIdGeneratorConfig> getFlakeIdGeneratorConfig(const std::string &name);
530 
539  ClientConfig &addFlakeIdGeneratorConfig(const boost::shared_ptr<config::ClientFlakeIdGeneratorConfig> &config);
540 
541  private:
542  GroupConfig groupConfig;
543 
544  config::ClientNetworkConfig networkConfig;
545 
546  SerializationConfig serializationConfig;
547 
548  LoadBalancer *loadBalancer;
549 
550  impl::RoundRobinLB defaultLoadBalancer;
551 
552  std::set<MembershipListener *> membershipListeners;
553  std::set<boost::shared_ptr<MembershipListener> > managedMembershipListeners;
554 
555  std::set<LifecycleListener *> lifecycleListeners;
556 
557  std::map<std::string, std::string> properties;
558 
559  bool redoOperation;
560 
561  SocketInterceptor *socketInterceptor;
562 
563  Credentials *credentials;
564 
565  std::map<std::string, config::ReliableTopicConfig> reliableTopicConfigMap;
566 
567  util::SynchronizedMap<std::string, config::NearCacheConfigBase> nearCacheConfigMap;
568 
569  boost::shared_ptr<std::string> instanceName;
570 
574  int32_t executorPoolSize;
575 
576  config::ClientConnectionStrategyConfig connectionStrategyConfig;
577 
578  util::SynchronizedMap<std::string, config::ClientFlakeIdGeneratorConfig> flakeIdGeneratorConfigMap;
579 
581  };
582 
583  }
584 }
585 
586 #if defined(WIN32) || defined(_WIN32) || defined(WIN64) || defined(_WIN64)
587 #pragma warning(pop)
588 #endif
589 
590 #endif /* HAZELCAST_CLIENT_CONFIG */
Credentials is a container object for endpoint (Members and Clients) security attributes.
Definition: Credentials.h:35
Contains configuration parameters for client network related behaviour.
Definition: ClientNetworkConfig.h:37
Contains the configuration for a Near Cache.
Definition: NearCacheConfig.h:44
Base class for socketInterceptor classes to inherit from.
Definition: SocketInterceptor.h:33
Contains the configuration for Hazelcast groups.
Definition: GroupConfig.h:36
Cluster membership listener.
Definition: MembershipListener.h:64
IP Address.
Definition: Address.h:41
Client connection strategy configuration is used for setting custom strategies and configuring strate...
Definition: ClientConnectionStrategyConfig.h:32
ClientConfig & addNearCacheConfig(const boost::shared_ptr< config::NearCacheConfig< K, V > > nearCacheConfig)
Helper method to add a new NearCacheConfig.
Definition: ClientConfig.h:406
const boost::shared_ptr< config::NearCacheConfig< K, V > > getNearCacheConfig(const std::string &name)
Gets the NearCacheConfig configured for the map / cache with name.
Definition: ClientConfig.h:433
SerializationConfig is used to.
Definition: SerializationConfig.h:49
ClientConfig & addMixedNearCacheConfig(const boost::shared_ptr< mixedtype::config::MixedNearCacheConfig > nearCacheConfig)
Helper method to add a new NearCacheConfig.
Definition: ClientConfig.h:420
Listener object for listening lifecycle events of hazelcast instance.
Definition: LifecycleListener.h:44
The InitializingMembershipListener is a MembershipListener that will first receives a InitialMembersh...
Definition: InitialMembershipListener.h:57
LoadBalancer allows you to send operations to one of a number of endpoints(Members).
Definition: LoadBalancer.h:38
PN (Positive-Negative) CRDT counter.
Definition: MapEntryView.h:32
HazelcastClient configuration class.
Definition: ClientConfig.h:58
Definition: ReliableTopicConfig.h:30
This.
Definition: MatchingPointConfigPatternMatcher.h:35