com.alipay.sofa.jraft.storage

接口 LogManager

所有超级接口:

Describer, Lifecycle<LogManagerOptions>

所有已知实现类:

LogManagerImpl

public interface LogManager
extends Lifecycle<LogManagerOptions>, Describer

Log manager.

作者:

boyan (boyan@alibaba-inc.com) 2018-Apr-04 3:02:42 PM

嵌套类概要

嵌套类

限定符和类型	接口和说明
static interface	LogManager.LastLogIndexListener Listen on last log index change event, but it's not reliable, the user should not count on this listener to receive all changed events.
static interface	LogManager.NewLogCallback New log notifier callback.
static class	LogManager.StableClosure Closure to to run in stable state.

从接口继承的嵌套类/接口 com.alipay.sofa.jraft.util.Describer

Describer.DefaultPrinter, Describer.Printer

方法概要

限定符和类型	方法和说明
void	addLastLogIndexListener(LogManager.LastLogIndexListener listener) Adds a last log index listener
void	appendEntries(List<LogEntry> entries, LogManager.StableClosure done) Append log entry vector and wait until it's stable (NOT COMMITTED!)
ConfigurationEntry	checkAndSetConfiguration(ConfigurationEntry current) Check if |current| should be updated to the latest configuration Returns the latest configuration, otherwise null.
Status	checkConsistency() Check log consistency, returns the status
void	clearBufferedLogs() We don't delete all the logs before last snapshot to avoid installing snapshot on slow replica.
ConfigurationEntry	getConfiguration(long index) Get the configuration at index.
LogEntry	getEntry(long index) Get the log entry at index.
long	getFirstLogIndex() Get the first log index of log
LogId	getLastLogId(boolean isFlush) Return the id the last log.
long	getLastLogIndex() Get the last log index of log
long	getLastLogIndex(boolean isFlush) Get the last log index of log
long	getTerm(long index) Get the log term at index.
void	join() Wait the log manager to be shut down.
void	removeLastLogIndexListener(LogManager.LastLogIndexListener listener) Remove the last log index listener.
boolean	removeWaiter(long id) Remove a waiter.
void	setAppliedId(LogId appliedId) Set the applied id, indicating that the log before applied_id (included) can be dropped from memory logs.
void	setSnapshot(RaftOutter.SnapshotMeta meta) Notify the log manager about the latest snapshot, which indicates the logs which can be safely truncated.
long	wait(long expectedLastLogIndex, LogManager.NewLogCallback cb, Object arg) Wait until there are more logs since |last_log_index| and |on_new_log| would be called after there are new logs or error occurs, return the waiter id.

从接口继承的方法 com.alipay.sofa.jraft.Lifecycle

init, shutdown

从接口继承的方法 com.alipay.sofa.jraft.util.Describer

describe

方法详细资料

addLastLogIndexListener

void addLastLogIndexListener(LogManager.LastLogIndexListener listener)

Adds a last log index listener

removeLastLogIndexListener

void removeLastLogIndexListener(LogManager.LastLogIndexListener listener)

Remove the last log index listener.

join

void join()
   throws InterruptedException

Wait the log manager to be shut down.

抛出:

InterruptedException - if the current thread is interrupted while waiting

appendEntries

void appendEntries(List<LogEntry> entries,
                   LogManager.StableClosure done)

Append log entry vector and wait until it's stable (NOT COMMITTED!)

参数:

entries - log entries

done - callback

setSnapshot

void setSnapshot(RaftOutter.SnapshotMeta meta)

Notify the log manager about the latest snapshot, which indicates the logs which can be safely truncated.

参数:

meta - snapshot metadata

clearBufferedLogs

void clearBufferedLogs()

We don't delete all the logs before last snapshot to avoid installing snapshot on slow replica. Call this method to drop all the logs before last snapshot immediately.

getEntry

LogEntry getEntry(long index)

Get the log entry at index.

参数:

index - the index of log entry

返回:

the log entry with index

getTerm

long getTerm(long index)

Get the log term at index.

参数:

index - the index of log entry

返回:

the term of log entry

getFirstLogIndex

long getFirstLogIndex()

Get the first log index of log

getLastLogIndex

long getLastLogIndex()

Get the last log index of log

getLastLogIndex

long getLastLogIndex(boolean isFlush)

Get the last log index of log

参数:

isFlush - whether to flush from disk.

getLastLogId

LogId getLastLogId(boolean isFlush)

Return the id the last log.

参数:

isFlush - whether to flush all pending task.

getConfiguration

ConfigurationEntry getConfiguration(long index)

Get the configuration at index.

checkAndSetConfiguration

ConfigurationEntry checkAndSetConfiguration(ConfigurationEntry current)

Check if |current| should be updated to the latest configuration Returns the latest configuration, otherwise null.

wait

long wait(long expectedLastLogIndex,
          LogManager.NewLogCallback cb,
          Object arg)

Wait until there are more logs since |last_log_index| and |on_new_log| would be called after there are new logs or error occurs, return the waiter id.

参数:

expectedLastLogIndex - expected last index of log

cb - callback

arg - the waiter pass-in argument

removeWaiter

boolean removeWaiter(long id)

Remove a waiter.

参数:

id - waiter id

返回:

true on success

setAppliedId

void setAppliedId(LogId appliedId)

Set the applied id, indicating that the log before applied_id (included) can be dropped from memory logs.

checkConsistency

Status checkConsistency()

Check log consistency, returns the status

返回:

status