com.alipay.sofa.jraft.storage.impl

Class LogManagerImpl

java.lang.Object

com.alipay.sofa.jraft.storage.impl.LogManagerImpl

All Implemented Interfaces:

Lifecycle<LogManagerOptions>, LogManager, Describer

public class LogManagerImpl
extends Object
implements LogManager

LogManager implementation.

Author:

boyan (boyan@alibaba-inc.com) 2018-Apr-04 4:42:20 PM

Nested Class Summary

Nested classes/interfaces inherited from interface com.alipay.sofa.jraft.storage.LogManager

LogManager.LastLogIndexListener, LogManager.NewLogCallback, LogManager.StableClosure

Nested classes/interfaces inherited from interface com.alipay.sofa.jraft.util.Describer

Describer.DefaultPrinter, Describer.Printer

Constructor Summary

Constructors

Constructor and Description
LogManagerImpl()

Method Summary

Modifier and Type	Method and Description
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.
void	describe(Describer.Printer out)
ConfigurationEntry	getConfiguration(long index) Get the configuration at index.
LogEntry	getEntry(long index) Get the log entry at index.
protected LogEntry	getEntryFromMemory(long 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.
boolean	hasAvailableCapacityToAppendEntries(int requiredCapacity) Given specified requiredCapacity determines if that amount of space is available to append these entries.
boolean	init(LogManagerOptions opts) Initialize the service.
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.
void	shutdown() Dispose the resources for service.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

LogManagerImpl

public LogManagerImpl()

Method Detail

addLastLogIndexListener

public void addLastLogIndexListener(LogManager.LastLogIndexListener listener)

Description copied from interface: LogManager

Adds a last log index listener

Specified by:

addLastLogIndexListener in interface LogManager

removeLastLogIndexListener

public void removeLastLogIndexListener(LogManager.LastLogIndexListener listener)

Description copied from interface: LogManager

Remove the last log index listener.

Specified by:

removeLastLogIndexListener in interface LogManager

init

public boolean init(LogManagerOptions opts)

Description copied from interface: Lifecycle

Initialize the service.

Specified by:

init in interface Lifecycle<LogManagerOptions>

Returns:

true when successes.

hasAvailableCapacityToAppendEntries

public boolean hasAvailableCapacityToAppendEntries(int requiredCapacity)

Description copied from interface: LogManager

Given specified requiredCapacity determines if that amount of space is available to append these entries. Returns true when available.

Specified by:

hasAvailableCapacityToAppendEntries in interface LogManager

Returns:

Returns true when available.

join

public void join()
          throws InterruptedException

Description copied from interface: LogManager

Wait the log manager to be shut down.

Specified by:

join in interface LogManager

Throws:

InterruptedException - if the current thread is interrupted while waiting

shutdown

public void shutdown()

Description copied from interface: Lifecycle

Dispose the resources for service.

Specified by:

shutdown in interface Lifecycle<LogManagerOptions>

appendEntries

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

Description copied from interface: LogManager

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

Specified by:

appendEntries in interface LogManager

Parameters:

entries - log entries

done - callback

setSnapshot

public void setSnapshot(RaftOutter.SnapshotMeta meta)

Description copied from interface: LogManager

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

Specified by:

setSnapshot in interface LogManager

Parameters:

meta - snapshot metadata

clearBufferedLogs

public void clearBufferedLogs()

Description copied from interface: LogManager

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.

Specified by:

clearBufferedLogs in interface LogManager

getEntryFromMemory

protected LogEntry getEntryFromMemory(long index)

getEntry

public LogEntry getEntry(long index)

Description copied from interface: LogManager

Get the log entry at index.

Specified by:

getEntry in interface LogManager

Parameters:

index - the index of log entry

Returns:

the log entry with index

getTerm

public long getTerm(long index)

Description copied from interface: LogManager

Get the log term at index.

Specified by:

getTerm in interface LogManager

Parameters:

index - the index of log entry

Returns:

the term of log entry

getFirstLogIndex

public long getFirstLogIndex()

Description copied from interface: LogManager

Get the first log index of log

Specified by:

getFirstLogIndex in interface LogManager

getLastLogIndex

public long getLastLogIndex()

Description copied from interface: LogManager

Get the last log index of log

Specified by:

getLastLogIndex in interface LogManager

getLastLogIndex

public long getLastLogIndex(boolean isFlush)

Description copied from interface: LogManager

Get the last log index of log

Specified by:

getLastLogIndex in interface LogManager

Parameters:

isFlush - whether to flush from disk.

getLastLogId

public LogId getLastLogId(boolean isFlush)

Description copied from interface: LogManager

Return the id the last log.

Specified by:

getLastLogId in interface LogManager

Parameters:

isFlush - whether to flush all pending task.

getConfiguration

public ConfigurationEntry getConfiguration(long index)

Description copied from interface: LogManager

Get the configuration at index.

Specified by:

getConfiguration in interface LogManager

checkAndSetConfiguration

public ConfigurationEntry checkAndSetConfiguration(ConfigurationEntry current)

Description copied from interface: LogManager

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

Specified by:

checkAndSetConfiguration in interface LogManager

wait

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

Description copied from interface: LogManager

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.

Specified by:

wait in interface LogManager

Parameters:

expectedLastLogIndex - expected last index of log

cb - callback

arg - the waiter pass-in argument

removeWaiter

public boolean removeWaiter(long id)

Description copied from interface: LogManager

Remove a waiter.

Specified by:

removeWaiter in interface LogManager

Parameters:

id - waiter id

Returns:

true on success

setAppliedId

public void setAppliedId(LogId appliedId)

Description copied from interface: LogManager

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

Specified by:

setAppliedId in interface LogManager

checkConsistency

public Status checkConsistency()

Description copied from interface: LogManager

Check log consistency, returns the status

Specified by:

checkConsistency in interface LogManager

Returns:

status

describe

public void describe(Describer.Printer out)

Specified by:

describe in interface Describer