Package com.hazelcast.client.config
Class ConnectionRetryConfig
java.lang.Object
com.hazelcast.client.config.ConnectionRetryConfig
public class ConnectionRetryConfig extends Object
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.
-
Field Summary
Fields Modifier and Type Field Description static int
DEFAULT_CLUSTER_CONNECT_TIMEOUT_MILLIS
Default value for the cluster connection timeout.static int
FAILOVER_CLIENT_DEFAULT_CLUSTER_CONNECT_TIMEOUT_MILLIS
Timeout used by the failover client to start trying to connect alternative clusters when the cluster connection timeout is equal toDEFAULT_CLUSTER_CONNECT_TIMEOUT_MILLIS
. -
Constructor Summary
Constructors Constructor Description ConnectionRetryConfig()
ConnectionRetryConfig(ConnectionRetryConfig connectionRetryConfig)
-
Method Summary
Modifier and Type Method Description boolean
equals(Object o)
long
getClusterConnectTimeoutMillis()
Timeout value in milliseconds for the client to give up to connect to the current cluster Depending on FailoverConfig, a client can shutdown or start trying on alternative clusters after reaching the timeout.int
getInitialBackoffMillis()
how long to wait after the first failure before retryingdouble
getJitter()
by how much to randomize backoffs.int
getMaxBackoffMillis()
When backoff reaches this upper bound, it does not increase any more.double
getMultiplier()
factor with which to multiply backoff after a failed retryint
hashCode()
ConnectionRetryConfig
setClusterConnectTimeoutMillis(long clusterConnectTimeoutMillis)
ConnectionRetryConfig
setInitialBackoffMillis(int initialBackoffMillis)
ConnectionRetryConfig
setJitter(double jitter)
At each iteration calculated back-off is randomized via following method Random(-jitter * current_backoff, jitter * current_backoff)ConnectionRetryConfig
setMaxBackoffMillis(int maxBackoffMillis)
When backoff reaches this upper bound, it does not increase any more.ConnectionRetryConfig
setMultiplier(double multiplier)
String
toString()
-
Field Details
-
DEFAULT_CLUSTER_CONNECT_TIMEOUT_MILLIS
public static final int DEFAULT_CLUSTER_CONNECT_TIMEOUT_MILLISDefault value for the cluster connection timeout.- See Also:
- Constant Field Values
-
FAILOVER_CLIENT_DEFAULT_CLUSTER_CONNECT_TIMEOUT_MILLIS
public static final int FAILOVER_CLIENT_DEFAULT_CLUSTER_CONNECT_TIMEOUT_MILLISTimeout used by the failover client to start trying to connect alternative clusters when the cluster connection timeout is equal toDEFAULT_CLUSTER_CONNECT_TIMEOUT_MILLIS
.- See Also:
- Constant Field Values
-
-
Constructor Details
-
ConnectionRetryConfig
public ConnectionRetryConfig() -
ConnectionRetryConfig
-
-
Method Details
-
getInitialBackoffMillis
public int getInitialBackoffMillis()how long to wait after the first failure before retrying- Returns:
- initialBackoffMillis
-
setInitialBackoffMillis
- Parameters:
initialBackoffMillis
- how long to wait after the first failure before retrying- Returns:
- updated ConnectionRetryConfig
-
getMaxBackoffMillis
public int getMaxBackoffMillis()When backoff reaches this upper bound, it does not increase any more.- Returns:
- maxBackoffMillis
-
setMaxBackoffMillis
When backoff reaches this upper bound, it does not increase any more.- Parameters:
maxBackoffMillis
- upper bound on backoff- Returns:
- updated ConnectionRetryConfig
-
getMultiplier
public double getMultiplier()factor with which to multiply backoff after a failed retry- Returns:
- multiplier
-
setMultiplier
- Parameters:
multiplier
- factor with which to multiply backoff after a failed retry- Returns:
- updated ConnectionRetryConfig
-
getClusterConnectTimeoutMillis
public long getClusterConnectTimeoutMillis()Timeout value in milliseconds for the client to give up to connect to the current cluster Depending on FailoverConfig, a client can shutdown or start trying on alternative clusters after reaching the timeout. If it is equal to-1
, which is the default value, the client will not stop trying to connect to the cluster. If the failover client is used, for the default value, the client will start trying to connect alternative clusters afterFAILOVER_CLIENT_DEFAULT_CLUSTER_CONNECT_TIMEOUT_MILLIS
. For any other value, both the failover and non-failover client will use that as it is.- Returns:
- clusterConnectTimeoutMillis
-
setClusterConnectTimeoutMillis
- Parameters:
clusterConnectTimeoutMillis
- timeout in milliseconds for the client to give up to connect to the current cluster Depending on FailoverConfig, a client can shutdown or start trying on alternative clusters after reaching the timeout. If set to-1
, which is the default value, the client will not stop trying to connect to the cluster. If the failover client is used, for the default value, the client will start trying to connect alternative clusters afterFAILOVER_CLIENT_DEFAULT_CLUSTER_CONNECT_TIMEOUT_MILLIS
. For any other value, both the failover and non-failover client will use that as it is.- Returns:
- updated ConnectionRetryConfig
-
getJitter
public double getJitter()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
-
setJitter
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 ConnectionRetryConfig
-
equals
-
hashCode
public int hashCode() -
toString
-