io.aeron.cluster

Class ConsensusModule

java.lang.Object

io.aeron.cluster.ConsensusModule

All Implemented Interfaces:

AutoCloseable

public final class ConsensusModule
extends Object
implements AutoCloseable

Component which resides on each node and is responsible for coordinating consensus within a cluster in concert with the lifecycle of clustered services.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConsensusModule.Configuration Configuration options for cluster.
static class	ConsensusModule.Context Programmable overrides for configuring the ConsensusModule in a cluster.
static class	ConsensusModule.State Possible states for the ConsensusModule.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CLUSTER_ACTION_FLAGS_DEFAULT Default set of flags when taking a snapshot
static int	CLUSTER_ACTION_FLAGS_STANDBY_SNAPSHOT Flag for a snapshot taken on a standby node.

Method Summary

Modifier and Type	Method and Description
void	close()
AgentInvoker	conductorAgentInvoker() Get the AgentInvoker for the consensus module.
ConsensusModule.Context	context() Get the ConsensusModule.Context that is used by this ConsensusModule.
static ConsensusModule	launch() Launch an ConsensusModule using a default configuration.
static ConsensusModule	launch(ConsensusModule.Context ctx) Launch an ConsensusModule by providing a configuration context.
static void	main(String[] args) Launch an ConsensusModule with that communicates with an out of process Archive and MediaDriver then awaits shutdown signal.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CLUSTER_ACTION_FLAGS_DEFAULT

public static final int CLUSTER_ACTION_FLAGS_DEFAULT

Default set of flags when taking a snapshot

See Also:

Constant Field Values

CLUSTER_ACTION_FLAGS_STANDBY_SNAPSHOT

public static final int CLUSTER_ACTION_FLAGS_STANDBY_SNAPSHOT

Flag for a snapshot taken on a standby node.

See Also:

Constant Field Values

Method Detail

main

public static void main(String[] args)

Launch an ConsensusModule with that communicates with an out of process Archive and MediaDriver then awaits shutdown signal.

Parameters:

args - command line argument which is a list for properties files as URLs or filenames.

launch

public static ConsensusModule launch()

Launch an ConsensusModule using a default configuration.

Returns:

a new instance of an ConsensusModule.

launch

public static ConsensusModule launch(ConsensusModule.Context ctx)

Launch an ConsensusModule by providing a configuration context.

Parameters:

ctx - for the configuration parameters.

Returns:

a new instance of an ConsensusModule.

context

public ConsensusModule.Context context()

Get the ConsensusModule.Context that is used by this ConsensusModule.

Returns:

the ConsensusModule.Context that is used by this ConsensusModule.

conductorAgentInvoker

public AgentInvoker conductorAgentInvoker()

Get the AgentInvoker for the consensus module.

Returns:

the AgentInvoker for the consensus module.

close

public void close()

Specified by:

close in interface AutoCloseable

toString

public String toString()

Overrides:

toString in class Object