HazelcastClient configuration class. More...

#include <ClientConfig.h>

Public Member Functions
	ClientConfig ()
	Constructor with default values. More...

ClientConfig &	addAddress (const Address &address)
	Adds an address to list of the initial addresses. More...

ClientConfig &	addAddresses (const std::vector< Address > &addresses)
	Adds all address in given vector to list of the initial addresses. More...

std::set< Address, addressComparator > &	getAddresses ()
	Returns set of the initial addresses. More...

ClientConfig &	setGroupConfig (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)
	While client is trying to connect initially to one of the members in the ClientConfig::addressList, all might be not available. More...

int	getConnectionAttemptLimit () const
	While client is trying to connect initially to one of the members in the ClientConfig::addressList, all might be not available. More...

ClientConfig &	setConnectionTimeout (int connectionTimeoutInMillis)
	Use ClientNetworkConfig#setConnectionTimeout instead .

int	getConnectionTimeout () const
	Use ClientNetworkConfig#getConnectionTimeout instead .

ClientConfig &	setAttemptPeriod (int attemptPeriodInMillis)
	Period for the next attempt to find a member to connect. More...

int	getAttemptPeriod () const
	Period for the next attempt to find a member to connect. More...

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)
	If true, client will route the key based operations to owner of the key at the best effort. More...

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)
	Adds a listener to configuration to be registered when HazelcastClient starts. More...

const std::set< MembershipListener * > &	getMembershipListeners () const
	Returns registered membershipListeners. More...

ClientConfig &	addListener (InitialMembershipListener *listener)
	Adds a listener to configuration to be registered when HazelcastClient starts. More...

const std::set< InitialMembershipListener * > &	getInitialMembershipListeners () const
	Returns registered initialMembershipListeners. 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 = 100, WARNING = 90, INFO = 50 }; 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...

Detailed Description

HazelcastClient configuration class.

Constructor & Destructor Documentation

hazelcast::client::ClientConfig::ClientConfig ( )

Constructor with default values.

smart(true) redoOperation(false) connectionAttemptLimit(2) attemptPeriod(3000) defaultLoadBalancer(impl::RoundRobinLB)

Member Function Documentation

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.

Parameters

address

Returns: itself ClientConfig

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.

Parameters

addresses vector of addresses

Returns: itself ClientConfig

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.

Parameters

listener LifecycleListener *listener

Returns: itself ClientConfig

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.

Parameters

listener MembershipListener *listener

Returns: itself ClientConfig

ClientConfig & hazelcast::client::ClientConfig::addListener ( InitialMembershipListener * listener )

Adds a listener to configuration to be registered when HazelcastClient starts.

Parameters

listener InitialMembershipListener *listener

Returns: itself ClientConfig

ClientConfig& hazelcast::client::ClientConfig::addMixedNearCacheConfig ( const boost::shared_ptr< mixedtype::config::MixedNearCacheConfig > nearCacheConfig )

inline

Helper method to add a new NearCacheConfig.

Parameters

nearCacheConfig com.hazelcast.config.NearCacheConfig to be added

Returns: configured com.hazelcast.client.config.ClientConfig for chaining

See also: com.hazelcast.config.NearCacheConfig

Memory ownership of the config is passed to the client config

template<typename K , typename V >

ClientConfig& hazelcast::client::ClientConfig::addNearCacheConfig ( const boost::shared_ptr< config::NearCacheConfig< K, V > > nearCacheConfig )

inline

Helper method to add a new NearCacheConfig.

Parameters

nearCacheConfig com.hazelcast.config.NearCacheConfig to be added

Returns: configured com.hazelcast.client.config.ClientConfig for chaining

See also: com.hazelcast.config.NearCacheConfig

Memory ownership of the config is passed to the client config

ClientConfig & hazelcast::client::ClientConfig::addReliableTopicConfig ( const config::ReliableTopicConfig & reliableTopicConfig )

Adds a ClientReliableTopicConfig.

Parameters

reliableTopicConfig the ReliableTopicConfig to add

Returns: configured ClientConfig for chaining

std::set< Address, addressComparator > & hazelcast::client::ClientConfig::getAddresses ( )

Returns set of the initial addresses.

Client will use this vector to find a running Member, connect to it.

Returns: vector of addresses

int hazelcast::client::ClientConfig::getAttemptPeriod ( ) const

Period for the next attempt to find a member to connect.

(see ClientConfig::connectionAttemptLimit ).

Returns: int attemptPeriodInMillis

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

GroupConfig & hazelcast::client::ClientConfig::getGroupConfig ( )

Returns: groupConfig

const std::set< InitialMembershipListener * > & hazelcast::client::ClientConfig::getInitialMembershipListeners ( ) const

Returns registered initialMembershipListeners.

Returns: registered initialMembershipListeners

const std::set< LifecycleListener * > & hazelcast::client::ClientConfig::getLifecycleListeners ( ) const

Returns: registered lifecycleListeners

LoadBalancer *const hazelcast::client::ClientConfig::getLoadBalancer ( )

Used to distribute the operations to multiple Endpoints.

Returns: loadBalancer

const std::set< MembershipListener * > & hazelcast::client::ClientConfig::getMembershipListeners ( ) const

Returns registered membershipListeners.

Returns: registered membershipListeners

template<typename K , typename V >

const boost::shared_ptr<config::NearCacheConfig<K, V> > hazelcast::client::ClientConfig::getNearCacheConfig ( const std::string & name )

inline

Gets the NearCacheConfig configured for the map / cache with name.

Parameters

name	name of the map / cache

Returns: Configured NearCacheConfig

See also: com.hazelcast.config.NearCacheConfig

config::ClientNetworkConfig & hazelcast::client::ClientConfig::getNetworkConfig ( )

Gets com.hazelcast.client.config.ClientNetworkConfig.

Returns: com.hazelcast.client.config.ClientNetworkConfig

See also: com.hazelcast.client.config.ClientNetworkConfig

std::map< std::string, std::string > & hazelcast::client::ClientConfig::getProperties ( )

Gets a reference to properties map.

Returns: properties map

const config::ReliableTopicConfig * hazelcast::client::ClientConfig::getReliableTopicConfig ( const std::string & name )

Gets the ClientReliableTopicConfig for a given reliable topic name.

Parameters

name	the name of the reliable topic

Returns: the found config. If none is found, a default configured one is returned.

SerializationConfig & hazelcast::client::ClientConfig::getSerializationConfig ( )

Returns: serializationConfig

bool hazelcast::client::ClientConfig::isSmart ( ) const

Returns: true if client configured as smart see setSmart()

ClientConfig & hazelcast::client::ClientConfig::setAttemptPeriod ( int attemptPeriodInMillis )

Period for the next attempt to find a member to connect.

(see ClientConfig::connectionAttemptLimit ).

Parameters

attemptPeriodInMillis

Returns: itself ClientConfig

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.

Parameters

connectionAttemptLimit

Returns: itself ClientConfig

ClientConfig & hazelcast::client::ClientConfig::setCredentials ( Credentials * credentials )

Can be used instead of GroupConfig in Hazelcast Extensions.

Returns: itself ClientConfig

ClientConfig & hazelcast::client::ClientConfig::setGroupConfig ( GroupConfig & groupConfig )

The Group Configuration properties like: Name and Password that is used to connect to the cluster.

Parameters

groupConfig

Returns: itself ClientConfig

ClientConfig & hazelcast::client::ClientConfig::setLoadBalancer ( LoadBalancer * loadBalancer )

Used to distribute the operations to multiple Endpoints.

If not set, RoundRobin based load balancer is used

Parameters

loadBalancer

Returns: itself ClientConfig

ClientConfig & hazelcast::client::ClientConfig::setLogLevel ( LogLevel loggerLevel )

enum LogLevel { SEVERE = 100, WARNING = 90, INFO = 50 }; set INFO to see every log.

set WARNING to see only possible warnings and serious errors. set SEVERE to see only serious errors

Default log level is INFO

Returns: itself ClientConfig

ClientConfig & hazelcast::client::ClientConfig::setNetworkConfig ( const config::ClientNetworkConfig & networkConfig )

Sets com.hazelcast.client.config.ClientNetworkConfig.

Parameters

networkConfig com.hazelcast.client.config.ClientNetworkConfig to be set

Returns: configured com.hazelcast.client.config.ClientConfig for chaining

See also: com.hazelcast.client.config.ClientNetworkConfig

ClientConfig & hazelcast::client::ClientConfig::setProperty	(	const std::string &	name,
		const std::string &	value
	)

Sets the value of a named property.

See also: ClientProperties for properties that is used to configure client

Parameters

name	property name
value	value of the property

Returns: itself ClientConfig

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.

Parameters

redoOperation return itself ClientConfig

ClientConfig & hazelcast::client::ClientConfig::setSerializationConfig ( SerializationConfig const & serializationConfig )

SerializationConfig is used to.

set version of portable classes in this client (
See also
Portable)
register custom serializers to be used (
See also
Serializer ,

SerializationConfig::registerSerializer)

Parameters

serializationConfig

Returns
itself ClientConfig

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.

Parameters

smart

Returns: itself ClientConfig

ClientConfig & hazelcast::client::ClientConfig::setSocketInterceptor ( SocketInterceptor * socketInterceptor )

Will be called with the Socket, each time client creates a connection to any Member.

Returns: itself ClientConfig

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

hazelcast/include/hazelcast/client/ClientConfig.h
hazelcast/src/hazelcast/client/ClientConfig.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation