Package com.oracle.coherence.concurrent.atomic

Class AsyncRemoteAtomicReference<V>

java.lang.Object
com.oracle.coherence.concurrent.atomic.AsyncRemoteAtomicReference<V>
Type Parameters:
V - the type of object referred to by this reference
All Implemented Interfaces:
AsyncAtomicReference<V>
public class AsyncRemoteAtomicReference<V> extends Object implements AsyncAtomicReference<V>
The remote implementation of AsyncAtomicReference, 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.08

  • Constructor Details

    • AsyncRemoteAtomicReference

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

  • Method Details

    • get

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

    • set

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

    • getAndSet

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

    • compareAndSet

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

    • getAndUpdate

      public CompletableFuture<V> getAndUpdate(Remote.UnaryOperator<V> updateFunction)
      Description copied from interface: AsyncAtomicReference
      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 AsyncAtomicReference<V>
      Parameters:
      updateFunction - a side-effect-free function
      Returns:
      the previous value

    • getAndUpdate

      public CompletableFuture<V> getAndUpdate(UnaryOperator<V> updateFunction)
      Description copied from interface: AsyncAtomicReference
      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 AsyncAtomicReference<V>
      Parameters:
      updateFunction - a side-effect-free function
      Returns:
      the previous value

    • updateAndGet

      public CompletableFuture<V> updateAndGet(Remote.UnaryOperator<V> updateFunction)
      Description copied from interface: AsyncAtomicReference
      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 AsyncAtomicReference<V>
      Parameters:
      updateFunction - a side-effect-free function
      Returns:
      the updated value

    • updateAndGet

      public CompletableFuture<V> updateAndGet(UnaryOperator<V> updateFunction)
      Description copied from interface: AsyncAtomicReference
      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 AsyncAtomicReference<V>
      Parameters:
      updateFunction - a side-effect-free function
      Returns:
      the updated value

    • getAndAccumulate

      public CompletableFuture<V> getAndAccumulate(V x, Remote.BinaryOperator<V> accumulatorFunction)
      Description copied from interface: AsyncAtomicReference
      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 AsyncAtomicReference<V>
      Parameters:
      x - the update value
      accumulatorFunction - a side-effect-free function of two arguments
      Returns:
      the previous value

    • getAndAccumulate

      public CompletableFuture<V> getAndAccumulate(V x, BinaryOperator<V> accumulatorFunction)
      Description copied from interface: AsyncAtomicReference
      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 AsyncAtomicReference<V>
      Parameters:
      x - the update value
      accumulatorFunction - a side-effect-free function of two arguments
      Returns:
      the previous value

    • accumulateAndGet

      public CompletableFuture<V> accumulateAndGet(V x, Remote.BinaryOperator<V> accumulatorFunction)
      Description copied from interface: AsyncAtomicReference
      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 AsyncAtomicReference<V>
      Parameters:
      x - the update value
      accumulatorFunction - a side-effect-free function of two arguments
      Returns:
      the updated value

    • accumulateAndGet

      public CompletableFuture<V> accumulateAndGet(V x, BinaryOperator<V> accumulatorFunction)
      Description copied from interface: AsyncAtomicReference
      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 AsyncAtomicReference<V>
      Parameters:
      x - the update value
      accumulatorFunction - a side-effect-free function of two arguments
      Returns:
      the updated value

    • compareAndExchange

      public CompletableFuture<V> compareAndExchange(V expectedValue, V newValue)
      Description copied from interface: AsyncAtomicReference
      Atomically sets the value to newValue if the current value, referred to as the witness value, is equal to the expectedValue.
      Specified by:
      compareAndExchange in interface AsyncAtomicReference<V>
      Parameters:
      expectedValue - the expected value
      newValue - the new value
      Returns:
      the witness value, which will be the same as the expected value if successful

    • 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<AtomicReference<V>,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<AtomicReference<V>,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