Package com.oracle.coherence.concurrent.atomic

Class RemoteAtomicLong

  • All Implemented Interfaces:
    AtomicLong, Serializable
    public class RemoteAtomicLong
extends Number
implements AtomicLong
    The remote implementation of AtomicLong, 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.

    To somewhat reduce that performance penalty, consider using non-blocking AsyncAtomicLong implementation instead.

    Since:
    21.06
    Author:
    Aleks Seovic 2020.12.03
    See Also:
    Serialized Form

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      long accumulateAndGet​(long lUpdate, Remote.LongBinaryOperator accumulatorFunction)
      Atomically updates the current value with the results of applying the given function to the current and given values, returning the updated value.
      long accumulateAndGet​(long lUpdate, LongBinaryOperator accumulatorFunction)
      Atomically updates the current value with the results of applying the given function to the current and given values, returning the updated value.
      long addAndGet​(long lDelta)
      Atomically adds the given value to the current value.
      AsyncRemoteAtomicLong async()
      Return non-blocking API for this atomic value.
      long compareAndExchange​(long lExpectedValue, long lNewValue)
      Atomically sets the value to newValue if the current value, referred to as the witness value, == expectedValue.
      boolean compareAndSet​(long lExpectedValue, long lNewValue)
      Atomically sets the value to newValue if the current value == expectedValue.
      long decrementAndGet()
      Atomically decrements the current value.
      double doubleValue()
      Returns the current value of this AtomicLong as a double after a widening primitive conversion.
      float floatValue()
      Returns the current value of this AtomicLong as a float after a widening primitive conversion.
      long get()
      Returns the current value.
      long getAndAccumulate​(long lUpdate, Remote.LongBinaryOperator accumulatorFunction)
      Atomically updates the current value with the results of applying the given function to the current and given values, returning the previous value.
      long getAndAccumulate​(long lUpdate, LongBinaryOperator accumulatorFunction)
      Atomically updates the current value with the results of applying the given function to the current and given values, returning the previous value.
      long getAndAdd​(long lDelta)
      Atomically adds the given value to the current value.
      long getAndDecrement()
      Atomically decrements the current value.
      long getAndIncrement()
      Atomically increments the current value.
      long getAndSet​(long lNewValue)
      Atomically sets the value to newValue and returns the old value.
      long getAndUpdate​(Remote.LongUnaryOperator updateFunction)
      Atomically updates the current value with the results of applying the given function, returning the previous value.
      long getAndUpdate​(LongUnaryOperator updateFunction)
      Atomically updates the current value with the results of applying the given function, returning the previous value.
      long incrementAndGet()
      Atomically increments the current value.
      int intValue()
      Returns the current value of this AtomicLong as an int after a narrowing primitive conversion.
      protected <R> R invoke​(Remote.Function<AtomicLong,​R> function)
      Apply specified function against the remote object and return the result.
      protected <R> R invoke​(Remote.Function<AtomicLong,​R> function, boolean fMutate)
      Apply specified function against the remote object and return the result.
      long longValue()
      Returns the current value of this AtomicLong as a long.
      void set​(long lNewValue)
      Sets the value to newValue.
      String toString()
      Returns the String representation of the current value.
      long updateAndGet​(Remote.LongUnaryOperator updateFunction)
      Atomically updates the current value with the results of applying the given function, returning the updated value.
      long updateAndGet​(LongUnaryOperator updateFunction)
      Atomically updates the current value with the results of applying the given function, returning the updated value.

    • Method Detail

      • async

        public AsyncRemoteAtomicLong async()
        Description copied from interface: AtomicLong
        Return non-blocking API for this atomic value.
        Specified by:
        async in interface AtomicLong
        Returns:
        non-blocking API for this atomic value

      • get

        public long get()
        Description copied from interface: AtomicLong
        Returns the current value.
        Specified by:
        get in interface AtomicLong
        Returns:
        the current value

      • set

        public void set​(long lNewValue)
        Description copied from interface: AtomicLong
        Sets the value to newValue.
        Specified by:
        set in interface AtomicLong
        Parameters:
        lNewValue - the new value

      • getAndSet

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

      • compareAndSet

        public boolean compareAndSet​(long lExpectedValue,
                             long lNewValue)
        Description copied from interface: AtomicLong
        Atomically sets the value to newValue if the current value == expectedValue.
        Specified by:
        compareAndSet in interface AtomicLong
        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.

      • getAndIncrement

        public long getAndIncrement()
        Description copied from interface: AtomicLong
        Atomically increments the current value.

        Equivalent to getAndAdd(1).

        Specified by:
        getAndIncrement in interface AtomicLong
        Returns:
        the previous value

      • getAndDecrement

        public long getAndDecrement()
        Description copied from interface: AtomicLong
        Atomically decrements the current value.

        Equivalent to getAndAdd(-1).

        Specified by:
        getAndDecrement in interface AtomicLong
        Returns:
        the previous value

      • getAndAdd

        public long getAndAdd​(long lDelta)
        Description copied from interface: AtomicLong
        Atomically adds the given value to the current value.
        Specified by:
        getAndAdd in interface AtomicLong
        Parameters:
        lDelta - the value to add
        Returns:
        the previous value

      • incrementAndGet

        public long incrementAndGet()
        Description copied from interface: AtomicLong
        Atomically increments the current value.

        Equivalent to addAndGet(1).

        Specified by:
        incrementAndGet in interface AtomicLong
        Returns:
        the updated value

      • decrementAndGet

        public long decrementAndGet()
        Description copied from interface: AtomicLong
        Atomically decrements the current value.

        Equivalent to addAndGet(-1).

        Specified by:
        decrementAndGet in interface AtomicLong
        Returns:
        the updated value

      • addAndGet

        public long addAndGet​(long lDelta)
        Description copied from interface: AtomicLong
        Atomically adds the given value to the current value.
        Specified by:
        addAndGet in interface AtomicLong
        Parameters:
        lDelta - the value to add
        Returns:
        the updated value

      • getAndUpdate

        public long getAndUpdate​(Remote.LongUnaryOperator updateFunction)
        Description copied from interface: AtomicLong
        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 AtomicLong
        Parameters:
        updateFunction - a side-effect-free function
        Returns:
        the previous value

      • getAndUpdate

        public long getAndUpdate​(LongUnaryOperator updateFunction)
        Description copied from interface: AtomicLong
        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 AtomicLong
        Parameters:
        updateFunction - a side-effect-free function
        Returns:
        the previous value

      • updateAndGet

        public long updateAndGet​(Remote.LongUnaryOperator updateFunction)
        Description copied from interface: AtomicLong
        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 AtomicLong
        Parameters:
        updateFunction - a side-effect-free function
        Returns:
        the updated value

      • updateAndGet

        public long updateAndGet​(LongUnaryOperator updateFunction)
        Description copied from interface: AtomicLong
        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 AtomicLong
        Parameters:
        updateFunction - a side-effect-free function
        Returns:
        the updated value

      • getAndAccumulate

        public long getAndAccumulate​(long lUpdate,
                             Remote.LongBinaryOperator accumulatorFunction)
        Description copied from interface: AtomicLong
        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 AtomicLong
        Parameters:
        lUpdate - the update value
        accumulatorFunction - a side-effect-free function of two arguments
        Returns:
        the previous value

      • getAndAccumulate

        public long getAndAccumulate​(long lUpdate,
                             LongBinaryOperator accumulatorFunction)
        Description copied from interface: AtomicLong
        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 AtomicLong
        Parameters:
        lUpdate - the update value
        accumulatorFunction - a side-effect-free function of two arguments
        Returns:
        the previous value

      • accumulateAndGet

        public long accumulateAndGet​(long lUpdate,
                             Remote.LongBinaryOperator accumulatorFunction)
        Description copied from interface: AtomicLong
        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 AtomicLong
        Parameters:
        lUpdate - the update value
        accumulatorFunction - a side-effect-free function of two arguments
        Returns:
        the updated value

      • accumulateAndGet

        public long accumulateAndGet​(long lUpdate,
                             LongBinaryOperator accumulatorFunction)
        Description copied from interface: AtomicLong
        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 AtomicLong
        Parameters:
        lUpdate - the update value
        accumulatorFunction - a side-effect-free function of two arguments
        Returns:
        the updated value

      • compareAndExchange

        public long compareAndExchange​(long lExpectedValue,
                               long lNewValue)
        Description copied from interface: AtomicLong
        Atomically sets the value to newValue if the current value, referred to as the witness value, == expectedValue.
        Specified by:
        compareAndExchange in interface AtomicLong
        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 int intValue()
        Description copied from interface: AtomicLong
        Returns the current value of this AtomicLong as an int after a narrowing primitive conversion.
        Specified by:
        intValue in interface AtomicLong
        Specified by:
        intValue in class Number
        Returns:
        the numeric value represented by this object after conversion to type int

      • longValue

        public long longValue()
        Description copied from interface: AtomicLong
        Returns the current value of this AtomicLong as a long.
        Specified by:
        longValue in interface AtomicLong
        Specified by:
        longValue in class Number
        Returns:
        the numeric value represented by this object

      • floatValue

        public float floatValue()
        Description copied from interface: AtomicLong
        Returns the current value of this AtomicLong as a float after a widening primitive conversion.
        Specified by:
        floatValue in interface AtomicLong
        Specified by:
        floatValue in class Number
        Returns:
        the numeric value represented by this object after conversion to type float

      • doubleValue

        public double doubleValue()
        Description copied from interface: AtomicLong
        Returns the current value of this AtomicLong as a double after a widening primitive conversion.
        Specified by:
        doubleValue in interface AtomicLong
        Specified by:
        doubleValue in class Number
        Returns:
        the numeric value represented by this object after conversion to type double

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