Package com.oracle.coherence.concurrent.atomic

Interface AsyncAtomicMarkableReference<V>

Type Parameters:
V - the type of object referred to by this reference
All Known Implementing Classes:
AsyncLocalAtomicMarkableReference, AsyncRemoteAtomicMarkableReference
public interface AsyncAtomicMarkableReference<V>
An AtomicMarkableReference maintains an object reference along with a mark bit, that can be updated atomically.

Unlike AtomicMarkableReference, 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>
    attemptMark(V expectedReference, boolean fNewMark)
    Atomically sets the value of the mark to the given update value if the current reference is equal to the expected reference.
    CompletableFuture<Boolean>
    compareAndSet(V expectedReference, V newReference, boolean fExpectedMark, boolean fNewMark)
    Atomically sets the value of both the reference and mark to the given update values if the current reference is equal to the expected reference and the current mark is equal to the expected mark.
    CompletableFuture<V>
    get(boolean[] abMarkHolder)
    Returns the current values of both the reference and the mark.
    CompletableFuture<V>
    getReference()
    Returns the current value of the reference.
    CompletableFuture<Boolean>
    isMarked()
    Returns the current value of the mark.
    CompletableFuture<Void>
    set(V newReference, boolean fNewMark)
    Unconditionally sets the value of both the reference and mark.

  • Method Details

    • getReference

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

    • isMarked

      CompletableFuture<Boolean> isMarked()
      Returns the current value of the mark.
      Returns:
      the current value of the mark

    • get

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

    • compareAndSet

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

    • set

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

    • attemptMark

      CompletableFuture<Boolean> attemptMark(V expectedReference, boolean fNewMark)
      Atomically sets the value of the mark 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
      fNewMark - the new value for the mark
      Returns:
      true if successful