Hazelcast C++ Client
Hazelcast C++ Client Library
Loading...
Searching...
No Matches
hazelcast::client::client_properties Class Reference

Client Properties is an internal class. More...

#include <client_properties.h>

Public Member Functions

 client_properties (const std::unordered_map< std::string, std::string > &properties)
const client_propertyget_heartbeat_timeout () const
const client_propertyget_heartbeat_interval () const
const client_propertyget_aws_member_port () const
const client_propertyget_invocation_retry_pause_millis () const
const client_propertyget_invocation_timeout_seconds () const
const client_propertyget_event_thread_count () const
const client_propertyget_internal_executor_pool_size () const
const client_propertyget_shuffle_member_list () const
const client_propertyget_max_concurrent_invocations () const
const client_propertyget_backpressure_backoff_timeout_millis () const
const client_propertyget_statistics_enabled () const
const client_propertyget_statistics_period_seconds () const
const client_propertybackup_timeout_millis () const
const client_propertyfail_on_indeterminate_state () const
const client_propertycloud_base_url () const
const client_propertypartition_arg_cache_size () const
bool get_boolean (const client_property &property) const
 Returns the configured boolean value of a ClientProperty.
int32_t get_integer (const client_property &property) const
 Returns the configured int32_t value of a ClientProperty.
int64_t get_long (const client_property &property) const
 Returns the configured int64_t value of a ClientProperty.
std::string get_string (const client_property &property) const
 Returns the configured value of a ClientProperty as std::string.

Static Public Attributes

static const std::string PROP_HEARTBEAT_TIMEOUT
 Client will be sending heartbeat messages to members and this is the timeout.
static const std::string PROP_HEARTBEAT_TIMEOUT_DEFAULT = "60000"
static const std::string PROP_HEARTBEAT_INTERVAL
 Time interval in milliseconds between the heartbeats sent by the client to the nodes.
static const std::string PROP_HEARTBEAT_INTERVAL_DEFAULT = "5000"
static const std::string PROP_REQUEST_RETRY_COUNT
 Client will retry requests which either inherently retryable(idempotent client) or client_network_config#redoOperation is set to true_ This property is to configure retry count before client give up retrying.
static const std::string PROP_REQUEST_RETRY_COUNT_DEFAULT = "20"
static const std::string PROP_REQUEST_RETRY_WAIT_TIME
 Client will retry requests which either inherently retryable(idempotent client) or client_network_config#redoOperation is set to true.
static const std::string PROP_REQUEST_RETRY_WAIT_TIME_DEFAULT = "1"
static const std::string PROP_AWS_MEMBER_PORT = "hz-port"
 The discovery mechanism will discover only IP addresses.
static const std::string PROP_AWS_MEMBER_PORT_DEFAULT = "5701"
static const std::string INVOCATION_RETRY_PAUSE_MILLIS
 Pause time between each retry cycle of an invocation in milliseconds.
static const std::string INVOCATION_RETRY_PAUSE_MILLIS_DEFAULT
static const std::string INVOCATION_TIMEOUT_SECONDS
 When an invocation gets an exception because :
static const std::string INVOCATION_TIMEOUT_SECONDS_DEFAULT = "120"
static const std::string EVENT_THREAD_COUNT
 Number of the threads to handle the incoming event packets.
static const std::string EVENT_THREAD_COUNT_DEFAULT = "5"
static const std::string INTERNAL_EXECUTOR_POOL_SIZE
static const std::string INTERNAL_EXECUTOR_POOL_SIZE_DEFAULT = "3"
static const std::string SHUFFLE_MEMBER_LIST
 Client shuffles the given member list to prevent all clients to connect to the same node when this property is set to true.
static const std::string SHUFFLE_MEMBER_LIST_DEFAULT = "true"
static const std::string MAX_CONCURRENT_INVOCATIONS
 The maximum number of concurrent invocations allowed.
static const std::string MAX_CONCURRENT_INVOCATIONS_DEFAULT
static const std::string BACKPRESSURE_BACKOFF_TIMEOUT_MILLIS
 Control the maximum timeout in millis to wait for an invocation space to be available.
static const std::string BACKPRESSURE_BACKOFF_TIMEOUT_MILLIS_DEFAULT = "-1"
static const std::string STATISTICS_ENABLED
 Use to enable the client statistics collection.
static const std::string STATISTICS_ENABLED_DEFAULT = "false"
static const std::string STATISTICS_PERIOD_SECONDS
 The period in seconds the statistics sent to the cluster.
static const std::string STATISTICS_PERIOD_SECONDS_DEFAULT = "3"
static constexpr const char * OPERATION_BACKUP_TIMEOUT_MILLIS
 If an operation has backups, this property specifies how long the invocation will wait for acks from the backup replicas.
static constexpr const char * OPERATION_BACKUP_TIMEOUT_MILLIS_DEFAULT
static constexpr const char * FAIL_ON_INDETERMINATE_OPERATION_STATE
 When this configuration is enabled, if an operation has sync backups and acks are not received from backup replicas in time, or the member which owns primary replica of the target partition leaves the cluster, then the invocation fails with \indeterminate_operation_state.
static constexpr const char * FAIL_ON_INDETERMINATE_OPERATION_STATE_DEFAULT
static constexpr const char * CLOUD_URL_BASE = "hazelcast.client.cloud.url"
 Internal client property to change base url of cloud discovery endpoint.
static constexpr const char * CLOUD_URL_BASE_DEFAULT
static constexpr const char * PARTITION_ARGUMENT_CACHE_SIZE
 Parametrized SQL queries touching only a single partition benefit from using the partition owner as the query coordinator, if the partition owner can be determined from one of the query parameters.
static constexpr const char * PARTITION_ARGUMENT_CACHE_SIZE_DEFAULT = "1024"

Detailed Description

Client Properties is an internal class.

Only use properties documentations as references to be used in client_config::set_property

Definition at line 66 of file client_properties.h.

Constructor & Destructor Documentation

◆ client_properties()

hazelcast::client::client_properties::client_properties ( const std::unordered_map< std::string, std::string > & properties)

Definition at line 1041 of file client_impl.cpp.

1043 : heartbeat_timeout_(PROP_HEARTBEAT_TIMEOUT, PROP_HEARTBEAT_TIMEOUT_DEFAULT)
1044 , heartbeat_interval_(PROP_HEARTBEAT_INTERVAL,
1045 PROP_HEARTBEAT_INTERVAL_DEFAULT)
1046 , retry_count_(PROP_REQUEST_RETRY_COUNT, PROP_REQUEST_RETRY_COUNT_DEFAULT)
1047 , retry_wait_time_(PROP_REQUEST_RETRY_WAIT_TIME,
1048 PROP_REQUEST_RETRY_WAIT_TIME_DEFAULT)
1049 , aws_member_port_(PROP_AWS_MEMBER_PORT, PROP_AWS_MEMBER_PORT_DEFAULT)
1050 , invocation_retry_pause_millis_(INVOCATION_RETRY_PAUSE_MILLIS,
1051 INVOCATION_RETRY_PAUSE_MILLIS_DEFAULT)
1052 , invocation_timeout_seconds_(INVOCATION_TIMEOUT_SECONDS,
1053 INVOCATION_TIMEOUT_SECONDS_DEFAULT)
1054 , event_thread_count_(EVENT_THREAD_COUNT, EVENT_THREAD_COUNT_DEFAULT)
1055 , internal_executor_pool_size_(INTERNAL_EXECUTOR_POOL_SIZE,
1056 INTERNAL_EXECUTOR_POOL_SIZE_DEFAULT)
1057 , shuffle_member_list_(SHUFFLE_MEMBER_LIST, SHUFFLE_MEMBER_LIST_DEFAULT)
1058 , max_concurrent_invocations_(MAX_CONCURRENT_INVOCATIONS,
1059 MAX_CONCURRENT_INVOCATIONS_DEFAULT)
1060 , backpressure_backoff_timeout_millis_(
1062 BACKPRESSURE_BACKOFF_TIMEOUT_MILLIS_DEFAULT)
1063 , statistics_enabled_(STATISTICS_ENABLED, STATISTICS_ENABLED_DEFAULT)
1064 , statistics_period_seconds_(STATISTICS_PERIOD_SECONDS,
1065 STATISTICS_PERIOD_SECONDS_DEFAULT)
1066 , backup_timeout_millis_(OPERATION_BACKUP_TIMEOUT_MILLIS,
1067 OPERATION_BACKUP_TIMEOUT_MILLIS_DEFAULT)
1068 , fail_on_indeterminate_state_(FAIL_ON_INDETERMINATE_OPERATION_STATE,
1069 FAIL_ON_INDETERMINATE_OPERATION_STATE_DEFAULT)
1070 , cloud_base_url_(CLOUD_URL_BASE, CLOUD_URL_BASE_DEFAULT)
1071 , partition_arg_cache_size_(PARTITION_ARGUMENT_CACHE_SIZE,
1072 PARTITION_ARGUMENT_CACHE_SIZE_DEFAULT)
1073 , properties_map_(properties)
1074{}
static const std::string PROP_HEARTBEAT_INTERVAL
Time interval in milliseconds between the heartbeats sent by the client to the nodes.
static const std::string PROP_REQUEST_RETRY_COUNT
Client will retry requests which either inherently retryable(idempotentclient) or client_network_conf...
static const std::string PROP_REQUEST_RETRY_WAIT_TIME
Client will retry requests which either inherently retryable(idempotentclient) or client_network_conf...
static const std::string MAX_CONCURRENT_INVOCATIONS
The maximum number of concurrent invocations allowed.
static const std::string SHUFFLE_MEMBER_LIST
Client shuffles the given member list to prevent all clients to connect to the same node when this pr...
static const std::string STATISTICS_PERIOD_SECONDS
The period in seconds the statistics sent to the cluster.
static const std::string EVENT_THREAD_COUNT
Number of the threads to handle the incoming event packets.
static constexpr const char * PARTITION_ARGUMENT_CACHE_SIZE
Parametrized SQL queries touching only a single partition benefit from using the partition owner as t...
static const std::string STATISTICS_ENABLED
Use to enable the client statistics collection.
static const std::string INVOCATION_RETRY_PAUSE_MILLIS
Pause time between each retry cycle of an invocation in milliseconds.
static constexpr const char * FAIL_ON_INDETERMINATE_OPERATION_STATE
When this configuration is enabled, if an operation has sync backups and acks are not received from b...
static constexpr const char * OPERATION_BACKUP_TIMEOUT_MILLIS
If an operation has backups, this property specifies how long the invocation will wait for acks from ...
static const std::string PROP_AWS_MEMBER_PORT
The discovery mechanism will discover only IP addresses.
static const std::string PROP_HEARTBEAT_TIMEOUT
Client will be sending heartbeat messages to members and this is the timeout.
static const std::string INVOCATION_TIMEOUT_SECONDS
When an invocation gets an exception because :
static const std::string BACKPRESSURE_BACKOFF_TIMEOUT_MILLIS
Control the maximum timeout in millis to wait for an invocation space to be available.
static constexpr const char * CLOUD_URL_BASE
Internal client property to change base url of cloud discovery endpoint.

Member Function Documentation

◆ backup_timeout_millis()

const client_property & hazelcast::client::client_properties::backup_timeout_millis ( ) const

Definition at line 1184 of file client_impl.cpp.

1185{
1186 return backup_timeout_millis_;
1187}

◆ cloud_base_url()

const client_property & hazelcast::client::client_properties::cloud_base_url ( ) const

Definition at line 1196 of file client_impl.cpp.

1197{
1198 return cloud_base_url_;
1199}

◆ fail_on_indeterminate_state()

const client_property & hazelcast::client::client_properties::fail_on_indeterminate_state ( ) const

Definition at line 1190 of file client_impl.cpp.

1191{
1192 return fail_on_indeterminate_state_;
1193}

◆ get_aws_member_port()

const client_property & hazelcast::client::client_properties::get_aws_member_port ( ) const

Definition at line 1089 of file client_impl.cpp.

1090{
1091 return aws_member_port_;
1092}

◆ get_backpressure_backoff_timeout_millis()

const client_property & hazelcast::client::client_properties::get_backpressure_backoff_timeout_millis ( ) const

Definition at line 1131 of file client_impl.cpp.

1132{
1133 return backpressure_backoff_timeout_millis_;
1134}

◆ get_boolean()

bool hazelcast::client::client_properties::get_boolean ( const client_property & property) const

Returns the configured boolean value of a ClientProperty.

Parameters
propertythe ClientProperty to get the value from
Returns
the value as bool

Definition at line 1166 of file client_impl.cpp.

1167{
1168 return util::IOUtil::to_value<bool>(get_string(property));
1169}
std::string get_string(const client_property &property) const
Returns the configured value of a ClientProperty as std::string.

◆ get_event_thread_count()

const client_property & hazelcast::client::client_properties::get_event_thread_count ( ) const

Definition at line 1107 of file client_impl.cpp.

1108{
1109 return event_thread_count_;
1110}

◆ get_heartbeat_interval()

const client_property & hazelcast::client::client_properties::get_heartbeat_interval ( ) const

Definition at line 1083 of file client_impl.cpp.

1084{
1085 return heartbeat_interval_;
1086}

◆ get_heartbeat_timeout()

const client_property & hazelcast::client::client_properties::get_heartbeat_timeout ( ) const

Definition at line 1077 of file client_impl.cpp.

1078{
1079 return heartbeat_timeout_;
1080}

◆ get_integer()

int32_t hazelcast::client::client_properties::get_integer ( const client_property & property) const

Returns the configured int32_t value of a ClientProperty.

Parameters
propertythe ClientProperty to get the value from
Returns
the value as int32_t

Definition at line 1172 of file client_impl.cpp.

1173{
1174 return util::IOUtil::to_value<int32_t>(get_string(property));
1175}

◆ get_internal_executor_pool_size()

const client_property & hazelcast::client::client_properties::get_internal_executor_pool_size ( ) const

Definition at line 1113 of file client_impl.cpp.

1114{
1115 return internal_executor_pool_size_;
1116}

◆ get_invocation_retry_pause_millis()

const client_property & hazelcast::client::client_properties::get_invocation_retry_pause_millis ( ) const

Definition at line 1095 of file client_impl.cpp.

1096{
1097 return invocation_retry_pause_millis_;
1098}

◆ get_invocation_timeout_seconds()

const client_property & hazelcast::client::client_properties::get_invocation_timeout_seconds ( ) const

Definition at line 1101 of file client_impl.cpp.

1102{
1103 return invocation_timeout_seconds_;
1104}

◆ get_long()

int64_t hazelcast::client::client_properties::get_long ( const client_property & property) const

Returns the configured int64_t value of a ClientProperty.

Parameters
propertythe ClientProperty to get the value from
Returns
the value as int64_t

Definition at line 1178 of file client_impl.cpp.

1179{
1180 return util::IOUtil::to_value<int64_t>(get_string(property));
1181}

◆ get_max_concurrent_invocations()

const client_property & hazelcast::client::client_properties::get_max_concurrent_invocations ( ) const

Definition at line 1125 of file client_impl.cpp.

1126{
1127 return max_concurrent_invocations_;
1128}

◆ get_shuffle_member_list()

const client_property & hazelcast::client::client_properties::get_shuffle_member_list ( ) const

Definition at line 1119 of file client_impl.cpp.

1120{
1121 return shuffle_member_list_;
1122}

◆ get_statistics_enabled()

const client_property & hazelcast::client::client_properties::get_statistics_enabled ( ) const

Definition at line 1137 of file client_impl.cpp.

1138{
1139 return statistics_enabled_;
1140}

◆ get_statistics_period_seconds()

const client_property & hazelcast::client::client_properties::get_statistics_period_seconds ( ) const

Definition at line 1143 of file client_impl.cpp.

1144{
1145 return statistics_period_seconds_;
1146}

◆ get_string()

std::string hazelcast::client::client_properties::get_string ( const client_property & property) const

Returns the configured value of a ClientProperty as std::string.

Parameters
propertythe ClientProperty to get the value from
Returns
the value

Definition at line 1149 of file client_impl.cpp.

1150{
1151 std::unordered_map<std::string, std::string>::const_iterator valueIt =
1152 properties_map_.find(property.get_name());
1153 if (valueIt != properties_map_.end()) {
1154 return valueIt->second;
1155 }
1156
1157 const char* value = property.get_system_property();
1158 if (value != NULL) {
1159 return value;
1160 }
1161
1162 return property.get_default_value();
1163}

◆ partition_arg_cache_size()

const client_property & hazelcast::client::client_properties::partition_arg_cache_size ( ) const

Definition at line 1202 of file client_impl.cpp.

1203{
1204 return partition_arg_cache_size_;
1205}

Member Data Documentation

◆ BACKPRESSURE_BACKOFF_TIMEOUT_MILLIS

const std::string hazelcast::client::client_properties::BACKPRESSURE_BACKOFF_TIMEOUT_MILLIS
static
Initial value:
=
"hazelcast.client.invocation.backoff.timeout.millis"

Control the maximum timeout in millis to wait for an invocation space to be available.

If an invocation can't be made because there are too many pending invocations, then an exponential backoff is done to give the system time to deal with the backlog of invocations. This property controls how long an invocation is allowed to wait before getting a com.hazelcast.core.hazelcast_overload.

When set to -1 then hazelcast_overload_exception is thrown immediately without any waiting.

Definition at line 220 of file client_properties.h.

◆ BACKPRESSURE_BACKOFF_TIMEOUT_MILLIS_DEFAULT

const std::string hazelcast::client::client_properties::BACKPRESSURE_BACKOFF_TIMEOUT_MILLIS_DEFAULT = "-1"
static

Definition at line 221 of file client_properties.h.

◆ CLOUD_URL_BASE

const char* hazelcast::client::client_properties::CLOUD_URL_BASE = "hazelcast.client.cloud.url"
staticconstexpr

Internal client property to change base url of cloud discovery endpoint.

Used for testing cloud discovery.

Definition at line 265 of file client_properties.h.

◆ CLOUD_URL_BASE_DEFAULT

const char* hazelcast::client::client_properties::CLOUD_URL_BASE_DEFAULT
staticconstexpr
Initial value:
=
"api.viridian.hazelcast.com"

Definition at line 266 of file client_properties.h.

◆ EVENT_THREAD_COUNT

const std::string hazelcast::client::client_properties::EVENT_THREAD_COUNT
static
Initial value:
=
"hazelcast.client.event.thread.count"

Number of the threads to handle the incoming event packets.

Definition at line 183 of file client_properties.h.

◆ EVENT_THREAD_COUNT_DEFAULT

const std::string hazelcast::client::client_properties::EVENT_THREAD_COUNT_DEFAULT = "5"
static

Definition at line 184 of file client_properties.h.

◆ FAIL_ON_INDETERMINATE_OPERATION_STATE

const char* hazelcast::client::client_properties::FAIL_ON_INDETERMINATE_OPERATION_STATE
staticconstexpr
Initial value:
=
"hazelcast.client.operation.fail.on.indeterminate.state"

When this configuration is enabled, if an operation has sync backups and acks are not received from backup replicas in time, or the member which owns primary replica of the target partition leaves the cluster, then the invocation fails with \indeterminate_operation_state.

However, even if the invocation fails, there will not be any rollback on other successful replicas.

Definition at line 256 of file client_properties.h.

◆ FAIL_ON_INDETERMINATE_OPERATION_STATE_DEFAULT

const char* hazelcast::client::client_properties::FAIL_ON_INDETERMINATE_OPERATION_STATE_DEFAULT
staticconstexpr
Initial value:
=
"false"

Definition at line 258 of file client_properties.h.

◆ INTERNAL_EXECUTOR_POOL_SIZE

const std::string hazelcast::client::client_properties::INTERNAL_EXECUTOR_POOL_SIZE
static
Initial value:
=
"hazelcast.client.internal.executor.pool.size"

Definition at line 186 of file client_properties.h.

◆ INTERNAL_EXECUTOR_POOL_SIZE_DEFAULT

const std::string hazelcast::client::client_properties::INTERNAL_EXECUTOR_POOL_SIZE_DEFAULT = "3"
static

Definition at line 187 of file client_properties.h.

◆ INVOCATION_RETRY_PAUSE_MILLIS

const std::string hazelcast::client::client_properties::INVOCATION_RETRY_PAUSE_MILLIS
static
Initial value:
=
"hazelcast.client.invocation.retry.pause.millis"

Pause time between each retry cycle of an invocation in milliseconds.

Definition at line 163 of file client_properties.h.

◆ INVOCATION_RETRY_PAUSE_MILLIS_DEFAULT

const std::string hazelcast::client::client_properties::INVOCATION_RETRY_PAUSE_MILLIS_DEFAULT
static
Initial value:
=
"1000"

Definition at line 164 of file client_properties.h.

◆ INVOCATION_TIMEOUT_SECONDS

const std::string hazelcast::client::client_properties::INVOCATION_TIMEOUT_SECONDS
static
Initial value:
=
"hazelcast.client.invocation.timeout.seconds"

When an invocation gets an exception because :

  • Member throws an exception.
  • Connection between the client and member is closed.
  • Client's heartbeat requests are timed out. Time passed since invocation started is compared with this property. If the time is already passed, then the exception is delegated to the user. If not, the invocation is retried. Note that, if invocation gets no exception and it is a long running one, then it will not get any exception, no matter how small this timeout is set.

Definition at line 177 of file client_properties.h.

◆ INVOCATION_TIMEOUT_SECONDS_DEFAULT

const std::string hazelcast::client::client_properties::INVOCATION_TIMEOUT_SECONDS_DEFAULT = "120"
static

Definition at line 178 of file client_properties.h.

◆ MAX_CONCURRENT_INVOCATIONS

const std::string hazelcast::client::client_properties::MAX_CONCURRENT_INVOCATIONS
static
Initial value:
=
"hazelcast.client.max.concurrent.invocations"

The maximum number of concurrent invocations allowed.

To prevent the system from overloading, user can apply a constraint on the number of concurrent invocations. If the maximum number of concurrent invocations has been exceeded and a new invocation comes in, then hazelcast will throw hazelcast_overload_exception

By default it is configured as INT32_MAX.

Definition at line 206 of file client_properties.h.

◆ MAX_CONCURRENT_INVOCATIONS_DEFAULT

const std::string hazelcast::client::client_properties::MAX_CONCURRENT_INVOCATIONS_DEFAULT
static
Initial value:
=
util::IOUtil::to_string<int32_t>(INT32_MAX)

Definition at line 207 of file client_properties.h.

◆ OPERATION_BACKUP_TIMEOUT_MILLIS

const char* hazelcast::client::client_properties::OPERATION_BACKUP_TIMEOUT_MILLIS
staticconstexpr
Initial value:
=
"hazelcast.client.operation.backup.timeout.millis"

If an operation has backups, this property specifies how long the invocation will wait for acks from the backup replicas.

If acks are not received from some backups, there will not be any rollback on other successful replicas.

Definition at line 243 of file client_properties.h.

◆ OPERATION_BACKUP_TIMEOUT_MILLIS_DEFAULT

const char* hazelcast::client::client_properties::OPERATION_BACKUP_TIMEOUT_MILLIS_DEFAULT
staticconstexpr
Initial value:
=
"5000"

Definition at line 245 of file client_properties.h.

◆ PARTITION_ARGUMENT_CACHE_SIZE

const char* hazelcast::client::client_properties::PARTITION_ARGUMENT_CACHE_SIZE
staticconstexpr
Initial value:
=
"hazelcast.client.sql.partition.argument.cache.size"

Parametrized SQL queries touching only a single partition benefit from using the partition owner as the query coordinator, if the partition owner can be determined from one of the query parameters.

When such a query is executed, the cluster sends the index of such argument to the client. This parameter configures the size of the cache the client uses for storing this information.

Definition at line 277 of file client_properties.h.

◆ PARTITION_ARGUMENT_CACHE_SIZE_DEFAULT

const char* hazelcast::client::client_properties::PARTITION_ARGUMENT_CACHE_SIZE_DEFAULT = "1024"
staticconstexpr

Definition at line 279 of file client_properties.h.

◆ PROP_AWS_MEMBER_PORT

const std::string hazelcast::client::client_properties::PROP_AWS_MEMBER_PORT = "hz-port"
static

The discovery mechanism will discover only IP addresses.

You can define the port on which Hazelcast is expected to be running here. This port number is not used by the discovery mechanism itself, it is only returned by the discovery mechanism. The default port is PROP_AWS_MEMBER_PORT_DEFAULT

Definition at line 157 of file client_properties.h.

◆ PROP_AWS_MEMBER_PORT_DEFAULT

const std::string hazelcast::client::client_properties::PROP_AWS_MEMBER_PORT_DEFAULT = "5701"
static

Definition at line 158 of file client_properties.h.

◆ PROP_HEARTBEAT_INTERVAL

const std::string hazelcast::client::client_properties::PROP_HEARTBEAT_INTERVAL
static
Initial value:
=
"hazelcast_client_heartbeat_interval"

Time interval in milliseconds between the heartbeats sent by the client to the nodes.

attribute "hazelcast_client_heartbeat_interval" default value "5000"

Definition at line 123 of file client_properties.h.

◆ PROP_HEARTBEAT_INTERVAL_DEFAULT

const std::string hazelcast::client::client_properties::PROP_HEARTBEAT_INTERVAL_DEFAULT = "5000"
static

Definition at line 124 of file client_properties.h.

◆ PROP_HEARTBEAT_TIMEOUT

const std::string hazelcast::client::client_properties::PROP_HEARTBEAT_TIMEOUT
static
Initial value:
=
"hazelcast_client_heartbeat_timeout"

Client will be sending heartbeat messages to members and this is the timeout.

If there is no any message passing between client and member within the given time via this property in milliseconds the connection will be closed.

attribute "hazelcast_client_heartbeat_timeout" default value "60000"

Definition at line 113 of file client_properties.h.

◆ PROP_HEARTBEAT_TIMEOUT_DEFAULT

const std::string hazelcast::client::client_properties::PROP_HEARTBEAT_TIMEOUT_DEFAULT = "60000"
static

Definition at line 114 of file client_properties.h.

◆ PROP_REQUEST_RETRY_COUNT

const std::string hazelcast::client::client_properties::PROP_REQUEST_RETRY_COUNT
static
Initial value:
=
"hazelcast_client_request_retry_count"

Client will retry requests which either inherently retryable(idempotent client) or client_network_config#redoOperation is set to true_ This property is to configure retry count before client give up retrying.

attribute "hazelcast_client_request_retry_count" default value "20"

Definition at line 135 of file client_properties.h.

◆ PROP_REQUEST_RETRY_COUNT_DEFAULT

const std::string hazelcast::client::client_properties::PROP_REQUEST_RETRY_COUNT_DEFAULT = "20"
static

Definition at line 136 of file client_properties.h.

◆ PROP_REQUEST_RETRY_WAIT_TIME

const std::string hazelcast::client::client_properties::PROP_REQUEST_RETRY_WAIT_TIME
static
Initial value:
=
"hazelcast_client_request_retry_wait_time"

Client will retry requests which either inherently retryable(idempotent client) or client_network_config#redoOperation is set to true.

Time delay in seconds between retries.

attribute "hazelcast_client_request_retry_wait_time" default value "1"

Definition at line 147 of file client_properties.h.

◆ PROP_REQUEST_RETRY_WAIT_TIME_DEFAULT

const std::string hazelcast::client::client_properties::PROP_REQUEST_RETRY_WAIT_TIME_DEFAULT = "1"
static

Definition at line 148 of file client_properties.h.

◆ SHUFFLE_MEMBER_LIST

const std::string hazelcast::client::client_properties::SHUFFLE_MEMBER_LIST
static
Initial value:
=
"hazelcast.client.shuffle.member.list"

Client shuffles the given member list to prevent all clients to connect to the same node when this property is set to true.

When it is set to false, the client tries to connect to the nodes in the given order.

Definition at line 194 of file client_properties.h.

◆ SHUFFLE_MEMBER_LIST_DEFAULT

const std::string hazelcast::client::client_properties::SHUFFLE_MEMBER_LIST_DEFAULT = "true"
static

Definition at line 195 of file client_properties.h.

◆ STATISTICS_ENABLED

const std::string hazelcast::client::client_properties::STATISTICS_ENABLED
static
Initial value:
=
"hazelcast.client.statistics.enabled"

Use to enable the client statistics collection.

The default is false.

Definition at line 228 of file client_properties.h.

◆ STATISTICS_ENABLED_DEFAULT

const std::string hazelcast::client::client_properties::STATISTICS_ENABLED_DEFAULT = "false"
static

Definition at line 229 of file client_properties.h.

◆ STATISTICS_PERIOD_SECONDS

const std::string hazelcast::client::client_properties::STATISTICS_PERIOD_SECONDS
static
Initial value:
=
"hazelcast.client.statistics.period.seconds"

The period in seconds the statistics sent to the cluster.

Definition at line 234 of file client_properties.h.

◆ STATISTICS_PERIOD_SECONDS_DEFAULT

const std::string hazelcast::client::client_properties::STATISTICS_PERIOD_SECONDS_DEFAULT = "3"
static

Definition at line 235 of file client_properties.h.


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