Package com.oracle.coherence.concurrent.atomic

Class AsyncRemoteAtomicStampedReference<V>

  • Type Parameters:
    V - the type of object referred to by this reference
    All Implemented Interfaces:
    AsyncAtomicStampedReference<V>
    public class AsyncRemoteAtomicStampedReference<V>
extends Object
implements AsyncAtomicStampedReference<V>
    The remote implementation of AsyncAtomicStampedReference, 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.09

    • Constructor Detail

      • AsyncRemoteAtomicStampedReference

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

    • Method Detail

      • get

        public CompletableFuture<V> get​(int[] iaStampHolder)
        Description copied from interface: AsyncAtomicStampedReference
        Returns the current values of both the reference and the stamp. Typical usage is int[1] holder; ref = v.get(holder); .
        Specified by:
        get in interface AsyncAtomicStampedReference<V>
        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

        public CompletableFuture<Boolean> compareAndSet​(V expectedReference,
                                                V newReference,
                                                int nExpectedStamp,
                                                int newStamp)
        Description copied from interface: AsyncAtomicStampedReference
        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.
        Specified by:
        compareAndSet in interface AsyncAtomicStampedReference<V>
        Parameters:
        expectedReference - the expected value of the reference
        newReference - the new value for the reference
        nExpectedStamp - the expected value of the stamp
        newStamp - the new value for the stamp
        Returns:
        true if successful

      • attemptStamp

        public CompletableFuture<Boolean> attemptStamp​(V expectedReference,
                                               int nNewStamp)
        Description copied from interface: AsyncAtomicStampedReference
        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.
        Specified by:
        attemptStamp in interface AsyncAtomicStampedReference<V>
        Parameters:
        expectedReference - the expected value of the reference
        nNewStamp - the new value for the stamp
        Returns:
        true 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<AtomicStampedReference<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<AtomicStampedReference<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