io.aeron.driver

Class MediaDriver

java.lang.Object

io.aeron.driver.MediaDriver

All Implemented Interfaces:

java.lang.AutoCloseable

public final class MediaDriver
extends java.lang.Object
implements java.lang.AutoCloseable

Main class for JVM-based media driver Usage: $ java -jar aeron-driver.jar $ java -Doption=value -jar aeron-driver.jar Configuration

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MediaDriver.Context

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DIRS_DELETE_ON_START_PROP_NAME Attempt to delete directories on start if they exist

Method Summary

Modifier and Type	Method and Description
java.lang.String	aeronDirectoryName() Used to access the configured aeronDirectoryName for this MediaDriver, typically used after the launchEmbedded() method is used.
void	close() Shutdown the media driver by stopping all threads and freeing resources.
static MediaDriver	launch() Launch a MediaDriver embedded in the current process with default configuration.
static MediaDriver	launch(MediaDriver.Context ctx) Launch a MediaDriver embedded in the current process and provided a configuration ctx.
static MediaDriver	launchEmbedded() Launch an isolated MediaDriver embedded in the current process with a generated aeronDirectoryName that can be retrieved by calling aeronDirectoryName.
static MediaDriver	launchEmbedded(MediaDriver.Context ctx) Launch an isolated MediaDriver embedded in the current process with a provided configuration ctx and a generated aeronDirectoryName (overwrites configured CommonContext.aeronDirectoryName()) that can be retrieved by calling aeronDirectoryName.
static void	loadPropertiesFile(java.lang.String filenameOrUrl) Load system properties from a given filename or url.
static void	loadPropertiesFiles(java.lang.String[] filenamesOrUrls) Load system properties from a given set of filenames or URLs.
static void	main(java.lang.String[] args) Start Media Driver as a stand-alone process.

Methods inherited from class java.lang.Object

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

Field Detail

DIRS_DELETE_ON_START_PROP_NAME

public static final java.lang.String DIRS_DELETE_ON_START_PROP_NAME

Attempt to delete directories on start if they exist

See Also:

Constant Field Values

Method Detail

loadPropertiesFile

public static void loadPropertiesFile(java.lang.String filenameOrUrl)

Load system properties from a given filename or url. File is first searched for in resources, then file system, then URL. All are loaded if multiples found.

Parameters:

filenameOrUrl - that holds properties

loadPropertiesFiles

public static void loadPropertiesFiles(java.lang.String[] filenamesOrUrls)

Load system properties from a given set of filenames or URLs.

Parameters:

filenamesOrUrls - that holds properties

See Also:

loadPropertiesFile(String)

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Start Media Driver as a stand-alone process.

Parameters:

args - command line arguments

Throws:

java.lang.Exception - if an error occurs

launchEmbedded

public static MediaDriver launchEmbedded()

Launch an isolated MediaDriver embedded in the current process with a generated aeronDirectoryName that can be retrieved by calling aeronDirectoryName.

Returns:

the newly started MediaDriver.

launchEmbedded

public static MediaDriver launchEmbedded(MediaDriver.Context ctx)

Launch an isolated MediaDriver embedded in the current process with a provided configuration ctx and a generated aeronDirectoryName (overwrites configured CommonContext.aeronDirectoryName()) that can be retrieved by calling aeronDirectoryName. If the aeronDirectoryName is configured then it will be used.

Parameters:

ctx - containing the configuration options.

Returns:

the newly started MediaDriver.

launch

public static MediaDriver launch()

Launch a MediaDriver embedded in the current process with default configuration.

Returns:

the newly started MediaDriver.

launch

public static MediaDriver launch(MediaDriver.Context ctx)

Launch a MediaDriver embedded in the current process and provided a configuration ctx.

Parameters:

ctx - containing the configuration options.

Returns:

the newly created MediaDriver.

close

public void close()

Shutdown the media driver by stopping all threads and freeing resources.

Specified by:

close in interface java.lang.AutoCloseable

aeronDirectoryName

public java.lang.String aeronDirectoryName()

Used to access the configured aeronDirectoryName for this MediaDriver, typically used after the launchEmbedded() method is used.

Returns:

the context aeronDirectoryName