Hazelcast C++ Client
 All Classes Functions Variables Enumerations Enumerator Pages
ClientConfig.h
1 /*
2  * Copyright (c) 2008-2017, 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 <memory>
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/client/config/ReliableTopicConfig.h"
32 #include "hazelcast/client/config/NearCacheConfig.h"
33 #include "hazelcast/util/SynchronizedMap.h"
34 
35 #if defined(WIN32) || defined(_WIN32) || defined(WIN64) || defined(_WIN64)
36 #pragma warning(push)
37 #pragma warning(disable: 4251) //for dll export
38 #endif
39 
40 namespace hazelcast {
41  namespace client {
42  class MembershipListener;
43 
44  class InitialMembershipListener;
45 
46  class LifecycleListener;
47 
51  class HAZELCAST_API ClientConfig {
52  public:
53 
63  ClientConfig();
64 
72  ClientConfig &addAddress(const Address &address);
73 
81  ClientConfig &addAddresses(const std::vector<Address> &addresses);
82 
89  std::set<Address, addressComparator> &getAddresses();
90 
98  ClientConfig &setGroupConfig(GroupConfig &groupConfig);
99 
104  GroupConfig &getGroupConfig();
105 
111  ClientConfig &setCredentials(Credentials *credentials);
112 
116  const Credentials *getCredentials();
117 
126  ClientConfig &setConnectionAttemptLimit(int connectionAttemptLimit);
127 
135  int getConnectionAttemptLimit() const;
136 
143  ClientConfig &setConnectionTimeout(int connectionTimeoutInMillis);
144 
150  int getConnectionTimeout() const;
151 
158  ClientConfig &setAttemptPeriod(int attemptPeriodInMillis);
159 
165  int getAttemptPeriod() const;
166 
178  ClientConfig &setRedoOperation(bool redoOperation);
179 
185  bool isRedoOperation() const;
186 
191  bool isSmart() const;
192 
203  ClientConfig &setSmart(bool smart);
204 
210  ClientConfig &setSocketInterceptor(SocketInterceptor *socketInterceptor);
211 
215  SocketInterceptor *getSocketInterceptor();
216 
227  ClientConfig &addListener(LifecycleListener *listener);
228 
233  const std::set<LifecycleListener *> &getLifecycleListeners() const;
234 
245  ClientConfig &addListener(MembershipListener *listener);
246 
252  const std::set<MembershipListener *> &getMembershipListeners() const;
253 
260  ClientConfig &addListener(InitialMembershipListener *listener);
261 
267  const std::set<InitialMembershipListener *> &getInitialMembershipListeners() const;
268 
274  LoadBalancer *const getLoadBalancer();
275 
284  ClientConfig &setLoadBalancer(LoadBalancer *loadBalancer);
285 
295  ClientConfig &setLogLevel(LogLevel loggerLevel);
296 
297 
302  SerializationConfig const &getSerializationConfig() const;
303 
313  ClientConfig &setSerializationConfig(SerializationConfig const &serializationConfig);
314 
320  std::map<std::string, std::string> &getProperties();
321 
331  ClientConfig &setProperty(const std::string &name, const std::string &value);
332 
339  ClientConfig &addReliableTopicConfig(const config::ReliableTopicConfig &reliableTopicConfig);
340 
347  const config::ReliableTopicConfig *getReliableTopicConfig(const std::string &name);
348 
358  template <typename K, typename V>
359  ClientConfig &addNearCacheConfig(const boost::shared_ptr<config::NearCacheConfig<K, V> > nearCacheConfig) {
360  nearCacheConfigMap.put(nearCacheConfig->getName(), nearCacheConfig);
361  return *this;
362  }
363 
371  template <typename K, typename V>
372  const config::NearCacheConfig<K, V> *getNearCacheConfig(const std::string &name) {
373  boost::shared_ptr<config::NearCacheConfigBase> nearCacheConfig = lookupByPattern(name);
374  if (nearCacheConfig.get() == NULL) {
375  nearCacheConfig = nearCacheConfigMap.get("default");
376  }
377  // not needed for c++ client since it is always native memory
378  //initDefaultMaxSizeForOnHeapMaps(nearCacheConfig);
379  return boost::static_pointer_cast<config::NearCacheConfig<K, V> >(nearCacheConfig).get();
380  }
381  private:
382 
383  GroupConfig groupConfig;
384 
385  SerializationConfig serializationConfig;
386 
387  std::set<Address, addressComparator> addressList;
388 
389  LoadBalancer *loadBalancer;
390 
391  std::auto_ptr<impl::RoundRobinLB> defaultLoadBalancer;
392 
393  std::set<MembershipListener *> membershipListeners;
394 
395  std::set<InitialMembershipListener *> initialMembershipListeners;
396 
397  std::set<LifecycleListener *> lifecycleListeners;
398 
399  std::map<std::string, std::string> properties;
400 
401  bool smart;
402 
403  bool redoOperation;
404 
405  int connectionTimeout;
406 
407  int connectionAttemptLimit;
408 
409  int attemptPeriod;
410 
411  SocketInterceptor *socketInterceptor;
412 
413  Credentials *credentials;
414 
415  std::auto_ptr<Credentials> defaultCredentials;
416 
417  std::map<std::string, config::ReliableTopicConfig> reliableTopicConfigMap;
418 
419  util::SynchronizedMap<std::string, config::NearCacheConfigBase> nearCacheConfigMap;
420 
421  const boost::shared_ptr<config::NearCacheConfigBase> lookupByPattern(const std::string &name) {
422  // TODO: implement the lookup
423  return nearCacheConfigMap.get(name);
424  }
425  };
426 
427  }
428 }
429 
430 #if defined(WIN32) || defined(_WIN32) || defined(WIN64) || defined(_WIN64)
431 #pragma warning(pop)
432 #endif
433 
434 #endif /* HAZELCAST_CLIENT_CONFIG */
Credentials is a container object for endpoint (Members and Clients) security attributes.
Definition: Credentials.h:35
Contains the configuration for a Near Cache.
Definition: NearCacheConfig.h:42
Base class for socketInterceptor classes to inherit from.
Definition: SocketInterceptor.h:37
Contains the configuration for Hazelcast groups.
Definition: GroupConfig.h:36
Cluster membership listener.
Definition: MembershipListener.h:51
IP Address.
Definition: Address.h:36
ClientConfig & addNearCacheConfig(const boost::shared_ptr< config::NearCacheConfig< K, V > > nearCacheConfig)
Helper method to add a new NearCacheConfig.
Definition: ClientConfig.h:359
SerializationConfig is used to.
Definition: SerializationConfig.h:44
Listener object for listening lifecycle events of hazelcast instance.
Definition: LifecycleListener.h:44
const config::NearCacheConfig< K, V > * getNearCacheConfig(const std::string &name)
Gets the NearCacheConfig configured for the map / cache with name.
Definition: ClientConfig.h:372
The InitializingMembershipListener is a MembershipListener that will first receives a InitialMembersh...
Definition: InitialMembershipListener.h:50
LoadBalancer allows you to send operations to one of a number of endpoints(Members).
Definition: LoadBalancer.h:40
HazelcastClient configuration class.
Definition: ClientConfig.h:51
Definition: ReliableTopicConfig.h:30