Affinity (OpenHFT/Java-Thread-Affinity Parent 3.0.2-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<Affinity>
- - net.openhft.affinity.Affinity

All Implemented Interfaces:

Serializable, Comparable<Affinity>
```
public enum Affinity
extends Enum<Affinity>
```
Library to wrap low level JNI or JNA calls. Can be called without needing to know the actual implementation used.

Author:

peter.lawrey

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static AffinityLock`	`acquireCore()`
`static AffinityLock`	`acquireCore(boolean bind)`
`static AffinityLock`	`acquireLock()`
`static AffinityLock`	`acquireLock(boolean bind)`
`static BitSet`	`getAffinity()`
`static IAffinity`	`getAffinityImpl()`
`static int`	`getCpu()`
`static int`	`getThreadId()`
`static boolean`	`isJNAAvailable()`
`static void`	`resetToBaseAffinity()`
`static void`	`setAffinity(BitSet affinity)`
`static void`	`setAffinity(int cpu)`
`static void`	`setThreadId()`
`static Affinity`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Affinity[]`	`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

- Method Detail
  - values
```
public static Affinity[] 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 (Affinity c : Affinity.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Affinity 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
  - getAffinityImpl
```
public static IAffinity getAffinityImpl()
```
  - getAffinity
```
public static BitSet getAffinity()
```
  - setAffinity
```
public static void setAffinity(int cpu)
```
  - setAffinity
```
public static void setAffinity(BitSet affinity)
```
  - getCpu
```
public static int getCpu()
```
  - getThreadId
```
public static int getThreadId()
```
  - setThreadId
```
public static void setThreadId()
```
  - isJNAAvailable
```
public static boolean isJNAAvailable()
```
  - acquireLock
```
public static AffinityLock acquireLock()
```
  - acquireCore
```
public static AffinityLock acquireCore()
```
  - acquireLock
```
public static AffinityLock acquireLock(boolean bind)
```
  - acquireCore
```
public static AffinityLock acquireCore(boolean bind)
```
  - resetToBaseAffinity
```
public static void resetToBaseAffinity()
```

Enum Affinity

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Method Detail

values

valueOf

getAffinityImpl

getAffinity

setAffinity

setAffinity

getCpu

getThreadId

setThreadId

isJNAAvailable

acquireLock

acquireCore

acquireLock

acquireCore

resetToBaseAffinity