io.aeron.driver.media

Enum ControlMode

java.lang.Object

java.lang.Enum<ControlMode>

io.aeron.driver.media.ControlMode

All Implemented Interfaces:

Serializable, Comparable<ControlMode>

public enum ControlMode
extends Enum<ControlMode>

Represents the control mode specified on a channel URI.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DYNAMIC The stream should use dynamic MDC.
MANUAL The stream should use manual MDC.
NONE The default when no control mode is specified.

Method Summary

Modifier and Type	Method and Description
boolean	isMultiDestination() Indicates if this is a multi-destination control mode.
static ControlMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static ControlMode[]	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

NONE

public static final ControlMode NONE

The default when no control mode is specified. Will mean that the stream is a normal one without MDC or similar.

DYNAMIC

public static final ControlMode DYNAMIC

The stream should use dynamic MDC.

MANUAL

public static final ControlMode MANUAL

The stream should use manual MDC.

Method Detail

values

public static ControlMode[] 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 (ControlMode c : ControlMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static ControlMode valueOf(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:

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

NullPointerException - if the argument is null

isMultiDestination

public boolean isMultiDestination()

Indicates if this is a multi-destination control mode.

Returns:

true if this is multi-destination false otherwise.