akasha.core

Class Atomics

java.lang.Object

akasha.core.Atomics

@JsType(isNative=true,
        name="Atomics",
        namespace="<global>")
 @Generated(value="org.realityforge.webtack")
public final class Atomics
extends java.lang.Object

The Atomics object provides atomic operations as static methods. They are used with SharedArrayBuffer and ArrayBuffer objects.

See Also:

Atomics - MDN, Atomics - ECMA

Method Summary

Modifier and Type	Method and Description
static int	add(IntegerTypedArray typedArray, int index, int value) Add the provided value to the existing value at the specified index of the array.
static int	and(IntegerTypedArray typedArray, int index, int value) Computes a bitwise AND on the value at the specified index of the array with the provided value.
static int	compareExchange(IntegerTypedArray typedArray, int index, int expectedValue, int replacementValue) Stores a value at the specified index of the array, if it equals a value.
static int	exchange(IntegerTypedArray typedArray, int index, int value) Stores a value at the specified index of the array.
static boolean	isLockFree(int size) An optimization primitive that can be used to determine whether to use locks or atomic operations.
static int	load(IntegerTypedArray typedArray, int index) Returns the value at the specified index of the array.
static int	or(IntegerTypedArray typedArray, int index, int value) Computes a bitwise OR on the value at the specified index of the array with the provided value.
static int	store(IntegerTypedArray typedArray, int index, int value) Stores a value at the specified index of the array.
static int	sub(IntegerTypedArray typedArray, int index, int value) Subtracts a value at the specified index of the array.
static @JsNonNull JsString	wait_(IntegerTypedArray typedArray, int index, int value) Verifies that the specified index of the array still contains a value and sleeps awaiting or times out.
static @JsNonNull JsString	wait_(IntegerTypedArray typedArray, int index, int value, int timeout) Verifies that the specified index of the array still contains a value and sleeps awaiting or times out.
static int	xor(IntegerTypedArray typedArray, int index, int value) Computes a bitwise XOR on the value at the specified index of the array with the provided value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

add

public static int add(@Nonnull
                      IntegerTypedArray typedArray,
                      int index,
                      int value)

Add the provided value to the existing value at the specified index of the array.

Returns:

the old value at the position.

See Also:

Atomics.add() - MDN, Atomics.add() - ECMA

and

public static int and(@Nonnull
                      IntegerTypedArray typedArray,
                      int index,
                      int value)

Computes a bitwise AND on the value at the specified index of the array with the provided value.

Returns:

the old value at the position.

See Also:

Atomics.and() - MDN, Atomics.and() - ECMA

compareExchange

public static int compareExchange(@Nonnull
                                  IntegerTypedArray typedArray,
                                  int index,
                                  int expectedValue,
                                  int replacementValue)

Stores a value at the specified index of the array, if it equals a value.

Returns:

the old value at the position.

See Also:

Atomics.compareExchange - MDN, Atomics.compareExchange() - ECMA

exchange

public static int exchange(@Nonnull
                           IntegerTypedArray typedArray,
                           int index,
                           int value)

Stores a value at the specified index of the array.

Returns:

the old value at the position.

See Also:

Atomics.exchange() - MDN, Atomics.exchange() - ECMA

isLockFree

public static boolean isLockFree(int size)

An optimization primitive that can be used to determine whether to use locks or atomic operations.

Returns:

true if an atomic operation on arrays of the given element size will be implemented using a hardware atomic operation (as opposed to a lock).

See Also:

MDN - Atomics.isLockFree, Atomics.isLockFree() - ECMA

load

public static int load(@Nonnull
                       IntegerTypedArray typedArray,
                       int index)

Returns the value at the specified index of the array.

Returns:

the value at the index

See Also:

Atomics.load() - MDN, Atomics.load() - ECMA

or

public static int or(@Nonnull
                     IntegerTypedArray typedArray,
                     int index,
                     int value)

Computes a bitwise OR on the value at the specified index of the array with the provided value.

Returns:

the old value at the position.

See Also:

Atomics.or() - MDN, Atomics.or() - ECMA

store

public static int store(@Nonnull
                        IntegerTypedArray typedArray,
                        int index,
                        int value)

Stores a value at the specified index of the array.

Returns:

value that has been stored.

See Also:

Atomics.store() - MDN, Atomics.store() - ECMA

sub

public static int sub(@Nonnull
                      IntegerTypedArray typedArray,
                      int index,
                      int value)

Subtracts a value at the specified index of the array.

Returns:

the old value at the position.

See Also:

Atomics.sub() - MDN, Atomics.sub() - ECMA

xor

public static int xor(@Nonnull
                      IntegerTypedArray typedArray,
                      int index,
                      int value)

Computes a bitwise XOR on the value at the specified index of the array with the provided value.

Returns:

the old value at the position.

See Also:

Atomics.xor() - MDN, Atomics.xor() - ECMA

wait_

@JsMethod(name="wait")
public static @JsNonNull JsString wait_(@Nonnull
                                                               IntegerTypedArray typedArray,
                                                               int index,
                                                               int value,
                                                               int timeout)

Verifies that the specified index of the array still contains a value and sleeps awaiting or times out. Returns either "ok", "not-equal", or "timed-out". If waiting is not allowed in the calling agent then it throws an Error exception. Most browsers will not allow wait() on the browser's main thread.

Returns:

the result state.

See Also:

Atomics.wait() - MDN, Atomics.wait() - ECMA

wait_

@JsMethod(name="wait")
public static @JsNonNull JsString wait_(@Nonnull
                                                               IntegerTypedArray typedArray,
                                                               int index,
                                                               int value)

Verifies that the specified index of the array still contains a value and sleeps awaiting or times out. Returns either "ok", "not-equal", or "timed-out". If waiting is not allowed in the calling agent then it throws an Error exception. Most browsers will not allow wait() on the browser's main thread.

Returns:

the result state.

See Also:

Atomics.wait() - MDN, Atomics.wait() - ECMA