io.atomix.primitive.service

Interface PrimitiveService

All Superinterfaces:

SessionListener

All Known Implementing Classes:

AbstractPrimitiveService

public interface PrimitiveService
extends SessionListener

Base class for user-provided services.

See Also:

Commit, ServiceContext, ServiceExecutor

Method Summary

Modifier and Type	Method and Description
byte[]	apply(Commit<byte[]> commit) Applies a commit to the state machine.
void	backup(io.atomix.storage.buffer.BufferOutput<?> output) Backs up the service state to the given buffer.
default void	close() Closes the state machine.
void	init(ServiceContext context) Initializes the state machine.
void	restore(io.atomix.storage.buffer.BufferInput<?> input) Restores the service state from the given buffer.
void	tick(io.atomix.utils.time.WallClockTimestamp timestamp) Increments the Raft service time to the given timestamp.

Methods inherited from interface io.atomix.primitive.session.SessionListener

onClose, onExpire, onOpen

Method Detail

init

void init(ServiceContext context)

Initializes the state machine.

Parameters:

context - The state machine context.

Throws:

NullPointerException - if context is null

tick

void tick(io.atomix.utils.time.WallClockTimestamp timestamp)

Increments the Raft service time to the given timestamp.

Parameters:

timestamp - the service timestamp

backup

void backup(io.atomix.storage.buffer.BufferOutput<?> output)

Backs up the service state to the given buffer.

Parameters:

output - the buffer to which to back up the service state

restore

void restore(io.atomix.storage.buffer.BufferInput<?> input)

Restores the service state from the given buffer.

Parameters:

input - the buffer from which to restore the service state

apply

byte[] apply(Commit<byte[]> commit)

Applies a commit to the state machine.

Parameters:

commit - the commit to apply

Returns:

the commit result

close

default void close()

Closes the state machine.