LogManagerImpl (jraft-core 1.3.8 1.3.8 API)

java.lang.Object
- com.alipay.sofa.jraft.storage.impl.LogManagerImpl

所有已实现的接口:

Lifecycle<LogManagerOptions>, LogManager, Describer
```
public class LogManagerImpl
extends Object
implements LogManager
```
LogManager implementation.

作者:

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

嵌套类概要
- 从接口继承的嵌套类/接口 com.alipay.sofa.jraft.storage.LogManager
  LogManager.LastLogIndexListener, LogManager.NewLogCallback, LogManager.StableClosure
- 从接口继承的嵌套类/接口 com.alipay.sofa.jraft.util.Describer
  Describer.DefaultPrinter, Describer.Printer

构造器概要

构造器
构造器和说明

LogManagerImpl()

构造器
构造器和说明
`LogManagerImpl()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`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`	`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.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - LogManagerImpl
```
public LogManagerImpl()
```
- 方法详细资料
  - addLastLogIndexListener
```
public void addLastLogIndexListener(LogManager.LastLogIndexListener listener)
```
    从接口复制的说明: LogManager
    
    Adds a last log index listener
    
    指定者:
    
    addLastLogIndexListener 在接口中 LogManager
  - removeLastLogIndexListener
```
public void removeLastLogIndexListener(LogManager.LastLogIndexListener listener)
```
    从接口复制的说明: LogManager
    
    Remove the last log index listener.
    
    指定者:
    
    removeLastLogIndexListener 在接口中 LogManager
  - init
```
public boolean init(LogManagerOptions opts)
```
    从接口复制的说明: Lifecycle
    
    Initialize the service.
    
    指定者:
    
    init 在接口中 Lifecycle<LogManagerOptions>
    
    返回:
    
    true when successes.
  - join
```
public void join()
          throws InterruptedException
```
    从接口复制的说明: LogManager
    
    Wait the log manager to be shut down.
    
    指定者:
    
    join 在接口中 LogManager
    
    抛出:
    
    InterruptedException - if the current thread is interrupted while waiting
  - shutdown
```
public void shutdown()
```
    从接口复制的说明: Lifecycle
    
    Dispose the resources for service.
    
    指定者:
    
    shutdown 在接口中 Lifecycle<LogManagerOptions>
  - appendEntries
```
public void appendEntries(List<LogEntry> entries,
                          LogManager.StableClosure done)
```
    从接口复制的说明: LogManager
    
    Append log entry vector and wait until it's stable (NOT COMMITTED!)
    
    指定者:
    
    appendEntries 在接口中 LogManager
    
    参数:
    
    entries - log entries
    
    done - callback
  - setSnapshot
```
public void setSnapshot(RaftOutter.SnapshotMeta meta)
```
    从接口复制的说明: LogManager
    
    Notify the log manager about the latest snapshot, which indicates the logs which can be safely truncated.
    
    指定者:
    
    setSnapshot 在接口中 LogManager
    
    参数:
    
    meta - snapshot metadata
  - clearBufferedLogs
```
public void clearBufferedLogs()
```
    从接口复制的说明: 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.
    
    指定者:
    
    clearBufferedLogs 在接口中 LogManager
  - getEntryFromMemory
```
protected LogEntry getEntryFromMemory(long index)
```
  - getEntry
```
public LogEntry getEntry(long index)
```
    从接口复制的说明: LogManager
    
    Get the log entry at index.
    
    指定者:
    
    getEntry 在接口中 LogManager
    
    参数:
    
    index - the index of log entry
    
    返回:
    
    the log entry with index
  - getTerm
```
public long getTerm(long index)
```
    从接口复制的说明: LogManager
    
    Get the log term at index.
    
    指定者:
    
    getTerm 在接口中 LogManager
    
    参数:
    
    index - the index of log entry
    
    返回:
    
    the term of log entry
  - getFirstLogIndex
```
public long getFirstLogIndex()
```
    从接口复制的说明: LogManager
    
    Get the first log index of log
    
    指定者:
    
    getFirstLogIndex 在接口中 LogManager
  - getLastLogIndex
```
public long getLastLogIndex()
```
    从接口复制的说明: LogManager
    
    Get the last log index of log
    
    指定者:
    
    getLastLogIndex 在接口中 LogManager
  - getLastLogIndex
```
public long getLastLogIndex(boolean isFlush)
```
    从接口复制的说明: LogManager
    
    Get the last log index of log
    
    指定者:
    
    getLastLogIndex 在接口中 LogManager
    
    参数:
    
    isFlush - whether to flush from disk.
  - getLastLogId
```
public LogId getLastLogId(boolean isFlush)
```
    从接口复制的说明: LogManager
    
    Return the id the last log.
    
    指定者:
    
    getLastLogId 在接口中 LogManager
    
    参数:
    
    isFlush - whether to flush all pending task.
  - getConfiguration
```
public ConfigurationEntry getConfiguration(long index)
```
    从接口复制的说明: LogManager
    
    Get the configuration at index.
    
    指定者:
    
    getConfiguration 在接口中 LogManager
  - checkAndSetConfiguration
```
public ConfigurationEntry checkAndSetConfiguration(ConfigurationEntry current)
```
    从接口复制的说明: LogManager
    
    Check if |current| should be updated to the latest configuration Returns the latest configuration, otherwise null.
    
    指定者:
    
    checkAndSetConfiguration 在接口中 LogManager
  - wait
```
public long wait(long expectedLastLogIndex,
                 LogManager.NewLogCallback cb,
                 Object arg)
```
    从接口复制的说明: 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.
    
    指定者:
    
    wait 在接口中 LogManager
    
    参数:
    
    expectedLastLogIndex - expected last index of log
    
    cb - callback
    
    arg - the waiter pass-in argument
  - removeWaiter
```
public boolean removeWaiter(long id)
```
    从接口复制的说明: LogManager
    
    Remove a waiter.
    
    指定者:
    
    removeWaiter 在接口中 LogManager
    
    参数:
    
    id - waiter id
    
    返回:
    
    true on success
  - setAppliedId
```
public void setAppliedId(LogId appliedId)
```
    从接口复制的说明: LogManager
    
    Set the applied id, indicating that the log before applied_id (included) can be dropped from memory logs.
    
    指定者:
    
    setAppliedId 在接口中 LogManager
  - checkConsistency
```
public Status checkConsistency()
```
    从接口复制的说明: LogManager
    
    Check log consistency, returns the status
    
    指定者:
    
    checkConsistency 在接口中 LogManager
    
    返回:
    
    status
  - describe
```
public void describe(Describer.Printer out)
```
    指定者:
    
    describe 在接口中 Describer

类 LogManagerImpl

嵌套类概要

从接口继承的嵌套类/接口 com.alipay.sofa.jraft.storage.LogManager

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

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

LogManagerImpl

方法详细资料

addLastLogIndexListener

removeLastLogIndexListener

init

join

shutdown

appendEntries

setSnapshot

clearBufferedLogs

getEntryFromMemory

getEntry

getTerm

getFirstLogIndex

getLastLogIndex

getLastLogIndex

getLastLogId

getConfiguration

checkAndSetConfiguration

wait

removeWaiter

setAppliedId

checkConsistency

describe