io.aeron.cluster

Class ClusteredMediaDriver

java.lang.Object

io.aeron.cluster.ClusteredMediaDriver

All Implemented Interfaces:

AutoCloseable

public class ClusteredMediaDriver
extends Object
implements AutoCloseable

Clustered media driver which is an aggregate of a MediaDriver, Archive, and a ConsensusModule.

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 ClusteredMediaDriver	launch() Launch a new ClusteredMediaDriver with default contexts.
static ClusteredMediaDriver	launch(MediaDriver.Context driverCtx, Archive.Context archiveCtx, ConsensusModule.Context consensusModuleCtx) Launch a new ClusteredMediaDriver with provided contexts.
static void	main(String[] args) Launch the clustered media driver aggregate and await a shutdown signal.
MediaDriver	mediaDriver() Get the MediaDriver used in the aggregate.

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 media driver 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 ClusteredMediaDriver launch()

Launch a new ClusteredMediaDriver with default contexts.

Returns:

a new ClusteredMediaDriver with default contexts.

launch

public static ClusteredMediaDriver launch(MediaDriver.Context driverCtx,
                                          Archive.Context archiveCtx,
                                          ConsensusModule.Context consensusModuleCtx)

Launch a new ClusteredMediaDriver with provided contexts.

Parameters:

driverCtx - for configuring the MediaDriver.

archiveCtx - for configuring the Archive.

consensusModuleCtx - for the configuration of the ConsensusModule.

Returns:

a new ClusteredMediaDriver with the provided contexts.

mediaDriver

public MediaDriver mediaDriver()

Get the MediaDriver used in the aggregate.

Returns:

the MediaDriver used in the aggregate.

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