Class Counter

java.lang.Object
io.vertx.rxjava3.core.shareddata.Counter
All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate
public class Counter extends Object implements io.vertx.lang.rx.RxDelegate
An asynchronous counter that can be used to across the cluster to maintain a consistent count.

NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.

  • Field Details

    • __TYPE_ARG

      public static final io.vertx.lang.rx.TypeArg<Counter> __TYPE_ARG

  • Constructor Details

    • Counter

      public Counter(Counter delegate)

    • Counter

      public Counter(Object delegate)

  • Method Details

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • getDelegate

      public Counter getDelegate()
      Specified by:
      getDelegate in interface io.vertx.lang.rx.RxDelegate

    • get

      public Single<Long> get()
      Get the current value of the counter
      Returns:
      a future notified with the value

    • rxGet

      public Single<Long> rxGet()
      Get the current value of the counter
      Returns:
      a future notified with the value

    • incrementAndGet

      public Single<Long> incrementAndGet()
      Increment the counter atomically and return the new count
      Returns:
      a future notified with the value

    • rxIncrementAndGet

      public Single<Long> rxIncrementAndGet()
      Increment the counter atomically and return the new count
      Returns:
      a future notified with the value

    • getAndIncrement

      public Single<Long> getAndIncrement()
      Increment the counter atomically and return the value before the increment.
      Returns:
      a future notified with the value

    • rxGetAndIncrement

      public Single<Long> rxGetAndIncrement()
      Increment the counter atomically and return the value before the increment.
      Returns:
      a future notified with the value

    • decrementAndGet

      public Single<Long> decrementAndGet()
      Decrement the counter atomically and return the new count
      Returns:
      a future notified with the value

    • rxDecrementAndGet

      public Single<Long> rxDecrementAndGet()
      Decrement the counter atomically and return the new count
      Returns:
      a future notified with the value

    • addAndGet

      public Single<Long> addAndGet(long value)
      Add the value to the counter atomically and return the new count
      Parameters:
      value - the value to add
      Returns:
      a future notified with the value

    • rxAddAndGet

      public Single<Long> rxAddAndGet(long value)
      Add the value to the counter atomically and return the new count
      Parameters:
      value - the value to add
      Returns:
      a future notified with the value

    • getAndAdd

      public Single<Long> getAndAdd(long value)
      Add the value to the counter atomically and return the value before the add
      Parameters:
      value - the value to add
      Returns:
      a future notified with the value

    • rxGetAndAdd

      public Single<Long> rxGetAndAdd(long value)
      Add the value to the counter atomically and return the value before the add
      Parameters:
      value - the value to add
      Returns:
      a future notified with the value

    • compareAndSet

      public Single<Boolean> compareAndSet(long expected, long value)
      Set the counter to the specified value only if the current value is the expectec value. This happens atomically.
      Parameters:
      expected - the expected value
      value - the new value
      Returns:
      a future notified with true on success

    • rxCompareAndSet

      public Single<Boolean> rxCompareAndSet(long expected, long value)
      Set the counter to the specified value only if the current value is the expectec value. This happens atomically.
      Parameters:
      expected - the expected value
      value - the new value
      Returns:
      a future notified with true on success

    • newInstance

      public static Counter newInstance(Counter arg)