io.atomix.primitive

Interface 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>, AsyncPrimitive, AsyncTransaction, AsyncTransactionalMap<K,V>, AsyncTransactionalSet<E>, AsyncWorkQueue<E>, AtomicCounter, AtomicCounterMap<K>, AtomicDocumentTree<V>, AtomicIdGenerator, AtomicLock, AtomicMap<K,V>, AtomicMultimap<K,V>, AtomicNavigableMap<K,V>, AtomicSemaphore, AtomicSortedMap<K,V>, AtomicValue<V>, DistributedCollection<E>, DistributedCounter, DistributedCyclicBarrier, DistributedList<E>, DistributedLock, DistributedMap<K,V>, DistributedMultimap<K,V>, DistributedMultiset<E>, DistributedNavigableMap<K,V>, DistributedNavigableSet<E>, DistributedQueue<E>, DistributedSet<E>, DistributedSortedMap<K,V>, DistributedSortedSet<E>, DistributedValue<V>, LeaderElection<T>, LeaderElector<T>, SyncPrimitive, Transaction, TransactionalMap<K,V>, TransactionalSet<E>, TransactionParticipant<T>, WorkQueue<E>

All Known Implementing Classes:

AbstractAsyncPrimitive, DistributedSemaphore, Synchronous

public interface DistributedPrimitive

Interface for all distributed primitives.

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_OPERATION_TIMEOUT_MILLIS Default timeout for primitive operations.

Method Summary

Modifier and Type	Method and Description
default void	addStateChangeListener(Consumer<PrimitiveState> listener) Registers a listener to be called when the primitive's state changes.
String	name() Returns the name of this primitive.
PrimitiveProtocol	protocol() Returns the primitive protocol.
default void	removeStateChangeListener(Consumer<PrimitiveState> listener) Unregisters a previously registered listener to be called when the primitive's state changes.
PrimitiveType	type() Returns the type of primitive.

Field Detail

DEFAULT_OPERATION_TIMEOUT_MILLIS

static final long DEFAULT_OPERATION_TIMEOUT_MILLIS

Default timeout for primitive operations.

See Also:

Constant Field Values

Method Detail

name

String name()

Returns the name of this primitive.

Returns:

name

type

PrimitiveType type()

Returns the type of primitive.

Returns:

primitive type

protocol

PrimitiveProtocol protocol()

Returns the primitive protocol.

Returns:

the primitive protocol

addStateChangeListener

default void addStateChangeListener(Consumer<PrimitiveState> listener)

Registers a listener to be called when the primitive's state changes.

Parameters:

listener - The listener to be called when the state changes.

removeStateChangeListener

default void removeStateChangeListener(Consumer<PrimitiveState> listener)

Unregisters a previously registered listener to be called when the primitive's state changes.

Parameters:

listener - The listener to unregister