Package com.oracle.coherence.concurrent.atomic

Interface AsyncAtomicStampedReference<V>

Type Parameters:
V - the type of object referred to by this reference
All Known Implementing Classes:
AsyncLocalAtomicStampedReference, AsyncRemoteAtomicStampedReference
public interface AsyncAtomicStampedReference<V>
An AtomicStampedReference maintains an object reference along with an integer "stamp", that can be updated atomically.

Unlike AtomicStampedReference, each method from this interface is non-blocking, which allows asynchronous invocation and consumption of the return value via CompletableFuture API. This is particularly useful when using remote implementation, because of relatively high latency associated with am inevitable network call, but we do provide a local implementation as well.

Since:
21.12
Author:
Aleks Seovic 2020.12.09

  • Method Summary

    Modifier and Type
    Method
    Description
    CompletableFuture<Boolean>
    attemptStamp(V expectedReference, int nNewStamp)
    Atomically sets the value of the stamp to the given update value if the current reference is equal to the expected reference.
    CompletableFuture<Boolean>
    compareAndSet(V expectedReference, V newReference, int nExpectedStamp, int nNewStamp)
    Atomically sets the value of both the reference and stamp to the given update values if the current reference is equal to the expected reference and the current stamp is equal to the expected stamp.
    CompletableFuture<V>
    get(int[] iaStampHolder)
    Returns the current values of both the reference and the stamp.
    CompletableFuture<V>
    getReference()
    Returns the current value of the reference.
    CompletableFuture<Integer>
    getStamp()
    Returns the current value of the stamp.
    CompletableFuture<Void>
    set(V newReference, int nNewStamp)
    Unconditionally sets the value of both the reference and stamp.

  • Method Details

    • getReference

      CompletableFuture<V> getReference()
      Returns the current value of the reference.
      Returns:
      the current value of the reference

    • getStamp

      CompletableFuture<Integer> getStamp()
      Returns the current value of the stamp.
      Returns:
      the current value of the stamp

    • get

      CompletableFuture<V> get(int[] iaStampHolder)
      Returns the current values of both the reference and the stamp. Typical usage is int[1] holder; ref = v.get(holder); .
      Parameters:
      iaStampHolder - an array of size of at least one. On return, stampHolder[0] will hold the value of the stamp
      Returns:
      the current value of the reference

    • compareAndSet

      CompletableFuture<Boolean> compareAndSet(V expectedReference, V newReference, int nExpectedStamp, int nNewStamp)
      Atomically sets the value of both the reference and stamp to the given update values if the current reference is equal to the expected reference and the current stamp is equal to the expected stamp.
      Parameters:
      expectedReference - the expected value of the reference
      newReference - the new value for the reference
      nExpectedStamp - the expected value of the stamp
      nNewStamp - the new value for the stamp
      Returns:
      true if successful

    • set

      CompletableFuture<Void> set(V newReference, int nNewStamp)
      Unconditionally sets the value of both the reference and stamp.
      Parameters:
      newReference - the new value for the reference
      nNewStamp - the new value for the stamp
      Returns:
      a CompletableFuture that can be used to determine whether the operation completed

    • attemptStamp

      CompletableFuture<Boolean> attemptStamp(V expectedReference, int nNewStamp)
      Atomically sets the value of the stamp to the given update value if the current reference is equal to the expected reference. Any given invocation of this operation may fail (return false) spuriously, but repeated invocation when the current value holds the expected value and no other thread is also attempting to set the value will eventually succeed.
      Parameters:
      expectedReference - the expected value of the reference
      nNewStamp - the new value for the stamp
      Returns:
      true if successful