hazelcast::client::config::client_connection_strategy_config Class Reference

Client connection strategy configuration is used for setting custom strategies and configuring strategy parameters. More...

#include <client_connection_strategy_config.h>

Public Types
enum	reconnect_mode { OFF , ON , ASYNC }
	Reconnect options. More...

Public Member Functions
bool	is_async_start () const
	Client instance creation won't block on hazelcast_client(ClientConfig &) if this value is true.
client_connection_strategy_config &	set_async_start (bool async_start)
	Set true for non blocking hazelcast_client(const client_config &).
reconnect_mode	get_reconnect_mode () const
client_connection_strategy_config &	set_reconnect_mode (reconnect_mode reconnect_mode)
	How a client reconnect to cluster after a disconnect can be configured.
connection_retry_config &	get_retry_config ()
	connection_retry_config controls the period among the retries and when a client should give up retrying.
client_connection_strategy_config &	set_retry_config (connection_retry_config retry_config)
	connection_retry_config controls the period among the retries and when a client should give up retrying.

Detailed Description

Client connection strategy configuration is used for setting custom strategies and configuring strategy parameters.

Definition at line 33 of file client_connection_strategy_config.h.

Member Enumeration Documentation

reconnect_mode

enum hazelcast::client::config::client_connection_strategy_config::reconnect_mode

Reconnect options.

Enumerator
OFF	Prevent reconnect to cluster after a disconnect.
ON	Reconnect to cluster by blocking invocations.
ASYNC	Reconnect to cluster without blocking invocations. Invocations will receive hazelcast_client_offline

Definition at line 41 of file client_connection_strategy_config.h.

    {
        OFF,
        ON,
        ASYNC
    };

Constructor & Destructor Documentation

client_connection_strategy_config()

hazelcast::client::config::client_connection_strategy_config::client_connection_strategy_config

(

)

Definition at line 431 of file config.cpp.

  : async_start_(false)
  , reconnect_mode_(ON)
{}

Member Function Documentation

get_reconnect_mode()

client_connection_strategy_config::reconnect_mode hazelcast::client::config::client_connection_strategy_config::get_reconnect_mode

(

)

const

Returns

reconnect mode

Definition at line 437 of file config.cpp.

{
    return reconnect_mode_;
}

get_retry_config()

connection_retry_config & hazelcast::client::config::client_connection_strategy_config::get_retry_config

(

)

connection_retry_config controls the period among the retries and when a client should give up retrying.

Exponential behaviour can be chosen or jitter can be added to wait periods.

Returns

connection_retry_config the connection retry config to read or modify.

Definition at line 464 of file config.cpp.

{
    return retry_config_;
}

is_async_start()

bool hazelcast::client::config::client_connection_strategy_config::is_async_start

(

)

const

Client instance creation won't block on hazelcast_client(ClientConfig &) if this value is true.

Returns

if client connects to cluster asynchronously

Definition at line 443 of file config.cpp.

{
    return async_start_;
}

set_async_start()

client_connection_strategy_config & hazelcast::client::config::client_connection_strategy_config::set_async_start

(

bool

async_start

)

Set true for non blocking hazelcast_client(const client_config &).

The client creation won't wait to connect to cluster. The client instace will throw exception until it connects to cluster and become ready. If set to false, hazelcast_client(const client_config &) will block until a cluster connection established and it's ready to use client instance

default value is false

Parameters

asyncStart

true for async client creation

Returns

the updated ClientConnectionStrategyConfig

Definition at line 449 of file config.cpp.

{
    this->async_start_ = async_start;
    return *this;
}

set_reconnect_mode()

client_connection_strategy_config & hazelcast::client::config::client_connection_strategy_config::set_reconnect_mode

(

reconnect_mode

reconnect_mode

)

How a client reconnect to cluster after a disconnect can be configured.

This parameter is used by default strategy and custom implementations may ignore it if configured. default value is ReconnectMode#ON

Parameters

reconnectMode

Returns

the updated ClientConnectionStrategyConfig

Definition at line 456 of file config.cpp.

{
    this->reconnect_mode_ = reconnect_mode;
    return *this;
}

set_retry_config()

client_connection_strategy_config & hazelcast::client::config::client_connection_strategy_config::set_retry_config

(

connection_retry_config

retry_config

)

connection_retry_config controls the period among the retries and when a client should give up retrying.

Exponential behaviour can be chosen or jitter can be added to wait periods.

Parameters

connection_retry_config

the connection retry config to read or modify.

Returns

the updated client_connection_strategy_config

Definition at line 470 of file config.cpp.

{
    retry_config_ = std::move(retry_config);
    return *this;
}

---

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

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