Package com.oracle.coherence.concurrent.atomic

Interface AtomicMarkableReference<V>

  • Type Parameters:
    V - the type of object referred to by this reference
    All Known Implementing Classes:
    LocalAtomicMarkableReference, RemoteAtomicMarkableReference
    public interface AtomicMarkableReference<V>
    An AtomicMarkableReference maintains an object reference along with a mark bit, that can be updated atomically.
    Since:
    21.12
    Author:
    Aleks Seovic 2020.12.09

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      AsyncAtomicMarkableReference<V> async()
      Return non-blocking API for this atomic reference.
      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.
      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.
      V get​(boolean[] abMarkHolder)
      Returns the current values of both the reference and the mark.
      V getReference()
      Returns the current value of the reference.
      boolean isMarked()
      Returns the current value of the mark.
      void set​(V newReference, boolean fNewMark)
      Unconditionally sets the value of both the reference and mark.

    • Method Detail

      • async

        AsyncAtomicMarkableReference<V> async()
        Return non-blocking API for this atomic reference.
        Returns:
        non-blocking API for this atomic reference

      • getReference

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

      • isMarked

        boolean isMarked()
        Returns the current value of the mark.
        Returns:
        the current value of the mark

      • get

        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

        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

        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

      • attemptMark

        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