hazelcast::client::config::connection_retry_config Class Reference

Connection Retry Config is controls the period among the retries and when should a client gave up retrying. More...

#include <connection_retry_config.h>

Public Member Functions
std::chrono::milliseconds	get_initial_backoff_duration () const
	how long to wait after the first failure before retrying More...
connection_retry_config &	set_initial_backoff_duration (std::chrono::milliseconds initial_backoff_duration)
std::chrono::milliseconds	get_max_backoff_duration () const
	When backoff reaches this upper bound, it does not increase any more. More...
connection_retry_config &	set_max_backoff_duration (std::chrono::milliseconds max_backoff_duration)
	When backoff reaches this upper bound, it does not increase any more. More...
double	get_multiplier () const
	factor with which to multiply backoff time after a failed retry More...
connection_retry_config &	set_multiplier (double multiplier)
std::chrono::milliseconds	get_cluster_connect_timeout () const
	Timeout value for the client to give up to connect to the current cluster Theclient can shutdown after reaching the timeout. More...
connection_retry_config &	set_cluster_connect_timeout (std::chrono::milliseconds cluster_connect_timeout)
double	get_jitter () const
	by how much to randomize backoffs. More...
connection_retry_config &	set_jitter (double jitter)
	At each iteration calculated back-off is randomized via following method random(-jitter * current_backoff, jitter * current_backoff) More...

Detailed Description

Connection Retry Config is controls the period among the retries and when should a client gave up retrying.

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

Definition at line 35 of file connection_retry_config.h.

Member Function Documentation

get_cluster_connect_timeout()

std::chrono::milliseconds hazelcast::client::config::connection_retry_config::get_cluster_connect_timeout

(

)

const

Timeout value for the client to give up to connect to the current cluster Theclient can shutdown after reaching the timeout.

Returns

cluster_connect_timeout_

Definition at line 288 of file config.cpp.

{
    return cluster_connect_timeout_;
}

get_initial_backoff_duration()

std::chrono::milliseconds hazelcast::client::config::connection_retry_config::get_initial_backoff_duration

(

)

const

how long to wait after the first failure before retrying

Returns

initial_backoff_duration_

Definition at line 240 of file config.cpp.

{
    return initial_backoff_duration_;
}

get_jitter()

double hazelcast::client::config::connection_retry_config::get_jitter

(

)

const

by how much to randomize backoffs.

At each iteration calculated back-off is randomized via following method random(-jitter * current_backoff, jitter * current_backoff)

Returns

jitter_

Definition at line 305 of file config.cpp.

{
    return jitter_;
}

get_max_backoff_duration()

std::chrono::milliseconds hazelcast::client::config::connection_retry_config::get_max_backoff_duration

(

)

const

When backoff reaches this upper bound, it does not increase any more.

Returns

max_backoff_duration_

Definition at line 257 of file config.cpp.

{
    return max_backoff_duration_;
}

get_multiplier()

double hazelcast::client::config::connection_retry_config::get_multiplier

(

)

const

factor with which to multiply backoff time after a failed retry

Returns

multiplier_

Definition at line 273 of file config.cpp.

{
    return multiplier_;
}

set_cluster_connect_timeout()

connection_retry_config & hazelcast::client::config::connection_retry_config::set_cluster_connect_timeout

(

std::chrono::milliseconds

cluster_connect_timeout

)

Parameters

cluster_connect_timeout

timeout for the client to give up to connect to the current cluster The client can shutdown after reaching the timeout.

Returns

updated connection_retry_config

Definition at line 294 of file config.cpp.

{
    util::Preconditions::check_not_negative(
      cluster_connect_timeout.count(),
      "Cluster connect timeout must be non-negative!");
    cluster_connect_timeout_ = cluster_connect_timeout;
    return *this;
}

set_initial_backoff_duration()

connection_retry_config & hazelcast::client::config::connection_retry_config::set_initial_backoff_duration

(

std::chrono::milliseconds

initial_backoff_duration

)

Parameters

initial_backoff_duration

how long to wait after the first failure before retrying

Returns

updated connection_retry_config

Definition at line 246 of file config.cpp.

{
    util::Preconditions::check_not_negative(
      initial_backoff_duration.count(),
      "Initial backoff must be non-negative!");
    initial_backoff_duration_ = initial_backoff_duration;
    return *this;
}

set_jitter()

connection_retry_config & hazelcast::client::config::connection_retry_config::set_jitter

(

double

jitter

)

At each iteration calculated back-off is randomized via following method random(-jitter * current_backoff, jitter * current_backoff)

Parameters

jitter

by how much to randomize backoffs

Returns

updated connection_retry_config

Definition at line 311 of file config.cpp.

{
    util::Preconditions::check_true(jitter >= 0.0 && jitter <= 1.0,
                                    "Jitter must be in range [0.0, 1.0]");
    jitter_ = jitter;
    return *this;
}

set_max_backoff_duration()

connection_retry_config & hazelcast::client::config::connection_retry_config::set_max_backoff_duration

(

std::chrono::milliseconds

max_backoff_duration

)

When backoff reaches this upper bound, it does not increase any more.

Parameters

max_backoff_duration

upper bound on backoff

Returns

updated connection_retry_config

Definition at line 263 of file config.cpp.

{
    util::Preconditions::check_not_negative(
      max_backoff_duration.count(), "Max backoff must be non-negative!");
    max_backoff_duration_ = max_backoff_duration;
    return *this;
}

set_multiplier()

connection_retry_config & hazelcast::client::config::connection_retry_config::set_multiplier

(

double

multiplier

)

Parameters

multiplier

factor with which to multiply backoff after a failed retry

Returns

updated connection_retry_config

Definition at line 279 of file config.cpp.

{
    util::Preconditions::check_true(
      m >= 1.0, "Multiplier must be greater than or equal to 1.0!");
    multiplier_ = m;
    return *this;
}

---

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

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