ReplicableStore (JoyQueue-Store-API 4.2.2 API)

```
public interface ReplicableStore
```
选举复制相关的存储接口

作者:

liyue25 Date: 2018/8/31

方法概要

所有方法实例方法抽象方法
限定符和类型	方法和说明
`long`	`appendEntryBuffer(ByteBuffer byteBuffer)` 追加写入一段日志数据，给定的ByteBuffer必须满足如下条件： 1.
`void`	`clear(long position)`
`void`	`commit(long position)` LEADER 收到半数以上回复后，调用此方法提交位置。
`long`	`commitPosition()` 当前日志提交的位置
`void`	`disable()` 将服务状态置为false
`void`	`enable()` 将服务状态置为true
`int`	`getEntryTerm(long position)` 获取指定位置的日志的任期
`long`	`leftPosition()` 当前日志最小位置
`long`	`position(long position, int offsetCount)` 计算日志相对于position的位置
`ByteBuffer`	`readEntryBuffer(long position, int length)` 读取一段日志数据，起始位置由position指定，最大长度不超过length。
`long`	`rightPosition()` 当前日志最大位置
`boolean`	`serviceStatus()` 节点服务状态
`void`	`setRightPosition(long position)` 设置Store的最大位置。
`int`	`term()` 当前任期
`void`	`term(int term)` 修改任期，新任期必须必大于现任期;

- 方法详细资料
  - serviceStatus
```
boolean serviceStatus()
```
    节点服务状态
    
    返回:
    
    true: 可读写，false：不可读写
  - enable
```
void enable()
```
    将服务状态置为true
  - disable
```
void disable()
```
    将服务状态置为false
  - setRightPosition
```
void setRightPosition(long position)
               throws IOException
```
    设置Store的最大位置。如果给定 position： 1. 在最大最小位置之间 leftPosition() <= position < rightPosition()：截断 position之后的数据。 2. 否则清空存储所有数据，将最大最小位置都置为给定的position
    
    参数:
    
    position - 给定新的最大位置
    
    抛出:
    
    IOException - 读写或删除文件异常时抛出
  - rightPosition
```
long rightPosition()
```
    当前日志最大位置
    
    返回:
    
    当前日志最大位置（不含）
  - leftPosition
```
long leftPosition()
```
    当前日志最小位置
    
    返回:
    
    当前日志最小位置（含）
  - clear
```
void clear(long position)
    throws IOException
```
    抛出:
    
    IOException
  - commitPosition
```
long commitPosition()
```
    当前日志提交的位置
  - term
```
int term()
```
    当前任期
  - term
```
void term(int term)
```
    修改任期，新任期必须必大于现任期;
  - readEntryBuffer
```
ByteBuffer readEntryBuffer(long position,
                           int length)
                    throws IOException
```
    读取一段日志数据，起始位置由position指定，最大长度不超过length。返回的数据是完整的若干条日志。这些日志具有相同的term。
    
    参数:
    
    position - 起始位置，必须是一条日志的开始位置。
    
    length - 返回数据的最大长度。
    
    返回:
    
    返回若干条日志，以ByteBuffer形式存储，Buffer的position为0，limit为返回数据的总长度。
    
    抛出:
    
    ReadException - position 不是一条日志的开始位置，或者其他读日志异常。
    
    IOException - 发生IO错误
  - appendEntryBuffer
```
long appendEntryBuffer(ByteBuffer byteBuffer)
                throws IOException,
                       TimeoutException
```
    追加写入一段日志数据，给定的ByteBuffer必须满足如下条件： 1. 连续且完整的多条日志。 2. 这些日志具有相同的term。
    
    参数:
    
    byteBuffer - 待写入的ByteBuffer，将position至limit之间的数据写入存储。写入完成后， position == limit。
    
    返回:
    
    rightPosition()
    
    抛出:
    
    IOException - 发生IO错误
    
    TimeoutException - 等待写入超时，需要重试。
  - position
```
long position(long position,
              int offsetCount)
       throws IOException
```
    计算日志相对于position的位置
    
    参数:
    
    position - 当前位置，必须是日志的起始位置
    
    offsetCount - 偏移的日志条数，可以为负数
    
    抛出:
    
    IOException
  - commit
```
void commit(long position)
```
    LEADER 收到半数以上回复后，调用此方法提交位置。 FOLLOWER
  - getEntryTerm
```
int getEntryTerm(long position)
          throws IOException
```
    获取指定位置的日志的任期
    
    参数:
    
    position - 日志起始位置
    
    抛出:
    
    ReadException - position 不是一条日志的开始位置，或者其他读日志异常。
    
    IOException - 发生IO错误

接口 ReplicableStore

方法概要

方法详细资料

serviceStatus

enable

disable

setRightPosition

rightPosition

leftPosition

clear

commitPosition

term

term

readEntryBuffer

appendEntryBuffer

position

commit

getEntryTerm