Package com.oracle.coherence.concurrent.atomic

Interface AtomicStampedReference<V>

  • Type Parameters:
    V - the type of object referred to by this reference
    All Known Implementing Classes:
    LocalAtomicStampedReference, RemoteAtomicStampedReference
    public interface AtomicStampedReference<V>
    An AtomicStampedReference maintains an object reference along with an integer "stamp", 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
      AsyncAtomicStampedReference<V> async()
      Return non-blocking API for this atomic reference.
      boolean attemptStamp​(V expectedReference, int nNewStamp)
      Atomically sets the value of the stamp to the given update value if the current reference is == to the expected reference.
      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 == to the expected reference and the current stamp is equal to the expected stamp.
      V get​(int[] iaStampHolder)
      Returns the current values of both the reference and the stamp.
      V getReference()
      Returns the current value of the reference.
      int getStamp()
      Returns the current value of the stamp.
      void set​(V newReference, int nNewStamp)
      Unconditionally sets the value of both the reference and stamp.

    • Method Detail

      • async

        AsyncAtomicStampedReference<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

      • getStamp

        int getStamp()
        Returns the current value of the stamp.
        Returns:
        the current value of the stamp

      • get

        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

        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 == 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

        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

      • attemptStamp

        boolean attemptStamp​(V expectedReference,
                     int nNewStamp)
        Atomically sets the value of the stamp to the given update value if the current reference is == 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