io.atomix.protocols.raft.storage.log

Class RaftLog

java.lang.Object

io.atomix.storage.journal.DelegatingJournal<RaftLogEntry>

io.atomix.protocols.raft.storage.log.RaftLog

All Implemented Interfaces:

io.atomix.storage.journal.Journal<RaftLogEntry>, Closeable, AutoCloseable

public class RaftLog
extends io.atomix.storage.journal.DelegatingJournal<RaftLogEntry>

Raft log.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RaftLog.Builder Raft log builder.

Method Summary

Modifier and Type	Method and Description
static RaftLog.Builder	builder() Deprecated.
void	compact(long index) Compacts the journal up to the given index.
long	getCompactableIndex(long index) Returns the index of the last segment in the log.
boolean	isCompactable(long index) Returns a boolean indicating whether a segment can be removed from the journal prior to the given index.
static RaftLog.Builder	newBuilder() Returns a new Raft log builder.
RaftLogReader	openReader(long index)
RaftLogReader	openReader(long index, RaftLogReader.Mode mode) Opens a new Raft log reader with the given reader mode.
RaftLogWriter	writer()

Methods inherited from class io.atomix.storage.journal.DelegatingJournal

close, isOpen, toString

Methods inherited from class java.lang.Object

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

Method Detail

builder

@Deprecated
public static RaftLog.Builder builder()

Deprecated.

newBuilder

public static RaftLog.Builder newBuilder()

Returns a new Raft log builder.

Returns:

A new Raft log builder.

writer

public RaftLogWriter writer()

Specified by:

writer in interface io.atomix.storage.journal.Journal<RaftLogEntry>

Overrides:

writer in class io.atomix.storage.journal.DelegatingJournal<RaftLogEntry>

openReader

public RaftLogReader openReader(long index)

Specified by:

openReader in interface io.atomix.storage.journal.Journal<RaftLogEntry>

Overrides:

openReader in class io.atomix.storage.journal.DelegatingJournal<RaftLogEntry>

openReader

public RaftLogReader openReader(long index,
                                RaftLogReader.Mode mode)

Opens a new Raft log reader with the given reader mode.

Parameters:

index - The index from which to begin reading entries.

mode - The mode in which to read entries.

Returns:

The Raft log reader.

isCompactable

public boolean isCompactable(long index)

Returns a boolean indicating whether a segment can be removed from the journal prior to the given index.

Parameters:

index - the index from which to remove segments

Returns:

indicates whether a segment can be removed from the journal

getCompactableIndex

public long getCompactableIndex(long index)

Returns the index of the last segment in the log.

Parameters:

index - the compaction index

Returns:

the starting index of the last segment in the log

compact

public void compact(long index)

Compacts the journal up to the given index.

The semantics of compaction are not specified by this interface.

Parameters:

index - The index up to which to compact the journal.