hazelcast::client::config::client_network_config Class Reference

Contains configuration parameters for client network related behaviour. More...

#include <client_network_config.h>

Public Member Functions
	client_network_config ()
	Constructor with default values. More...
ssl_config &	get_ssl_config ()
	Returns the current . More...
client_network_config &	set_ssl_config (const config::ssl_config &config)
	Sets the ssl_config. More...
client_network_config &	set_connection_timeout (const std::chrono::milliseconds &timeout)
std::chrono::milliseconds	get_connection_timeout () const
	Connection timeout value for connecting to a member server. More...
client_network_config &	set_aws_config (const client_aws_config &client_aws_config)
	Sets configuration to connect nodes in aws environment. More...
client_aws_config &	get_aws_config ()
	Returns the current client_aws_config. More...
bool	is_smart_routing () const
	See client_network_config::setSmartRouting(boolean) for details. More...
client_network_config &	set_smart_routing (bool smart_routing)
	If. More...
std::vector< address >	get_addresses () const
	Returns the list of candidate addresses that client will use to establish initial connection. More...
client_network_config &	add_addresses (const std::vector< address > &addresses)
	Adds given addresses to candidate address list that client will use to establish initial connection. More...
client_network_config &	set_addresses (const std::vector< address > &addresses)
	Adds given addresses to candidate address list that client will use to establish initial connection. More...
client_network_config &	add_address (const address &address)
	Adds given address to candidate address list that client will use to establish initial connection. More...
socket_options &	get_socket_options ()

Detailed Description

Contains configuration parameters for client network related behaviour.

Constructor & Destructor Documentation

client_network_config()

hazelcast::client::config::client_network_config::client_network_config

(

)

Constructor with default values.

connectionTimeout(5000)

Member Function Documentation

add_address()

client_network_config & hazelcast::client::config::client_network_config::add_address

(

const address &

address

)

Adds given address to candidate address list that client will use to establish initial connection.

Parameters

address

to be added to initial address list

Returns

configured for chaining

add_addresses()

client_network_config & hazelcast::client::config::client_network_config::add_addresses

(

const std::vector< address > &

addresses

)

Adds given addresses to candidate address list that client will use to establish initial connection.

Parameters

addresses

to be added to initial address list

Returns

configured for chaining

get_addresses()

std::vector< address > hazelcast::client::config::client_network_config::get_addresses

(

)

const

Returns the list of candidate addresses that client will use to establish initial connection.

Returns

list of addresses

get_aws_config()

client_aws_config & hazelcast::client::config::client_network_config::get_aws_config

(

)

Returns the current client_aws_config.

Returns

client_aws_config

get_connection_timeout()

std::chrono::milliseconds hazelcast::client::config::client_network_config::get_connection_timeout

(

)

const

Connection timeout value for connecting to a member server.

Returns

connection timeout set for a single connection attempt.

get_ssl_config()

ssl_config & hazelcast::client::config::client_network_config::get_ssl_config

(

)

Returns the current .

Returns

the ssl_config .

See also

# set_ssl_config (ssl_config )

is_smart_routing()

bool hazelcast::client::config::client_network_config::is_smart_routing

(

)

const

See client_network_config::setSmartRouting(boolean) for details.

Returns

true if client is smart

set_addresses()

client_network_config & hazelcast::client::config::client_network_config::set_addresses

(

const std::vector< address > &

addresses

)

Adds given addresses to candidate address list that client will use to establish initial connection.

Parameters

addresses

to be added to initial address list

Returns

configured for chaining

set_aws_config()

client_network_config & hazelcast::client::config::client_network_config::set_aws_config

(

const client_aws_config &

client_aws_config

)

Sets configuration to connect nodes in aws environment.

Parameters

clientAwsConfig

the client_aws_config

See also

get_aws_config()

set_connection_timeout()

client_network_config & hazelcast::client::config::client_network_config::set_connection_timeout

(

const std::chrono::milliseconds &

timeout

)

Parameters

connectionTimeout

Timeout value for nodes to accept client connection requests. A zero value means wait until connection established or an error occurs. The resolution of time is up to milliseconds.

Returns

itself client_network_config

set_smart_routing()

client_network_config & hazelcast::client::config::client_network_config::set_smart_routing

(

bool

smart_routing

)

If.

true 

, client will route the key based operations to owner of the key on best-effort basis. 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.

If

smartRouting == false 

, all operations will be routed to single member. Operations will need two hops if the chosen member is not owner of the key. Client will have only single open connection. Useful, if there are many clients and we want to avoid each of them connecting to each member.

Default value is

true 

.

Parameters

smartRouting

true if smart routing should be enabled.

Returns

configured client_network_config for chaining

set_ssl_config()

client_network_config & hazelcast::client::config::client_network_config::set_ssl_config

(

const config::ssl_config &

config

)

Sets the ssl_config.

Parameters

config

the ssl_config .

Returns

the updated client_network_config.

See also

# get_ssl_config ()

---

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

• hazelcast/include/hazelcast/client/config/client_network_config.h
• hazelcast/src/hazelcast/client/config.cpp