net.openhft.chronicle.core.threads

Enum HandlerPriority

java.lang.Object

java.lang.Enum<HandlerPriority>

net.openhft.chronicle.core.threads.HandlerPriority

All Implemented Interfaces:

Serializable, Comparable<HandlerPriority>

public enum HandlerPriority
extends Enum<HandlerPriority>

Enum representing different priority levels for event handlers in an event loop. The priority determines how frequently and in what order the handlers are executed. The alias() method exposes the effective priority used by the scheduler where an enum constant is an alias for another priority.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLOCKING Tasks involving blocking operations executed on a cached thread pool.
CONCURRENT Tasks that can be performed concurrently and may block for some time.
DAEMON Tasks run only when there is nothing else to do.
HIGH Critical tasks executed in a tight loop.
MEDIUM Tasks run about one quarter as often as HIGH.
MONITOR Background monitoring tasks.
REPLICATION Replication events processed on their own thread.
REPLICATION_TIMER Timing based replication tasks.
TIMER Timing-based tasks executed at regular intervals.

Method Summary

Modifier and Type	Method and Description
HandlerPriority	alias() Returns the effective priority used by the scheduler.
static HandlerPriority	valueOf(String name) Returns the enum constant of this type with the specified name.
static HandlerPriority[]	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

HIGH

public static final HandlerPriority HIGH

Critical tasks executed in a tight loop. Typical call frequency is on every scheduler cycle.

MEDIUM

public static final HandlerPriority MEDIUM

Tasks run about one quarter as often as HIGH. Typical call frequency is four times slower than HIGH.

TIMER

public static final HandlerPriority TIMER

Timing-based tasks executed at regular intervals. Typical interval is tens of milliseconds and the relative timing is resilient to pauses.

DAEMON

public static final HandlerPriority DAEMON

Tasks run only when there is nothing else to do. Typical call frequency is when the event loop is otherwise idle.

MONITOR

public static final HandlerPriority MONITOR

Background monitoring tasks. Typical call frequency is about once per second.

BLOCKING

public static final HandlerPriority BLOCKING

Tasks involving blocking operations executed on a cached thread pool. Frequency depends on submitted blocking work.

REPLICATION

public static final HandlerPriority REPLICATION

Replication events processed on their own thread.

Alias for MEDIUM; use alias() for the effective priority. Typical call frequency follows MEDIUM.

REPLICATION_TIMER

public static final HandlerPriority REPLICATION_TIMER

Timing based replication tasks.

Alias for TIMER; use alias() for the effective priority. Typical call frequency follows TIMER.

CONCURRENT

public static final HandlerPriority CONCURRENT

Tasks that can be performed concurrently and may block for some time.

Alias for MEDIUM; use alias() for the effective priority. Typical call frequency follows MEDIUM.

Method Detail

values

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

Returns:

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

valueOf

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

alias

public HandlerPriority alias()

Returns the effective priority used by the scheduler. Constants such as REPLICATION are aliases for other priorities.

Returns:

the priority the scheduler employs