Package io.atomix.primitive

Class AbstractAsyncPrimitive<A extends AsyncPrimitive,S>

java.lang.Object

io.atomix.primitive.AbstractAsyncPrimitive<A,S>

All Implemented Interfaces:

AsyncPrimitive, DistributedPrimitive

public abstract class AbstractAsyncPrimitive<A extends AsyncPrimitive,S>
extends Object
implements AsyncPrimitive

Abstract base class for primitives that interact with Raft replicated state machines via proxy.

Field Summary

Fields inherited from interface io.atomix.primitive.DistributedPrimitive

DEFAULT_OPERATION_TIMEOUT_MILLIS

Method Summary

Modifier and Type	Method	Description
void	addStateChangeListener(java.util.function.Consumer<PrimitiveState> listener)	Registers a listener to be called when the primitive's state changes.
CompletableFuture<Void>	close()	Closes the primitive.
CompletableFuture<A>	connect()	Connects the primitive.
CompletableFuture<Void>	delete()	Purges state associated with this primitive.
String	name()	Returns the name of this primitive.
PrimitiveProtocol	protocol()	Returns the primitive protocol.
void	removeStateChangeListener(java.util.function.Consumer<PrimitiveState> listener)	Unregisters a previously registered listener to be called when the primitive's state changes.
String	toString()
PrimitiveType	type()	Returns the type of primitive.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.atomix.primitive.AsyncPrimitive

sync, sync

Method Details

name

public String name()

Description copied from interface: DistributedPrimitive

Returns the name of this primitive.

Specified by:

name in interface DistributedPrimitive

Returns:

name

type

public PrimitiveType type()

Description copied from interface: DistributedPrimitive

Returns the type of primitive.

Specified by:

type in interface DistributedPrimitive

Returns:

primitive type

protocol

public PrimitiveProtocol protocol()

Description copied from interface: DistributedPrimitive

Returns the primitive protocol.

Specified by:

protocol in interface DistributedPrimitive

Returns:

the primitive protocol

addStateChangeListener

public void addStateChangeListener(java.util.function.Consumer<PrimitiveState> listener)

Description copied from interface: DistributedPrimitive

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

Specified by:

addStateChangeListener in interface DistributedPrimitive

Parameters:

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

removeStateChangeListener

public void removeStateChangeListener(java.util.function.Consumer<PrimitiveState> listener)

Description copied from interface: DistributedPrimitive

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

Specified by:

removeStateChangeListener in interface DistributedPrimitive

Parameters:

listener - The listener to unregister

connect

public CompletableFuture<A> connect()

Connects the primitive.

Returns:

a future to be completed once the primitive has been connected

close

public CompletableFuture<Void> close()

Description copied from interface: AsyncPrimitive

Closes the primitive.

Specified by:

close in interface AsyncPrimitive

Returns:

a future to be completed once the primitive is closed

delete

public CompletableFuture<Void> delete()

Description copied from interface: AsyncPrimitive

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:

delete in interface AsyncPrimitive

Returns:

CompletableFuture that is completed when the operation completes

toString

public String toString()

Overrides:

toString in class Object