Hazelcast C++ Client
Public Types | Public Member Functions | List of all members
hazelcast::client::config::ClientConnectionStrategyConfig Class Reference

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

#include <ClientConnectionStrategyConfig.h>

Public Types

enum  ReconnectMode { OFF, ON, ASYNC }
 Reconnect options. More...
 

Public Member Functions

bool isAsyncStart () const
 Client instance creation won't block on HazelcastClient(ClientConfig &) if this value is true. More...
 
ClientConnectionStrategyConfigsetAsyncStart (bool asyncStart)
 Set true for non blocking HazelcastClient(const ClientConfig &). More...
 
ReconnectMode getReconnectMode () const
 
ClientConnectionStrategyConfigsetReconnectMode (ReconnectMode reconnectMode)
 How a client reconnect to cluster after a disconnect can be configured. More...
 

Detailed Description

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

Member Enumeration Documentation

◆ ReconnectMode

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 HazelcastClientOfflineException

Member Function Documentation

◆ getReconnectMode()

ClientConnectionStrategyConfig::ReconnectMode hazelcast::client::config::ClientConnectionStrategyConfig::getReconnectMode ( ) const
Returns
reconnect mode

◆ isAsyncStart()

bool hazelcast::client::config::ClientConnectionStrategyConfig::isAsyncStart ( ) const

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

Returns
if client connects to cluster asynchronously

◆ setAsyncStart()

ClientConnectionStrategyConfig & hazelcast::client::config::ClientConnectionStrategyConfig::setAsyncStart ( bool  asyncStart)

Set true for non blocking HazelcastClient(const ClientConfig &).

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, HazelcastClient(const ClientConfig &) will block until a cluster connection established and it's ready to use client instance

default value is false

Parameters
asyncStarttrue for async client creation
Returns
the updated ClientConnectionStrategyConfig

◆ setReconnectMode()

ClientConnectionStrategyConfig & hazelcast::client::config::ClientConnectionStrategyConfig::setReconnectMode ( ReconnectMode  reconnectMode)

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

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