io.aeron.cluster

Class ClusteredArchive

java.lang.Object

io.aeron.cluster.ClusteredArchive

All Implemented Interfaces:

AutoCloseable

public class ClusteredArchive
extends Object
implements AutoCloseable

Clustered archive which is an aggregate of a ConsensusModule and an Archive.

Method Summary

Modifier and Type	Method and Description
Archive	archive() Get the Archive used in the aggregate.
void	close()
ConsensusModule	consensusModule() Get the ConsensusModule used in the aggregate.
static ClusteredArchive	launch() Launch a new ClusteredArchive with default contexts.
static ClusteredArchive	launch(String aeronDirectoryName, Archive.Context archiveCtx, ConsensusModule.Context consensusModuleCtx) Launch a new ClusteredArchive with provided contexts.
static void	main(String[] args) Launch the clustered archive aggregate and await a shutdown signal.

Methods inherited from class java.lang.Object

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

Method Detail

main

public static void main(String[] args)

Launch the clustered archive aggregate and await a shutdown signal.

Parameters:

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

launch

public static ClusteredArchive launch()

Launch a new ClusteredArchive with default contexts.

Returns:

a new ClusteredArchive with default contexts.

launch

public static ClusteredArchive launch(String aeronDirectoryName,
                                      Archive.Context archiveCtx,
                                      ConsensusModule.Context consensusModuleCtx)

Launch a new ClusteredArchive with provided contexts.

Parameters:

aeronDirectoryName - for connecting to the MediaDriver.

archiveCtx - for configuring the Archive.

consensusModuleCtx - for the configuration of the ConsensusModule.

Returns:

a new ClusteredArchive with the provided contexts.

archive

public Archive archive()

Get the Archive used in the aggregate.

Returns:

the Archive used in the aggregate.

consensusModule

public ConsensusModule consensusModule()

Get the ConsensusModule used in the aggregate.

Returns:

the ConsensusModule used in the aggregate.

close

public void close()

Specified by:

close in interface AutoCloseable