org.onosproject.store.primitives.impl

Class DefaultAsyncAtomicValue<V>

java.lang.Object

org.onosproject.store.primitives.impl.DefaultAsyncAtomicValue<V>

Type Parameters:

V - value type

All Implemented Interfaces:

AsyncAtomicValue<V>, DistributedPrimitive

public class DefaultAsyncAtomicValue<V>
extends Object
implements AsyncAtomicValue<V>

Default implementation of a AsyncAtomicValue.

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
DefaultAsyncAtomicValue(String name, Serializer serializer, AsyncConsistentMap<String,byte[]> backingMap)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Void>	addListener(AtomicValueEventListener<V> listener) Registers the specified listener to be notified whenever the atomic value is updated.
CompletableFuture<Boolean>	compareAndSet(V expect, V update) Atomically sets the value to the given updated value if the current value is equal to the expected value.
CompletableFuture<Void>	destroy() Purges state associated with this primitive.
CompletableFuture<V>	get() Gets the current value.
CompletableFuture<V>	getAndSet(V value) Atomically sets to the given value and returns the old value.
String	name() Returns the name of this primitive.
CompletableFuture<Void>	removeListener(AtomicValueEventListener<V> listener) Unregisters the specified listener such that it will no longer receive atomic value update notifications.
CompletableFuture<Void>	set(V value) Sets to the given 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.AsyncAtomicValue

asAtomicValue, asAtomicValue, primitiveType

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

addStatusChangeListener, applicationId, removeStatusChangeListener, statusChangeListeners

Constructor Detail

DefaultAsyncAtomicValue

public DefaultAsyncAtomicValue(String name,
                               Serializer serializer,
                               AsyncConsistentMap<String,byte[]> backingMap)

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

destroy

public CompletableFuture<Void> destroy()

Description copied from interface: DistributedPrimitive

Purges state associated with this primitive.

Implementations can override and provide appropriate clean up logic for purging any state state associated with the primitive. Whether modifications made within the destroy method have local or global visibility is left unspecified.

Specified by:

destroy in interface DistributedPrimitive

Returns:

CompletableFuture that is completed when the operation completes

compareAndSet

public CompletableFuture<Boolean> compareAndSet(V expect,
                                                V update)

Description copied from interface: AsyncAtomicValue

Atomically sets the value to the given updated value if the current value is equal to the expected value.

IMPORTANT: Equality is based on the equality of the serialized {code byte[]} representations.

Specified by:

compareAndSet in interface AsyncAtomicValue<V>

Parameters:

expect - the expected value

update - the new value

Returns:

CompletableFuture that will be completed with true if update was successful. Otherwise future will be completed with a value of false

get

public CompletableFuture<V> get()

Description copied from interface: AsyncAtomicValue

Gets the current value.

Specified by:

get in interface AsyncAtomicValue<V>

Returns:

CompletableFuture that will be completed with the value

getAndSet

public CompletableFuture<V> getAndSet(V value)

Description copied from interface: AsyncAtomicValue

Atomically sets to the given value and returns the old value.

Specified by:

getAndSet in interface AsyncAtomicValue<V>

Parameters:

value - the new value

Returns:

CompletableFuture that will be completed with the previous value

set

public CompletableFuture<Void> set(V value)

Description copied from interface: AsyncAtomicValue

Sets to the given value.

Specified by:

set in interface AsyncAtomicValue<V>

Parameters:

value - value to set

Returns:

CompletableFuture that will be completed when the operation finishes

addListener

public CompletableFuture<Void> addListener(AtomicValueEventListener<V> listener)

Description copied from interface: AsyncAtomicValue

Registers the specified listener to be notified whenever the atomic value is updated.

Specified by:

addListener in interface AsyncAtomicValue<V>

Parameters:

listener - listener to notify about events

Returns:

CompletableFuture that will be completed when the operation finishes

removeListener

public CompletableFuture<Void> removeListener(AtomicValueEventListener<V> listener)

Description copied from interface: AsyncAtomicValue

Unregisters the specified listener such that it will no longer receive atomic value update notifications.

Specified by:

removeListener in interface AsyncAtomicValue<V>

Parameters:

listener - listener to unregister

Returns:

CompletableFuture that will be completed when the operation finishes