Package com.oracle.coherence.concurrent.atomic

Class AsyncRemoteAtomicInteger

java.lang.Object
com.oracle.coherence.concurrent.atomic.AsyncRemoteAtomicInteger
All Implemented Interfaces:
AsyncAtomicInteger
public class AsyncRemoteAtomicInteger extends Object implements AsyncAtomicInteger
The remote implementation of AsyncAtomicInteger, backed by a Coherence NamedMap entry.

Every method in this class is guaranteed to execute effectively-once, and provides cluster-wide atomicity guarantees for the backing atomic value. However, keep in mind that this comes at a significant cost -- each method invocation results in a network call to a remote owner of the backing atomic value, which means that each operation has significantly higher latency than a corresponding local implementation.

Since:
21.12
Author:
Aleks Seovic 2020.12.07

  • Constructor Details

    • AsyncRemoteAtomicInteger

      protected AsyncRemoteAtomicInteger(AsyncNamedMap<String,AtomicInteger> mapAtomic, String sName)
      Constructs a new AsyncRemoteAtomicInteger.
      Parameters:
      mapAtomic - the map that holds this atomic value
      sName - the name of this atomic value

  • Method Details

    • get

      public CompletableFuture<Integer> get()
      Description copied from interface: AsyncAtomicInteger
      Returns the current value.
      Specified by:
      get in interface AsyncAtomicInteger
      Returns:
      the current value

    • set

      public CompletableFuture<Void> set(int nNewValue)
      Description copied from interface: AsyncAtomicInteger
      Sets the value to newValue.
      Specified by:
      set in interface AsyncAtomicInteger
      Parameters:
      nNewValue - the new value
      Returns:
      a CompletableFuture that can be used to determine whether the operation completed

    • getAndSet

      public CompletableFuture<Integer> getAndSet(int nNewValue)
      Description copied from interface: AsyncAtomicInteger
      Atomically sets the value to newValue and returns the old value.
      Specified by:
      getAndSet in interface AsyncAtomicInteger
      Parameters:
      nNewValue - the new value
      Returns:
      the previous value

    • compareAndSet

      public CompletableFuture<Boolean> compareAndSet(int nExpectedValue, int nNewValue)
      Description copied from interface: AsyncAtomicInteger
      Atomically sets the value to newValue if the current value == expectedValue.
      Specified by:
      compareAndSet in interface AsyncAtomicInteger
      Parameters:
      nExpectedValue - the expected value
      nNewValue - the new value
      Returns:
      true if successful. False return indicates that the actual value was not equal to the expected value.

    • getAndIncrement

      public CompletableFuture<Integer> getAndIncrement()
      Description copied from interface: AsyncAtomicInteger
      Atomically increments the current value.

      Equivalent to getAndAdd(1).

      Specified by:
      getAndIncrement in interface AsyncAtomicInteger
      Returns:
      the previous value

    • getAndDecrement

      public CompletableFuture<Integer> getAndDecrement()
      Description copied from interface: AsyncAtomicInteger
      Atomically decrements the current value.

      Equivalent to getAndAdd(-1).

      Specified by:
      getAndDecrement in interface AsyncAtomicInteger
      Returns:
      the previous value

    • getAndAdd

      public CompletableFuture<Integer> getAndAdd(int nDelta)
      Description copied from interface: AsyncAtomicInteger
      Atomically adds the given value to the current value.
      Specified by:
      getAndAdd in interface AsyncAtomicInteger
      Parameters:
      nDelta - the value to add
      Returns:
      the previous value

    • incrementAndGet

      public CompletableFuture<Integer> incrementAndGet()
      Description copied from interface: AsyncAtomicInteger
      Atomically increments the current value.

      Equivalent to addAndGet(1).

      Specified by:
      incrementAndGet in interface AsyncAtomicInteger
      Returns:
      the updated value

    • decrementAndGet

      public CompletableFuture<Integer> decrementAndGet()
      Description copied from interface: AsyncAtomicInteger
      Atomically decrements the current value.

      Equivalent to addAndGet(-1).

      Specified by:
      decrementAndGet in interface AsyncAtomicInteger
      Returns:
      the updated value

    • addAndGet

      public CompletableFuture<Integer> addAndGet(int nDelta)
      Description copied from interface: AsyncAtomicInteger
      Atomically adds the given value to the current value.
      Specified by:
      addAndGet in interface AsyncAtomicInteger
      Parameters:
      nDelta - the value to add
      Returns:
      the updated value

    • getAndUpdate

      public CompletableFuture<Integer> getAndUpdate(Remote.IntUnaryOperator updateFunction)
      Description copied from interface: AsyncAtomicInteger
      Atomically updates the current value with the results of applying the given function, returning the previous value. The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads.
      Specified by:
      getAndUpdate in interface AsyncAtomicInteger
      Parameters:
      updateFunction - a side-effect-free function
      Returns:
      the previous value

    • getAndUpdate

      public CompletableFuture<Integer> getAndUpdate(IntUnaryOperator updateFunction)
      Description copied from interface: AsyncAtomicInteger
      Atomically updates the current value with the results of applying the given function, returning the previous value. The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads.
      Specified by:
      getAndUpdate in interface AsyncAtomicInteger
      Parameters:
      updateFunction - a side-effect-free function
      Returns:
      the previous value

    • updateAndGet

      public CompletableFuture<Integer> updateAndGet(Remote.IntUnaryOperator updateFunction)
      Description copied from interface: AsyncAtomicInteger
      Atomically updates the current value with the results of applying the given function, returning the updated value. The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads.
      Specified by:
      updateAndGet in interface AsyncAtomicInteger
      Parameters:
      updateFunction - a side-effect-free function
      Returns:
      the updated value

    • updateAndGet

      public CompletableFuture<Integer> updateAndGet(IntUnaryOperator updateFunction)
      Description copied from interface: AsyncAtomicInteger
      Atomically updates the current value with the results of applying the given function, returning the updated value. The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads.
      Specified by:
      updateAndGet in interface AsyncAtomicInteger
      Parameters:
      updateFunction - a side-effect-free function
      Returns:
      the updated value

    • getAndAccumulate

      public CompletableFuture<Integer> getAndAccumulate(int nUpdate, Remote.IntBinaryOperator accumulatorFunction)
      Description copied from interface: AsyncAtomicInteger
      Atomically updates the current value with the results of applying the given function to the current and given values, returning the previous value.

      The function should beside-effect-free, since it may be re-applied when attempted updates fail due to contention among threads. The function is applied with the current value as its first argument, and the given update as the second argument.

      Specified by:
      getAndAccumulate in interface AsyncAtomicInteger
      Parameters:
      nUpdate - the update value
      accumulatorFunction - a side-effect-free function of two arguments
      Returns:
      the previous value

    • getAndAccumulate

      public CompletableFuture<Integer> getAndAccumulate(int nUpdate, IntBinaryOperator accumulatorFunction)
      Description copied from interface: AsyncAtomicInteger
      Atomically updates the current value with the results of applying the given function to the current and given values, returning the previous value.

      The function should beside-effect-free, since it may be re-applied when attempted updates fail due to contention among threads. The function is applied with the current value as its first argument, and the given update as the second argument.

      Specified by:
      getAndAccumulate in interface AsyncAtomicInteger
      Parameters:
      nUpdate - the update value
      accumulatorFunction - a side-effect-free function of two arguments
      Returns:
      the previous value

    • accumulateAndGet

      public CompletableFuture<Integer> accumulateAndGet(int nUpdate, Remote.IntBinaryOperator accumulatorFunction)
      Description copied from interface: AsyncAtomicInteger
      Atomically updates the current value with the results of applying the given function to the current and given values, returning the updated value.

      The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads. The function is applied with the current value as its first argument, and the given update as the second argument.

      Specified by:
      accumulateAndGet in interface AsyncAtomicInteger
      Parameters:
      nUpdate - the update value
      accumulatorFunction - a side-effect-free function of two arguments
      Returns:
      the updated value

    • accumulateAndGet

      public CompletableFuture<Integer> accumulateAndGet(int nUpdate, IntBinaryOperator accumulatorFunction)
      Description copied from interface: AsyncAtomicInteger
      Atomically updates the current value with the results of applying the given function to the current and given values, returning the updated value.

      The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads. The function is applied with the current value as its first argument, and the given update as the second argument.

      Specified by:
      accumulateAndGet in interface AsyncAtomicInteger
      Parameters:
      nUpdate - the update value
      accumulatorFunction - a side-effect-free function of two arguments
      Returns:
      the updated value

    • compareAndExchange

      public CompletableFuture<Integer> compareAndExchange(int nExpectedValue, int nNewValue)
      Description copied from interface: AsyncAtomicInteger
      Atomically sets the value to newValue if the current value, referred to as the witness value, == expectedValue.
      Specified by:
      compareAndExchange in interface AsyncAtomicInteger
      Parameters:
      nExpectedValue - the expected value
      nNewValue - the new value
      Returns:
      the witness value, which will be the same as the expected value if successful

    • intValue

      public CompletableFuture<Integer> intValue()
      Description copied from interface: AsyncAtomicInteger
      Returns the current value of this AsyncAtomicInteger as an int.
      Specified by:
      intValue in interface AsyncAtomicInteger
      Returns:
      the numeric value represented by this object

    • longValue

      public CompletableFuture<Long> longValue()
      Description copied from interface: AsyncAtomicInteger
      Returns the current value of this AsyncAtomicInteger as a long after a widening primitive conversion.
      Specified by:
      longValue in interface AsyncAtomicInteger
      Returns:
      the numeric value represented by this object after conversion to type long

    • floatValue

      public CompletableFuture<Float> floatValue()
      Description copied from interface: AsyncAtomicInteger
      Returns the current value of this AsyncAtomicInteger as a float after a widening primitive conversion.
      Specified by:
      floatValue in interface AsyncAtomicInteger
      Returns:
      the numeric value represented by this object after conversion to type float

    • doubleValue

      public CompletableFuture<Double> doubleValue()
      Description copied from interface: AsyncAtomicInteger
      Returns the current value of this AsyncAtomicInteger as a double after a widening primitive conversion.
      Specified by:
      doubleValue in interface AsyncAtomicInteger
      Returns:
      the numeric value represented by this object after conversion to type double

    • byteValue

      public CompletableFuture<Byte> byteValue()
      Description copied from interface: AsyncAtomicInteger
      Returns the current value of this AsyncAtomicInteger as a byte after a narrowing primitive conversion.
      Specified by:
      byteValue in interface AsyncAtomicInteger
      Returns:
      the numeric value represented by this object after conversion to type byte

    • shortValue

      public CompletableFuture<Short> shortValue()
      Description copied from interface: AsyncAtomicInteger
      Returns the current value of this AsyncAtomicInteger as a short after a narrowing primitive conversion.
      Specified by:
      shortValue in interface AsyncAtomicInteger
      Returns:
      the numeric value represented by this object after conversion to type short

    • toString

      public String toString()
      Returns the String representation of the current value.
      Overrides:
      toString in class Object
      Returns:
      the String representation of the current value

    • invoke

      protected <R> CompletableFuture<R> invoke(Remote.Function<AtomicInteger,R> function)
      Apply specified function against the remote object and return the result.

      Any changes the function makes to the remote object will be preserved.

      Type Parameters:
      R - the type of the result
      Parameters:
      function - the function to apply
      Returns:
      the result of the function applied to a remote object

    • invoke

      protected <R> CompletableFuture<R> invoke(Remote.Function<AtomicInteger,R> function, boolean fMutate)
      Apply specified function against the remote object and return the result.

      If the fMutate argument is true, any changes to the remote object will be preserved.

      Type Parameters:
      R - the type of the result
      Parameters:
      function - the function to apply
      fMutate - flag specifying whether the function mutates the object
      Returns:
      the result of the function applied to a remote object