io.atomix.primitive

Interface AsyncPrimitive

All Superinterfaces:

DistributedPrimitive

All Known Subinterfaces:

AsyncAtomicCounter, AsyncAtomicCounterMap<K>, AsyncAtomicDocumentTree<V>, AsyncAtomicIdGenerator, AsyncAtomicLock, AsyncAtomicMap<K,V>, AsyncAtomicMultimap<K,V>, AsyncAtomicNavigableMap<K,V>, AsyncAtomicSemaphore, AsyncAtomicSortedMap<K,V>, AsyncAtomicValue<V>, AsyncDistributedCollection<E>, AsyncDistributedCounter, AsyncDistributedCyclicBarrier, AsyncDistributedList<E>, AsyncDistributedLock, AsyncDistributedMap<K,V>, AsyncDistributedMultimap<K,V>, AsyncDistributedMultiset<E>, AsyncDistributedNavigableMap<K,V>, AsyncDistributedNavigableSet<E>, AsyncDistributedQueue<E>, AsyncDistributedSemaphore, AsyncDistributedSet<E>, AsyncDistributedSortedMap<K,V>, AsyncDistributedSortedSet<E>, AsyncDistributedValue<V>, AsyncLeaderElection<T>, AsyncLeaderElector<T>, AsyncTransaction, AsyncTransactionalMap<K,V>, AsyncTransactionalSet<E>, AsyncWorkQueue<E>

All Known Implementing Classes:

AbstractAsyncPrimitive

public interface AsyncPrimitive
extends DistributedPrimitive

Asynchronous primitive.

Field Summary

Fields inherited from interface io.atomix.primitive.DistributedPrimitive

DEFAULT_OPERATION_TIMEOUT_MILLIS

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Void>	close() Closes the primitive.
default CompletableFuture<Void>	delete() Purges state associated with this primitive.
SyncPrimitive	sync() Returns a synchronous wrapper around the asynchronous primitive.
SyncPrimitive	sync(Duration operationTimeout) Returns a synchronous wrapper around the asynchronous primitive.

Methods inherited from interface io.atomix.primitive.DistributedPrimitive

addStateChangeListener, name, protocol, removeStateChangeListener, type

Method Detail

close

CompletableFuture<Void> close()

Closes the primitive.

Returns:

a future to be completed once the primitive is closed

delete

default CompletableFuture<Void> delete()

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.

Returns:

CompletableFuture that is completed when the operation completes

sync

SyncPrimitive sync()

Returns a synchronous wrapper around the asynchronous primitive.

Returns:

the synchronous primitive

sync

SyncPrimitive sync(Duration operationTimeout)

Returns a synchronous wrapper around the asynchronous primitive.

Parameters:

operationTimeout - the synchronous operation timeout

Returns:

the synchronous primitive