com.neeve.server.mon
Enum SrvMonDisruptorClaimStrategy

java.lang.Object
  java.lang.Enum<SrvMonDisruptorClaimStrategy>
      com.neeve.server.mon.SrvMonDisruptorClaimStrategy

All Implemented Interfaces:

Serializable, Comparable<SrvMonDisruptorClaimStrategy>

@Generated(value="com.neeve.adm.AdmEnumeration",
           date="Wed Mar 28 10:54:31 EDT 2018")
public enum SrvMonDisruptorClaimStrategy
extends Enum<SrvMonDisruptorClaimStrategy>

Disruptor stategy for claiming the sequence of events being added to the disruptor ring buffer

Enum Constant Summary

MultiThreaded
Strategy to be used when there are multiple publisher threads claiming sequences Strategy to be used when there are multiple publisher threads claiming sequences.

MultiThreadedSufficientCores
Strategy to be used when there are multiple publisher threads claiming sequences This strategy requires sufficient cores to allow multiple publishers to be concurrently claiming sequences and those thread a contented relatively infrequently.

SingleThreaded
Optimised strategy to be used when there is a single publisher thread claiming sequences.

Unknown
Indicates the claim strategy in use is invalid or not recognized

Field Summary

static SrvMonDisruptorClaimStrategy[]	EMPTY_ARRAY A preallocated empty array used to avoid garbage when returning empty arrays.
int	val
static List<SrvMonDisruptorClaimStrategy>	VALUES A zero garbage alternative to values().

Method Summary

static SrvMonDisruptorClaimStrategy	fromCode(int code) Gets the value corresponding to the provided int 'code' value.
static SrvMonDisruptorClaimStrategy	fromCodeString(String value) Gets the value corresponding to the provided 'code' value in its String form.
static SrvMonDisruptorClaimStrategy	fromValue(int val) Gets the value corresponding to the provided 'constant' value.
String	getCodeString() Gets the code value for this enumeration as a String.
static Class<?>	getCodeType() Gets the code type with which this enumeration was generated.
static boolean	hasValue(int val) Tests if the passed in value represents a 'constant' in this enumeration.
static SrvMonDisruptorClaimStrategy	valueOf(String name) Returns the enum constant of this type with the specified name.
static SrvMonDisruptorClaimStrategy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SingleThreaded

public static final SrvMonDisruptorClaimStrategy SingleThreaded

Optimised strategy to be used when there is a single publisher thread claiming sequences.

MultiThreaded

public static final SrvMonDisruptorClaimStrategy MultiThreaded

Strategy to be used when there are multiple publisher threads claiming sequences

Strategy to be used when there are multiple publisher threads claiming sequences. This strategy is reasonably forgiving when the multiple publisher threads are highly contended or working in an environment where there is insufficient CPUs to handle multiple publisher threads.

MultiThreadedSufficientCores

public static final SrvMonDisruptorClaimStrategy MultiThreadedSufficientCores

Strategy to be used when there are multiple publisher threads claiming sequences

This strategy requires sufficient cores to allow multiple publishers to be concurrently claiming sequences and those thread a contented relatively infrequently.

Unknown

public static final SrvMonDisruptorClaimStrategy Unknown

Indicates the claim strategy in use is invalid or not recognized

Field Detail

VALUES

public static final List<SrvMonDisruptorClaimStrategy> VALUES

A zero garbage alternative to values().

EMPTY_ARRAY

public static final SrvMonDisruptorClaimStrategy[] EMPTY_ARRAY

A preallocated empty array used to avoid garbage when returning empty arrays.

val

public final int val

Method Detail

values

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

Returns:

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

valueOf

public static SrvMonDisruptorClaimStrategy 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

hasValue

public static final boolean hasValue(int val)

Tests if the passed in value represents a 'constant' in this enumeration.

Parameters:

val - The value to test for.

Returns:

true If this enumeration has the given 'constant' value.

fromValue

public static final SrvMonDisruptorClaimStrategy fromValue(int val)

Gets the value corresponding to the provided 'constant' value.

Parameters:

val - The 'constant' value to look up.

Returns:

The value corresponding to the constant value

Throws:

IllegalArgumentException - if the provided code is not a valid code for this enum

fromCode

public static final SrvMonDisruptorClaimStrategy fromCode(int code)

Gets the value corresponding to the provided int 'code' value.

Parameters:

code - The int 'code' value to look up.

Returns:

The enumeration value corresponding to the 'code' value

Throws:

IllegalArgumentException - if the provided code is not a valid code for this enum

fromCodeString

public static final SrvMonDisruptorClaimStrategy fromCodeString(String value)

Gets the value corresponding to the provided 'code' value in its String form.

Parameters:

value - The String 'code' value to look up.

Returns:

The enumeration value corresponding to the String 'code' value

Throws:

IllegalArgumentException - if the provided code is not a valid code for this enum

getCodeType

public static final Class<?> getCodeType()

Gets the code type with which this enumeration was generated.

Returns:

The code type (Character.class, Integer.class, or String.class)

getCodeString

public final String getCodeString()

Gets the code value for this enumeration as a String.

Returns:

the code value for this enumeration as a String.