io.aeron.cluster

Enum ClusterControl.ToggleState

java.lang.Object

java.lang.Enum<ClusterControl.ToggleState>

io.aeron.cluster.ClusterControl.ToggleState

All Implemented Interfaces:

Serializable, Comparable<ClusterControl.ToggleState>

Enclosing class:

ClusterControl

public static enum ClusterControl.ToggleState
extends Enum<ClusterControl.ToggleState>

Toggle states for controlling the cluster node once it has entered the active state after initialising. The toggle can only we switched into a new state from NEUTRAL and will be reset by the ConsensusModule once the triggered action is complete.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABORT Abort processing and terminate the cluster without taking a snapshot.
INACTIVE Inactive state, not accepting new actions.
NEUTRAL Neutral state ready to accept a new action.
RESUME Resume processing of ingress and timers.
SHUTDOWN Shut down the cluster in an orderly fashion by taking a snapshot first then terminating.
SNAPSHOT Take a snapshot of cluster state.
STANDBY_SNAPSHOT Trigger a snapshot that will only occur on a cluster standby.
SUSPEND Suspend processing of ingress and timers.

Method Summary

Modifier and Type	Method and Description
static void	activate(AtomicCounter controlToggle) Activate the toggle by setting it to the NEUTRAL state.
int	code() Code to be used as the indicator in the control toggle counter.
static void	deactivate(AtomicCounter controlToggle) Activate the toggle by setting it to the INACTIVE state.
static ClusterControl.ToggleState	get(AtomicCounter controlToggle) Get the ClusterControl.ToggleState for a given control toggle.
static void	reset(AtomicCounter controlToggle) Reset the toggle to the NEUTRAL state.
boolean	toggle(AtomicCounter controlToggle) Toggle the control counter to trigger the requested ClusterControl.ToggleState.
static ClusterControl.ToggleState	valueOf(String name) Returns the enum constant of this type with the specified name.
static ClusterControl.ToggleState[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INACTIVE

public static final ClusterControl.ToggleState INACTIVE

Inactive state, not accepting new actions.

NEUTRAL

public static final ClusterControl.ToggleState NEUTRAL

Neutral state ready to accept a new action.

SUSPEND

public static final ClusterControl.ToggleState SUSPEND

Suspend processing of ingress and timers.

RESUME

public static final ClusterControl.ToggleState RESUME

Resume processing of ingress and timers.

SNAPSHOT

public static final ClusterControl.ToggleState SNAPSHOT

Take a snapshot of cluster state.

SHUTDOWN

public static final ClusterControl.ToggleState SHUTDOWN

Shut down the cluster in an orderly fashion by taking a snapshot first then terminating.

ABORT

public static final ClusterControl.ToggleState ABORT

Abort processing and terminate the cluster without taking a snapshot.

STANDBY_SNAPSHOT

public static final ClusterControl.ToggleState STANDBY_SNAPSHOT

Trigger a snapshot that will only occur on a cluster standby.

Method Detail

values

public static ClusterControl.ToggleState[] 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 (ClusterControl.ToggleState c : ClusterControl.ToggleState.values())
    System.out.println(c);

Returns:

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

valueOf

public static ClusterControl.ToggleState valueOf(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:

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

NullPointerException - if the argument is null

code

public final int code()

Code to be used as the indicator in the control toggle counter.

Returns:

code to be used as the indicator in the control toggle counter.

toggle

public final boolean toggle(AtomicCounter controlToggle)

Toggle the control counter to trigger the requested ClusterControl.ToggleState.

This action is thread safe and will succeed if the toggle is in the NEUTRAL state, or if toggle is SUSPEND and requested state is RESUME.

Parameters:

controlToggle - to change to the trigger state.

Returns:

true if the counter toggles or false if it is in a state other than NEUTRAL.

reset

public static void reset(AtomicCounter controlToggle)

Reset the toggle to the NEUTRAL state.

Parameters:

controlToggle - to be reset.

activate

public static void activate(AtomicCounter controlToggle)

Activate the toggle by setting it to the NEUTRAL state.

Parameters:

controlToggle - to be activated.

deactivate

public static void deactivate(AtomicCounter controlToggle)

Activate the toggle by setting it to the INACTIVE state.

Parameters:

controlToggle - to be deactivated.

get

public static ClusterControl.ToggleState get(AtomicCounter controlToggle)

Get the ClusterControl.ToggleState for a given control toggle.

Parameters:

controlToggle - to get the current state for.

Returns:

the state for the current control toggle.

Throws:

ClusterException - if the counter is not one of the valid values.