net.openhft.affinity.impl

Enum NullAffinity

java.lang.Object

java.lang.Enum<NullAffinity>

net.openhft.affinity.impl.NullAffinity

All Implemented Interfaces:

Serializable, Comparable<NullAffinity>, IAffinity

public enum NullAffinity
extends Enum<NullAffinity>
implements IAffinity

Author:

peter.lawrey

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Methods

Modifier and Type	Method and Description
long	getAffinity()
int	getCpu()
int	getProcessId()
int	getThreadId()
void	setAffinity(long affinity)
static NullAffinity	valueOf(String name) Returns the enum constant of this type with the specified name.
static NullAffinity[]	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

INSTANCE

public static final NullAffinity INSTANCE

Method Detail

values

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

Returns:

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

valueOf

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

getAffinity

public long getAffinity()

Specified by:

getAffinity in interface IAffinity

Returns:

returns affinity mask for current thread, or -1 if unknown

setAffinity

public void setAffinity(long affinity)

Specified by:

setAffinity in interface IAffinity

Parameters:

affinity - sets affinity mask of current thread to specified value

getCpu

public int getCpu()

Specified by:

getCpu in interface IAffinity

Returns:

the current cpu id, or -1 if unknown.

getProcessId

public int getProcessId()

Specified by:

getProcessId in interface IAffinity

Returns:

the process id of the current process.

getThreadId

public int getThreadId()

Specified by:

getThreadId in interface IAffinity

Returns:

the thread id of the current thread or -1 is not available.