com.kabira.platform.swbuiltin

Enum EngineServices.ThrottleState

java.lang.Object

java.lang.Enum<EngineServices.ThrottleState>

com.kabira.platform.swbuiltin.EngineServices.ThrottleState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<EngineServices.ThrottleState>

Enclosing class:

EngineServices

public static enum EngineServices.ThrottleState
extends java.lang.Enum<EngineServices.ThrottleState>

Throttle state

Enum Constant Summary

Enum Constants

Enum Constant and Description
Clear Memory utilization below throttle level.
Stall Memory utilization critical.
Throttled Memory utilization above throttle level.

Method Summary

Modifier and Type	Method and Description
static EngineServices.ThrottleState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static EngineServices.ThrottleState[]	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

Clear

public static final EngineServices.ThrottleState Clear

Memory utilization below throttle level. System not congested.

Throttled

public static final EngineServices.ThrottleState Throttled

Memory utilization above throttle level. System is becoming congested. Throttle operation will block for a period of time to allow congestion to clear.

Stall

public static final EngineServices.ThrottleState Stall

Memory utilization critical. Application should stop accepting incoming work and attempt to free shared memory by processing in-flight work. In general if a system ever hits Stall, shared memory size should be increased since this system is misconfigured for the current load.

Method Detail

values

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

Returns:

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

valueOf

public static EngineServices.ThrottleState 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