io.nats.client

Enum Options.ReconnectDelayBehavior

java.lang.Object

java.lang.Enum<Options.ReconnectDelayBehavior>

io.nats.client.Options.ReconnectDelayBehavior

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Options.ReconnectDelayBehavior>

Enclosing class:

Options

public static enum Options.ReconnectDelayBehavior
extends java.lang.Enum<Options.ReconnectDelayBehavior>

Controls when the ReconnectDelayHandler is invoked during reconnect attempts.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BeforeAllRounds Invoke reconnect delay behavior before each full round of reconnect attempts.
BeforeSubsequentRounds Invoke the reconnect delay only before subsequent rounds, never before the first round.

Method Summary

Modifier and Type	Method and Description
static Options.ReconnectDelayBehavior	get(java.lang.String value) Resolve a Options.ReconnectDelayBehavior from a string (case-insensitive name match).
static Options.ReconnectDelayBehavior	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Options.ReconnectDelayBehavior[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BeforeSubsequentRounds

public static final Options.ReconnectDelayBehavior BeforeSubsequentRounds

Invoke the reconnect delay only before subsequent rounds, never before the first round. The first round of reconnect attempts runs immediately; the delay applies between rounds after a full round has been attempted and failed. This is the historical default. ReconnectDelayHandler.getWaitTime(long) will only be called with totalTries greater than or equal to 1.

BeforeAllRounds

public static final Options.ReconnectDelayBehavior BeforeAllRounds

Invoke reconnect delay behavior before each full round of reconnect attempts. ReconnectDelayHandler.getWaitTime(long) will be called with totalTries greater than or equal to 0.

Method Detail

values

public static Options.ReconnectDelayBehavior[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Options.ReconnectDelayBehavior c : Options.ReconnectDelayBehavior.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Options.ReconnectDelayBehavior valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

get

public static Options.ReconnectDelayBehavior get(java.lang.String value)

Resolve a Options.ReconnectDelayBehavior from a string (case-insensitive name match). Returns BeforeSubsequentRounds if the value is null or does not match any constant.

Parameters:

value - the string value

Returns:

the matching behavior, or BeforeSubsequentRounds as the default