Package org.opendaylight.controller.cluster.raft.spi

Class DisabledRaftStorage

java.lang.Object

org.opendaylight.controller.cluster.raft.spi.RaftStorage

org.opendaylight.controller.cluster.raft.spi.DisabledRaftStorage

All Implemented Interfaces:

EntryStore, ImmediateEntryStore, SnapshotStore

@NonNullByDefault
public final class DisabledRaftStorage
extends RaftStorage
implements ImmediateEntryStore

A RaftStorage backing non-persistent mode of RaftActor operation. It works with any actor which can provide a RaftStorageCompleter.

Nested Class Summary

Nested classes/interfaces inherited from class org.opendaylight.controller.cluster.raft.spi.RaftStorage

RaftStorage.CancellableTask<T>

Field Summary

Fields inherited from class org.opendaylight.controller.cluster.raft.spi.RaftStorage

completer, compression, directory

Constructor Summary

Constructors

Constructor	Description
DisabledRaftStorage(RaftStorageCompleter completer, Path directory, CompressionType compression, FileBackedOutputStream.Configuration streamConfig)

Method Summary

Modifier and Type	Method	Description
protected void	postStart()
protected void	preStop()
void	saveSnapshot(RaftSnapshot raftSnapshot, EntryInfo lastIncluded, @Nullable StateSnapshot.ToStorage<?> snapshot, Instant timestamp)	Saves a snapshot synchronously and delete any previous snapshots.
void	saveVotingConfig(@Nullable VotingConfig votingConfig, Instant timestamp)
void	startPersistEntry(ReplicatedLogEntry entry, RaftCallback<Long> callback)	Persists an entry to the applicable journal asynchronously.

Methods inherited from class org.opendaylight.controller.cluster.raft.spi.RaftStorage

addToStringAtrributes, completer, lastSnapshot, memberId, saveSnapshot, start, stop, streamToInstall, submitTask, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opendaylight.controller.cluster.raft.spi.EntryStore

completer, persistEntry

Methods inherited from interface org.opendaylight.controller.cluster.raft.spi.ImmediateEntryStore

checkpointLastApplied, discardHead, discardTail

Constructor Details

DisabledRaftStorage

public DisabledRaftStorage(RaftStorageCompleter completer,
 Path directory,
 CompressionType compression,
 FileBackedOutputStream.Configuration streamConfig)

Method Details

postStart

protected void postStart()

Specified by:

postStart in class RaftStorage

preStop

protected void preStop()

Specified by:

preStop in class RaftStorage

startPersistEntry

public void startPersistEntry(ReplicatedLogEntry entry,
 RaftCallback<Long> callback)

Description copied from interface: EntryStore

Persists an entry to the applicable journal asynchronously.

Specified by:

startPersistEntry in interface EntryStore

Specified by:

startPersistEntry in interface ImmediateEntryStore

Parameters:

entry - the journal entry to persist

callback - the callback when persistence is complete

saveSnapshot

public void saveSnapshot(RaftSnapshot raftSnapshot,
 EntryInfo lastIncluded,
 @Nullable StateSnapshot.ToStorage<?> snapshot,
 Instant timestamp)
                  throws IOException

Description copied from interface: SnapshotStore

Saves a snapshot synchronously and delete any previous snapshots. This method should only be called during recovery.

Specified by:

saveSnapshot in interface SnapshotStore

Overrides:

saveSnapshot in class RaftStorage

Parameters:

raftSnapshot - the RaftSnapshot

lastIncluded - last included index/term

snapshot - the snapshot, or null if not applicable

timestamp - snapshot timestamp

Throws:

IOException - when an I/O error occurs

saveVotingConfig

public void saveVotingConfig(@Nullable VotingConfig votingConfig,
 Instant timestamp)
                      throws IOException

Throws:

IOException