Package io.atomix.client.value

Interface AsyncAtomicValue<V>

Type Parameters:

V - value type

All Superinterfaces:

AsyncPrimitive<AsyncAtomicValue<V>,AtomicValue<V>>, DistributedPrimitive

public interface AsyncAtomicValue<V>
extends AsyncPrimitive<AsyncAtomicValue<V>,AtomicValue<V>>

Distributed version of java.util.concurrent.atomic.AtomicReference.

All methods of this interface return a future immediately after a successful invocation. The operation itself is executed asynchronous and the returned future will be completed when the operation finishes.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Versioned<V>>	get()	Gets the current value.
default CompletableFuture<Cancellable>	listen(AtomicValueEventListener<V> listener)	Registers the specified listener to be notified whenever the atomic value is updated.
CompletableFuture<Cancellable>	listen(AtomicValueEventListener<V> listener, Executor executor)	Registers the specified listener to be notified whenever the atomic value is updated.
CompletableFuture<Versioned<V>>	set(V value)	Sets to the given value.
CompletableFuture<Versioned<V>>	set(V value, long version)	Sets to the given value.
default AtomicValue<V>	sync(Duration operationTimeout)	Returns a synchronous wrapper around the asynchronous primitive.

Methods inherited from interface io.atomix.client.AsyncPrimitive

close, sync

Methods inherited from interface io.atomix.client.DistributedPrimitive

name

Method Details

get

CompletableFuture<Versioned<V>> get()

Gets the current value.

Returns:

current value

set

CompletableFuture<Versioned<V>> set(V value)

Sets to the given value.

Parameters:

value - new value

Returns:

previous versioned value

set

CompletableFuture<Versioned<V>> set(V value,
 long version)

Sets to the given value.

Parameters:

value - new value

Returns:

previous versioned value

listen

default CompletableFuture<Cancellable> listen(AtomicValueEventListener<V> listener)

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

Parameters:

listener - listener to notify about events

Returns:

CompletableFuture that will be completed when the operation finishes

listen

CompletableFuture<Cancellable> listen(AtomicValueEventListener<V> listener,
 Executor executor)

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

Parameters:

listener - listener to notify about events

Returns:

CompletableFuture that will be completed when the operation finishes

sync

default AtomicValue<V> sync(Duration operationTimeout)

Description copied from interface: AsyncPrimitive

Returns a synchronous wrapper around the asynchronous primitive.

Specified by:

sync in interface AsyncPrimitive<AsyncAtomicValue<V>,AtomicValue<V>>

Parameters:

operationTimeout - the synchronous operation timeout

Returns:

the synchronous primitive