Package com.oracle.coherence.concurrent.atomic

Class AsyncRemoteAtomicLong

  • All Implemented Interfaces:
    AsyncAtomicLong
    public class AsyncRemoteAtomicLong
extends Object
implements AsyncAtomicLong
    The remote implementation of AsyncAtomicLong, 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.03

    • Constructor Detail

      • AsyncRemoteAtomicLong

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

    • Method Detail

      • getAndSet

        public CompletableFuture<Long> getAndSet​(long lNewValue)
        Description copied from interface: AsyncAtomicLong
        Atomically sets the value to newValue and returns the old value.
        Specified by:
        getAndSet in interface AsyncAtomicLong
        Parameters:
        lNewValue - the new value
        Returns:
        the previous value

      • compareAndSet

        public CompletableFuture<Boolean> compareAndSet​(long lExpectedValue,
                                                long lNewValue)
        Description copied from interface: AsyncAtomicLong
        Atomically sets the value to newValue if the current value == expectedValue.
        Specified by:
        compareAndSet in interface AsyncAtomicLong
        Parameters:
        lExpectedValue - the expected value
        lNewValue - the new value
        Returns:
        true if successful. False return indicates that the actual value was not equal to the expected value.

      • getAndUpdate

        public CompletableFuture<Long> getAndUpdate​(Remote.LongUnaryOperator updateFunction)
        Description copied from interface: AsyncAtomicLong
        Atomically updates the current value with the results of applying the given function, returning the previous value. The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads.
        Specified by:
        getAndUpdate in interface AsyncAtomicLong
        Parameters:
        updateFunction - a side-effect-free function
        Returns:
        the previous value

      • getAndUpdate

        public CompletableFuture<Long> getAndUpdate​(LongUnaryOperator updateFunction)
        Description copied from interface: AsyncAtomicLong
        Atomically updates the current value with the results of applying the given function, returning the previous value. The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads.
        Specified by:
        getAndUpdate in interface AsyncAtomicLong
        Parameters:
        updateFunction - a side-effect-free function
        Returns:
        the previous value

      • updateAndGet

        public CompletableFuture<Long> updateAndGet​(Remote.LongUnaryOperator updateFunction)
        Description copied from interface: AsyncAtomicLong
        Atomically updates the current value with the results of applying the given function, returning the updated value. The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads.
        Specified by:
        updateAndGet in interface AsyncAtomicLong
        Parameters:
        updateFunction - a side-effect-free function
        Returns:
        the updated value

      • updateAndGet

        public CompletableFuture<Long> updateAndGet​(LongUnaryOperator updateFunction)
        Description copied from interface: AsyncAtomicLong
        Atomically updates the current value with the results of applying the given function, returning the updated value. The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads.
        Specified by:
        updateAndGet in interface AsyncAtomicLong
        Parameters:
        updateFunction - a side-effect-free function
        Returns:
        the updated value

      • getAndAccumulate

        public CompletableFuture<Long> getAndAccumulate​(long lUpdate,
                                                Remote.LongBinaryOperator accumulatorFunction)
        Description copied from interface: AsyncAtomicLong
        Atomically updates the current value with the results of applying the given function to the current and given values, returning the previous value.

        The function should beside-effect-free, since it may be re-applied when attempted updates fail due to contention among threads. The function is applied with the current value as its first argument, and the given update as the second argument.

        Specified by:
        getAndAccumulate in interface AsyncAtomicLong
        Parameters:
        lUpdate - the update value
        accumulatorFunction - a side-effect-free function of two arguments
        Returns:
        the previous value

      • getAndAccumulate

        public CompletableFuture<Long> getAndAccumulate​(long lUpdate,
                                                LongBinaryOperator accumulatorFunction)
        Description copied from interface: AsyncAtomicLong
        Atomically updates the current value with the results of applying the given function to the current and given values, returning the previous value.

        The function should beside-effect-free, since it may be re-applied when attempted updates fail due to contention among threads. The function is applied with the current value as its first argument, and the given update as the second argument.

        Specified by:
        getAndAccumulate in interface AsyncAtomicLong
        Parameters:
        lUpdate - the update value
        accumulatorFunction - a side-effect-free function of two arguments
        Returns:
        the previous value

      • accumulateAndGet

        public CompletableFuture<Long> accumulateAndGet​(long lUpdate,
                                                Remote.LongBinaryOperator accumulatorFunction)
        Description copied from interface: AsyncAtomicLong
        Atomically updates the current value with the results of applying the given function to the current and given values, returning the updated value.

        The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads. The function is applied with the current value as its first argument, and the given update as the second argument.

        Specified by:
        accumulateAndGet in interface AsyncAtomicLong
        Parameters:
        lUpdate - the update value
        accumulatorFunction - a side-effect-free function of two arguments
        Returns:
        the updated value

      • accumulateAndGet

        public CompletableFuture<Long> accumulateAndGet​(long lUpdate,
                                                LongBinaryOperator accumulatorFunction)
        Description copied from interface: AsyncAtomicLong
        Atomically updates the current value with the results of applying the given function to the current and given values, returning the updated value.

        The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads. The function is applied with the current value as its first argument, and the given update as the second argument.

        Specified by:
        accumulateAndGet in interface AsyncAtomicLong
        Parameters:
        lUpdate - the update value
        accumulatorFunction - a side-effect-free function of two arguments
        Returns:
        the updated value

      • compareAndExchange

        public CompletableFuture<Long> compareAndExchange​(long lExpectedValue,
                                                  long lNewValue)
        Description copied from interface: AsyncAtomicLong
        Atomically sets the value to newValue if the current value, referred to as the witness value, == expectedValue.
        Specified by:
        compareAndExchange in interface AsyncAtomicLong
        Parameters:
        lExpectedValue - the expected value
        lNewValue - the new value
        Returns:
        the witness value, which will be the same as the expected value if successful

      • intValue

        public CompletableFuture<Integer> intValue()
        Description copied from interface: AsyncAtomicLong
        Returns the current value of this DistributedAtomicLong as an int after a narrowing primitive conversion.
        Specified by:
        intValue in interface AsyncAtomicLong
        Returns:
        the current value of this DistributedAtomicLong as an int after a narrowing primitive conversion

      • floatValue

        public CompletableFuture<Float> floatValue()
        Description copied from interface: AsyncAtomicLong
        Returns the current value of this DistributedAtomicLong as a float after a widening primitive conversion.
        Specified by:
        floatValue in interface AsyncAtomicLong
        Returns:
        the current value of this DistributedAtomicLong as a float after a widening primitive conversion.

      • doubleValue

        public CompletableFuture<Double> doubleValue()
        Description copied from interface: AsyncAtomicLong
        Returns the current value of this DistributedAtomicLong as a double after a widening primitive conversion.
        Specified by:
        doubleValue in interface AsyncAtomicLong
        Returns:
        the current value of this DistributedAtomicLong as a double after a widening primitive conversion

      • 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<AtomicLong,​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<AtomicLong,​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