Package io.aeron.driver

Enum Class ThreadingMode

java.lang.Object

java.lang.Enum<ThreadingMode>

io.aeron.driver.ThreadingMode

All Implemented Interfaces:

Serializable, Comparable<ThreadingMode>, Constable

public enum ThreadingMode
extends Enum<ThreadingMode>

Threading mode to be employed by the Agents in the MediaDriver.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEDICATED	3 Threads, one dedicated to each of the Agents.
INVOKER	No threads are started in the MediaDriver.
SHARED	One thread shared by all 3 Agents.
SHARED_NETWORK	One thread shared by both the Sender and Receiver agents, plus one for the DriverConductor.

Method Summary

Modifier and Type	Method	Description
static ThreadingMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ThreadingMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INVOKER

public static final ThreadingMode INVOKER

No threads are started in the MediaDriver.

All 3 Agents will be composed a CompositeAgent and made runnable via an AgentInvoker in the MediaDriver.Context.

SHARED

public static final ThreadingMode SHARED

One thread shared by all 3 Agents.

SHARED_NETWORK

public static final ThreadingMode SHARED_NETWORK

One thread shared by both the Sender and Receiver agents, plus one for the DriverConductor.

DEDICATED

public static final ThreadingMode DEDICATED

3 Threads, one dedicated to each of the Agents.

Method Details

values

public static ThreadingMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ThreadingMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null