io.aeron.driver

Enum ThreadingMode

java.lang.Object

java.lang.Enum<ThreadingMode>

io.aeron.driver.ThreadingMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ThreadingMode>

public enum ThreadingMode
extends java.lang.Enum<ThreadingMode>

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

Enum Constant Summary

Enum Constants

Enum Constant and 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 and Description
static ThreadingMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ThreadingMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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 Detail

values

public static ThreadingMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ThreadingMode c : ThreadingMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static ThreadingMode valueOf(java.lang.String name)

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

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null