FSMCallerImpl (jraft-core 1.3.8 1.3.8 API)

java.lang.Object
- com.alipay.sofa.jraft.core.FSMCallerImpl

所有已实现的接口:

FSMCaller, Lifecycle<FSMCallerOptions>, Describer
```
public class FSMCallerImpl
extends Object
implements FSMCaller
```
The finite state machine caller implementation.

作者:

boyan (boyan@alibaba-inc.com) 2018-Apr-03 11:12:14 AM

嵌套类概要

嵌套类
限定符和类型类和说明

class FSMCallerImpl.OnErrorClosure
Closure runs with an error.
- 从接口继承的嵌套类/接口 com.alipay.sofa.jraft.FSMCaller
  FSMCaller.LastAppliedLogIndexListener
- 从接口继承的嵌套类/接口 com.alipay.sofa.jraft.util.Describer
  Describer.DefaultPrinter, Describer.Printer

嵌套类
限定符和类型	类和说明
`class`	`FSMCallerImpl.OnErrorClosure` Closure runs with an error.

构造器概要

构造器
构造器和说明

FSMCallerImpl()

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addLastAppliedLogIndexListener(FSMCaller.LastAppliedLogIndexListener listener)` Adds a LastAppliedLogIndexListener.
`void`	`describe(Describer.Printer out)`
`long`	`getLastAppliedIndex()` Returns the last log entry index to apply state machine.
`boolean`	`init(FSMCallerOptions opts)` Initialize the service.
`void`	`join()` Called after shutdown to wait it terminates.
`boolean`	`onCommitted(long committedIndex)` Called when log entry committed
`boolean`	`onError(RaftException error)` Called when error happens.
`boolean`	`onLeaderStart(long term)` Called when the leader starts.
`boolean`	`onLeaderStop(Status status)` Called when the leader stops.
`boolean`	`onSnapshotLoad(LoadSnapshotClosure done)` Called after loading snapshot.
`boolean`	`onSnapshotSave(SaveSnapshotClosure done)` Called after saving snapshot.
`boolean`	`onStartFollowing(LeaderChangeContext ctx)` Called when start following a leader.
`boolean`	`onStopFollowing(LeaderChangeContext ctx)` Called when stop following a leader.
`void`	`shutdown()` Dispose the resources for service.
`String`	`toString()`

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

- 构造器详细资料
  - FSMCallerImpl
```
public FSMCallerImpl()
```
- 方法详细资料
  - init
```
public boolean init(FSMCallerOptions opts)
```
    从接口复制的说明: Lifecycle
    
    Initialize the service.
    
    指定者:
    
    init 在接口中 Lifecycle<FSMCallerOptions>
    
    返回:
    
    true when successes.
  - shutdown
```
public void shutdown()
```
    从接口复制的说明: Lifecycle
    
    Dispose the resources for service.
    
    指定者:
    
    shutdown 在接口中 Lifecycle<FSMCallerOptions>
  - addLastAppliedLogIndexListener
```
public void addLastAppliedLogIndexListener(FSMCaller.LastAppliedLogIndexListener listener)
```
    从接口复制的说明: FSMCaller
    
    Adds a LastAppliedLogIndexListener.
    
    指定者:
    
    addLastAppliedLogIndexListener 在接口中 FSMCaller
  - onCommitted
```
public boolean onCommitted(long committedIndex)
```
    从接口复制的说明: FSMCaller
    
    Called when log entry committed
    
    指定者:
    
    onCommitted 在接口中 FSMCaller
    
    参数:
    
    committedIndex - committed log index
  - onSnapshotLoad
```
public boolean onSnapshotLoad(LoadSnapshotClosure done)
```
    从接口复制的说明: FSMCaller
    
    Called after loading snapshot.
    
    指定者:
    
    onSnapshotLoad 在接口中 FSMCaller
    
    参数:
    
    done - callback
  - onSnapshotSave
```
public boolean onSnapshotSave(SaveSnapshotClosure done)
```
    从接口复制的说明: FSMCaller
    
    Called after saving snapshot.
    
    指定者:
    
    onSnapshotSave 在接口中 FSMCaller
    
    参数:
    
    done - callback
  - onLeaderStop
```
public boolean onLeaderStop(Status status)
```
    从接口复制的说明: FSMCaller
    
    Called when the leader stops.
    
    指定者:
    
    onLeaderStop 在接口中 FSMCaller
    
    参数:
    
    status - status info
  - onLeaderStart
```
public boolean onLeaderStart(long term)
```
    从接口复制的说明: FSMCaller
    
    Called when the leader starts.
    
    指定者:
    
    onLeaderStart 在接口中 FSMCaller
    
    参数:
    
    term - current term
  - onStartFollowing
```
public boolean onStartFollowing(LeaderChangeContext ctx)
```
    从接口复制的说明: FSMCaller
    
    Called when start following a leader.
    
    指定者:
    
    onStartFollowing 在接口中 FSMCaller
    
    参数:
    
    ctx - context of leader change
  - onStopFollowing
```
public boolean onStopFollowing(LeaderChangeContext ctx)
```
    从接口复制的说明: FSMCaller
    
    Called when stop following a leader.
    
    指定者:
    
    onStopFollowing 在接口中 FSMCaller
    
    参数:
    
    ctx - context of leader change
  - onError
```
public boolean onError(RaftException error)
```
    从接口复制的说明: FSMCaller
    
    Called when error happens.
    
    指定者:
    
    onError 在接口中 FSMCaller
    
    参数:
    
    error - error info
  - getLastAppliedIndex
```
public long getLastAppliedIndex()
```
    从接口复制的说明: FSMCaller
    
    Returns the last log entry index to apply state machine.
    
    指定者:
    
    getLastAppliedIndex 在接口中 FSMCaller
  - join
```
public void join()
          throws InterruptedException
```
    从接口复制的说明: FSMCaller
    
    Called after shutdown to wait it terminates.
    
    指定者:
    
    join 在接口中 FSMCaller
    
    抛出:
    
    InterruptedException - if the current thread is interrupted while waiting
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - describe
```
public void describe(Describer.Printer out)
```
    指定者:
    
    describe 在接口中 Describer

类 FSMCallerImpl

嵌套类概要

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

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

构造器概要

方法概要

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

构造器详细资料

FSMCallerImpl

方法详细资料

init

shutdown

addLastAppliedLogIndexListener

onCommitted

onSnapshotLoad

onSnapshotSave

onLeaderStop

onLeaderStart

onStartFollowing

onStopFollowing

onError

getLastAppliedIndex

join

toString

describe