Client Properties is an internal class. More...

#include <ClientProperties.h>

Public Member Functions
	ClientProperties (const std::map< std::string, std::string > &properties)

const ClientProperty &	getHeartbeatTimeout () const

const ClientProperty &	getHeartbeatInterval () const

const ClientProperty &	getAwsMemberPort () const

const ClientProperty &	getCleanResourcesPeriodMillis () const

const ClientProperty &	getInvocationRetryPauseMillis () const

const ClientProperty &	getInvocationTimeoutSeconds () const

const ClientProperty &	getEventThreadCount () const

const ClientProperty &	getEventQueueCapacity () const

const ClientProperty &	getInternalExecutorPoolSize () const

const ClientProperty &	getShuffleMemberList () const

const ClientProperty &	getMaxConcurrentInvocations () const

const ClientProperty &	getBackpressureBackoffTimeoutMillis () const

const ClientProperty &	getStatisticsEnabled () const

const ClientProperty &	getStatisticsPeriodSeconds () const

bool	getBoolean (const ClientProperty &property) const
	Returns the configured boolean value of a ClientProperty. More...

int32_t	getInteger (const ClientProperty &property) const
	Returns the configured int32_t value of a ClientProperty. More...

int64_t	getLong (const ClientProperty &property) const
	Returns the configured int64_t value of a ClientProperty. More...

std::string	getString (const ClientProperty &property) const
	Returns the configured value of a ClientProperty as std::string. More...

Static Public Attributes
static const std::string	PROP_HEARTBEAT_TIMEOUT = "hazelcast_client_heartbeat_timeout"
	Client will be sending heartbeat messages to members and this is the timeout. More...

static const std::string	PROP_HEARTBEAT_TIMEOUT_DEFAULT = "60"

static const std::string	PROP_HEARTBEAT_INTERVAL = "hazelcast_client_heartbeat_interval"
	Time interval in seconds between heartbeats to nodes from client. More...

static const std::string	PROP_HEARTBEAT_INTERVAL_DEFAULT = "10"

static const std::string	PROP_REQUEST_RETRY_COUNT = "hazelcast_client_request_retry_count"
	Client will retry requests which either inherently retryable(idempotent client) or ClientNetworkConfig#redoOperation is set to true_ This property is to configure retry count before client give up retrying. More...

static const std::string	PROP_REQUEST_RETRY_COUNT_DEFAULT = "20"

static const std::string	PROP_REQUEST_RETRY_WAIT_TIME = "hazelcast_client_request_retry_wait_time"
	Client will retry requests which either inherently retryable(idempotent client) or ClientNetworkConfig#redoOperation is set to true. More...

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. More...

static const std::string	PROP_AWS_MEMBER_PORT_DEFAULT = "5701"

static const std::string	CLEAN_RESOURCES_PERIOD_MILLIS = "hazelcast.client.internal.clean.resources.millis"
	The period in milliseconds at which the resource cleaning is run (e.g. More...

static const std::string	CLEAN_RESOURCES_PERIOD_MILLIS_DEFAULT = "100"

static const std::string	INVOCATION_RETRY_PAUSE_MILLIS = "hazelcast.client.invocation.retry.pause.millis"
	Pause time between each retry cycle of an invocation in milliseconds.

static const std::string	INVOCATION_RETRY_PAUSE_MILLIS_DEFAULT = "1000"

static const std::string	INVOCATION_TIMEOUT_SECONDS = "hazelcast.client.invocation.timeout.seconds"
	When an invocation gets an exception because : More...

static const std::string	INVOCATION_TIMEOUT_SECONDS_DEFAULT = "120"

static const std::string	EVENT_THREAD_COUNT = "hazelcast.client.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	EVENT_QUEUE_CAPACITY = "hazelcast.client.event.queue.capacity"
	Capacity of the executor that handles the incoming event packets.

static const std::string	EVENT_QUEUE_CAPACITY_DEFAULT = "1000000"

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

static const std::string	INTERNAL_EXECUTOR_POOL_SIZE_DEFAULT = "3"

static const std::string	SHUFFLE_MEMBER_LIST = "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. More...

static const std::string	SHUFFLE_MEMBER_LIST_DEFAULT = "true"

static const std::string	MAX_CONCURRENT_INVOCATIONS = "hazelcast.client.max.concurrent.invocations"
	The maximum number of concurrent invocations allowed. More...

static const std::string	MAX_CONCURRENT_INVOCATIONS_DEFAULT

static const std::string	BACKPRESSURE_BACKOFF_TIMEOUT_MILLIS = "hazelcast.client.invocation.backoff.timeout.millis"
	Control the maximum timeout in millis to wait for an invocation space to be available. More...

static const std::string	BACKPRESSURE_BACKOFF_TIMEOUT_MILLIS_DEFAULT = "-1"

static const std::string	STATISTICS_ENABLED = "hazelcast.client.statistics.enabled"
	Use to enable the client statistics collection. More...

static const std::string	STATISTICS_ENABLED_DEFAULT = "false"

static const std::string	STATISTICS_PERIOD_SECONDS = "hazelcast.client.statistics.period.seconds"
	The period in seconds the statistics sent to the cluster.

static const std::string	STATISTICS_PERIOD_SECONDS_DEFAULT = "3"

Detailed Description

Client Properties is an internal class.

Only use properties documentations as references to be used in ClientConfig::setProperty

Member Function Documentation

◆ getBoolean()

bool hazelcast::client::ClientProperties::getBoolean ( const ClientProperty & property ) const

Returns the configured boolean value of a ClientProperty.

Parameters

property the ClientProperty to get the value from

Returns: the value as bool

◆ getInteger()

int32_t hazelcast::client::ClientProperties::getInteger ( const ClientProperty & property ) const

Returns the configured int32_t value of a ClientProperty.

Parameters

property the ClientProperty to get the value from

Returns: the value as int32_t

◆ getLong()

int64_t hazelcast::client::ClientProperties::getLong ( const ClientProperty & property ) const

Returns the configured int64_t value of a ClientProperty.

Parameters

property the ClientProperty to get the value from

Returns: the value as int64_t

◆ getString()

std::string hazelcast::client::ClientProperties::getString ( const ClientProperty & property ) const

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

Parameters

property the ClientProperty to get the value from

Returns: the value

Member Data Documentation

◆ BACKPRESSURE_BACKOFF_TIMEOUT_MILLIS

const std::string hazelcast::client::ClientProperties::BACKPRESSURE_BACKOFF_TIMEOUT_MILLIS = "hazelcast.client.invocation.backoff.timeout.millis"

static

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.HazelcastOverloadException.

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

◆ CLEAN_RESOURCES_PERIOD_MILLIS

const std::string hazelcast::client::ClientProperties::CLEAN_RESOURCES_PERIOD_MILLIS = "hazelcast.client.internal.clean.resources.millis"

static

The period in milliseconds at which the resource cleaning is run (e.g.

invocations).

◆ INVOCATION_TIMEOUT_SECONDS

const std::string hazelcast::client::ClientProperties::INVOCATION_TIMEOUT_SECONDS = "hazelcast.client.invocation.timeout.seconds"

static

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.

◆ MAX_CONCURRENT_INVOCATIONS

const std::string hazelcast::client::ClientProperties::MAX_CONCURRENT_INVOCATIONS = "hazelcast.client.max.concurrent.invocations"

static

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 HazelcastOverloadException

By default it is configured as INT32_MAX.

◆ MAX_CONCURRENT_INVOCATIONS_DEFAULT

const std::string hazelcast::client::ClientProperties::MAX_CONCURRENT_INVOCATIONS_DEFAULT

static

Initial value:

= util::IOUtil::to_string<int32_t>(

INT32_MAX)

◆ PROP_AWS_MEMBER_PORT

const std::string hazelcast::client::ClientProperties::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

◆ PROP_HEARTBEAT_INTERVAL

const std::string hazelcast::client::ClientProperties::PROP_HEARTBEAT_INTERVAL = "hazelcast_client_heartbeat_interval"

static

Time interval in seconds between heartbeats to nodes from client.

attribute "hazelcast_client_heartbeat_interval" default value "10"

◆ PROP_HEARTBEAT_TIMEOUT

const std::string hazelcast::client::ClientProperties::PROP_HEARTBEAT_TIMEOUT = "hazelcast_client_heartbeat_timeout"

static

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 seconds the connection will be closed.

attribute "hazelcast_client_heartbeat_timeout" default value "60"

◆ PROP_REQUEST_RETRY_COUNT

const std::string hazelcast::client::ClientProperties::PROP_REQUEST_RETRY_COUNT = "hazelcast_client_request_retry_count"

static

Client will retry requests which either inherently retryable(idempotent client) or ClientNetworkConfig#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"

◆ PROP_REQUEST_RETRY_WAIT_TIME

const std::string hazelcast::client::ClientProperties::PROP_REQUEST_RETRY_WAIT_TIME = "hazelcast_client_request_retry_wait_time"

static

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

Time delay in seconds between retries.

attribute "hazelcast_client_request_retry_wait_time" default value "1"

◆ SHUFFLE_MEMBER_LIST

const std::string hazelcast::client::ClientProperties::SHUFFLE_MEMBER_LIST = "hazelcast.client.shuffle.member.list"

static

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.

◆ STATISTICS_ENABLED

const std::string hazelcast::client::ClientProperties::STATISTICS_ENABLED = "hazelcast.client.statistics.enabled"

static

Use to enable the client statistics collection.

The default is false.

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

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

Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ getBoolean()

◆ getInteger()

◆ getLong()

◆ getString()

Member Data Documentation

◆ BACKPRESSURE_BACKOFF_TIMEOUT_MILLIS

◆ CLEAN_RESOURCES_PERIOD_MILLIS

◆ INVOCATION_TIMEOUT_SECONDS

◆ MAX_CONCURRENT_INVOCATIONS

◆ MAX_CONCURRENT_INVOCATIONS_DEFAULT

◆ PROP_AWS_MEMBER_PORT

◆ PROP_HEARTBEAT_INTERVAL

◆ PROP_HEARTBEAT_TIMEOUT

◆ PROP_REQUEST_RETRY_COUNT

◆ PROP_REQUEST_RETRY_WAIT_TIME

◆ SHUFFLE_MEMBER_LIST

◆ STATISTICS_ENABLED