Package com.oracle.coherence.concurrent.atomic

Class AsyncRemoteAtomicMarkableReference<V>

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

      • AsyncRemoteAtomicMarkableReference

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

    • Method Detail

      • get

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

        public CompletableFuture<Boolean> compareAndSet​(V expectedReference,
                                                V newReference,
                                                boolean fExpectedMark,
                                                boolean fNewMark)
        Description copied from interface: AsyncAtomicMarkableReference
        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.
        Specified by:
        compareAndSet in interface AsyncAtomicMarkableReference<V>
        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

      • attemptMark

        public CompletableFuture<Boolean> attemptMark​(V expectedReference,
                                              boolean fNewMark)
        Description copied from interface: AsyncAtomicMarkableReference
        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.
        Specified by:
        attemptMark in interface AsyncAtomicMarkableReference<V>
        Parameters:
        expectedReference - the expected value of the reference
        fNewMark - the new value for the mark
        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<AtomicMarkableReference<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<AtomicMarkableReference<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