net.openhft.affinity

Enum AffinityStrategies

java.lang.Object

java.lang.Enum<AffinityStrategies>

net.openhft.affinity.AffinityStrategies

All Implemented Interfaces:

Serializable, Comparable<AffinityStrategies>, AffinityStrategy

public enum AffinityStrategies
extends Enum<AffinityStrategies>
implements AffinityStrategy

Pre-defined strategies for determining which thread to pick next.

Author:

peter.lawrey

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANY Any free cpu.
DIFFERENT_CORE Must be a cpu on any other core (or socket)
DIFFERENT_SOCKET Must be a cpu on any other socket.
SAME_CORE Must be a cpu on the same core.
SAME_SOCKET Must be a cpu on the same socket/chip but different core.

Method Summary

Methods

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

Methods inherited from interface net.openhft.affinity.AffinityStrategy

matches

Enum Constant Detail

ANY

public static final AffinityStrategies ANY

Any free cpu.

SAME_CORE

public static final AffinityStrategies SAME_CORE

Must be a cpu on the same core.

SAME_SOCKET

public static final AffinityStrategies SAME_SOCKET

Must be a cpu on the same socket/chip but different core.

DIFFERENT_CORE

public static final AffinityStrategies DIFFERENT_CORE

Must be a cpu on any other core (or socket)

DIFFERENT_SOCKET

public static final AffinityStrategies DIFFERENT_SOCKET

Must be a cpu on any other socket.

Method Detail

values

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

Returns:

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

valueOf

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