org.infinispan.api.mutiny.MutinyStrongCounter Maven / Gradle / Ivy

Go to download
package org.infinispan.api.mutiny;

import org.infinispan.api.common.events.cache.CacheEntryEvent;
import org.infinispan.api.common.events.counter.CounterEvent;
import org.infinispan.api.configuration.CounterConfiguration;

import io.smallrye.mutiny.Multi;
import io.smallrye.mutiny.Uni;

/**
 * The strong consistent counter interface.
 * 
 * It provides atomic updates for the counter. All the operations are perform asynchronously and they complete the
 * {@link Uni} when completed.
 *
 * @since 14.0
 */
public interface MutinyStrongCounter {

   /**
    * @return The counter name.
    */
   String name();

   /**
    * Return the container of this counter
    *
    * @return
    */
   MutinyContainer container();


   /**
    * It fetches the current value.
    * 

    * It may go remotely to fetch the current value.
    *
    * @return The current value.
    */
   Uni value();

   /**
    * Atomically increments the counter and returns the new value.
    *
    * @return The new value.
    */
   default Uni incrementAndGet() {
      return addAndGet(1L);
   }


   /**
    * Atomically decrements the counter and returns the new value
    *
    * @return The new value.
    */
   default Uni decrementAndGet() {
      return addAndGet(-1L);
   }

   /**
    * Atomically adds the given value and return the new value.
    *
    * @param delta The non-zero value to add. It can be negative.
    * @return The new value.
    */
   Uni addAndGet(long delta);

   /**
    * Resets the counter to its initial value.
    */
   Uni reset();

   /**
    * Listens to counter events.
    *
    * @return a {@link Multi} which produces {@link CacheEntryEvent} items.
    */
   Multi listen();

   /**
    * Atomically sets the value to the given updated value if the current value {@code ==} the expected value.
    * 

    * It is the same as {@code return compareAndSwap(expect, update).thenApply(value -> value == expect);}
    *
    * @param expect the expected value
    * @param update the new value
    * @return {@code true} if successful, {@code false} otherwise.
    */
   Uni compareAndSet(long expect, long update);

   /**
    * Atomically sets the value to the given updated value if the current value {@code ==} the expected value.
    * 
    * The operation is successful if the return value is equals to the expected value.
    *
    * @param expect the expected value.
    * @param update the new value.
    * @return the previous counter's value.
    */
   Uni compareAndSwap(long expect, long update);

   /**
    * Atomically sets the value to the given updated value
    *
    * @param value the new value.
    * @return the old counter's value.
    */
   Uni getAndSet(long value);

   Uni getConfiguration();
}