org.onosproject.store.primitives.resources.impl

Class AtomixCounter

java.lang.Object

org.onosproject.store.primitives.resources.impl.AtomixCounter

All Implemented Interfaces:

AsyncAtomicCounter, DistributedPrimitive

public class AtomixCounter
extends Object
implements AsyncAtomicCounter

AsyncAtomicCounter implementation backed by Atomix DistributedLong.

Nested Class Summary

Nested classes/interfaces inherited from interface org.onosproject.store.service.DistributedPrimitive

DistributedPrimitive.Status, DistributedPrimitive.Type

Field Summary

Fields inherited from interface org.onosproject.store.service.DistributedPrimitive

DEFAULT_OPERTATION_TIMEOUT_MILLIS

Constructor Summary

Constructors

Constructor and Description
AtomixCounter(String name, io.atomix.variables.DistributedLong distLong)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Long>	addAndGet(long delta) Atomically adds the given value to the current value.
CompletableFuture<Boolean>	compareAndSet(long expectedValue, long updateValue) Atomically sets the given counter to the updated value if the current value is the expected value, otherwise no change occurs.
CompletableFuture<Long>	get() Returns the current value of the counter without modifying it.
CompletableFuture<Long>	getAndAdd(long delta) Atomically adds the given value to the current value.
CompletableFuture<Long>	getAndIncrement() Atomically increment by one the current value.
CompletableFuture<Long>	incrementAndGet() Atomically increment by one the current value.
String	name() Returns the name of this primitive.
CompletableFuture<Void>	set(long value) Atomically sets the given value to the current value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.onosproject.store.service.AsyncAtomicCounter

asAtomicCounter, asAtomicCounter, primitiveType

Methods inherited from interface org.onosproject.store.service.DistributedPrimitive

addStatusChangeListener, applicationId, destroy, removeStatusChangeListener, statusChangeListeners

Constructor Detail

AtomixCounter

public AtomixCounter(String name,
                     io.atomix.variables.DistributedLong distLong)

Method Detail

name

public String name()

Description copied from interface: DistributedPrimitive

Returns the name of this primitive.

Specified by:

name in interface DistributedPrimitive

Returns:

name

incrementAndGet

public CompletableFuture<Long> incrementAndGet()

Description copied from interface: AsyncAtomicCounter

Atomically increment by one the current value.

Specified by:

incrementAndGet in interface AsyncAtomicCounter

Returns:

updated value

getAndIncrement

public CompletableFuture<Long> getAndIncrement()

Description copied from interface: AsyncAtomicCounter

Atomically increment by one the current value.

Specified by:

getAndIncrement in interface AsyncAtomicCounter

Returns:

previous value

getAndAdd

public CompletableFuture<Long> getAndAdd(long delta)

Description copied from interface: AsyncAtomicCounter

Atomically adds the given value to the current value.

Specified by:

getAndAdd in interface AsyncAtomicCounter

Parameters:

delta - the value to add

Returns:

previous value

addAndGet

public CompletableFuture<Long> addAndGet(long delta)

Description copied from interface: AsyncAtomicCounter

Atomically adds the given value to the current value.

Specified by:

addAndGet in interface AsyncAtomicCounter

Parameters:

delta - the value to add

Returns:

updated value

get

public CompletableFuture<Long> get()

Description copied from interface: AsyncAtomicCounter

Returns the current value of the counter without modifying it.

Specified by:

get in interface AsyncAtomicCounter

Returns:

current value

set

public CompletableFuture<Void> set(long value)

Description copied from interface: AsyncAtomicCounter

Atomically sets the given value to the current value.

Specified by:

set in interface AsyncAtomicCounter

Parameters:

value - new value

Returns:

future void

compareAndSet

public CompletableFuture<Boolean> compareAndSet(long expectedValue,
                                                long updateValue)

Description copied from interface: AsyncAtomicCounter

Atomically sets the given counter to the updated value if the current value is the expected value, otherwise no change occurs.

Specified by:

compareAndSet in interface AsyncAtomicCounter

Parameters:

expectedValue - the expected current value of the counter

updateValue - the new value to be set

Returns:

true if the update occurred and the expected value was equal to the current value, false otherwise