Interface IAtomicLong

IAtomicLong is a redundant and highly available distributed counter for 64-bit integers (long type in java).

It works on top of the Raft consensus algorithm. It offers linearizability during crash failures and network partitions. It is CP with respect to the CAP principle. If a network partition occurs, it remains available on at most one side of the partition.

IAtomicLong implementation does not offer exactly-once / effectively-once execution semantics. It goes with at-least-once execution semantics by default and can cause an API call to be committed multiple times in case of CP member failures. It can be tuned to offer at-most-once execution semantics. Please see fail-on-indeterminate-operation-state server-side setting.

Hierarchy

Methods

addAndGet compareAndSet decrementAndGet destroy get getAndAdd getAndDecrement getAndIncrement getAndSet getName getPartitionKey getServiceName incrementAndGet set

Methods

addAndGet

  • Atomically adds the given value to the current value.

    Returns

    the updated value, the given value added to the current value

    Parameters

    • delta: number | Long

      the value to add to the current value

    Returns Promise<Long>

compareAndSet

  • Atomically sets the value to the given updated value only if the current value equals the expected value.

    Returns

    true if successful; or false if the actual value was not equal to the expected value.

    Parameters

    • expect: number | Long

      the expected value

    • update: number | Long

      the new value

    Returns Promise<boolean>

decrementAndGet

  • Atomically decrements the current value by one.

    Returns

    the updated value, the current value decremented by one

    Returns Promise<Long>

destroy

get

getAndAdd

  • Atomically adds the given value to the current value.

    Returns

    the old value before the add

    Parameters

    • delta: number | Long

      the value to add to the current value

    Returns Promise<Long>

getAndDecrement

  • Atomically decrements the current value by one.

    Returns

    the old value

    Returns Promise<Long>

getAndIncrement

  • Atomically increments the current value by one.

    Returns

    the old value

    Returns Promise<Long>

getAndSet

  • Atomically sets the given value and returns the old value.

    Returns

    the old value

    Parameters

    • newValue: number | Long

      the new value

    Returns Promise<Long>

getName

getPartitionKey

getServiceName

incrementAndGet

  • Atomically increments the current value by one.

    Returns

    the updated value, the current value incremented by one

    Returns Promise<Long>

set

  • Atomically sets the given value.

    Parameters

    • newValue: number | Long

      the new value

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc