papillon

type AppendEntriesFuture interface {
	Future[*AppendEntryResponse]
	StartAt() time.Time
	Request() *AppendEntryRequest
}

type AppendEntryPipeline interface {
	AppendEntries(*AppendEntryRequest) (AppendEntriesFuture, error)
	Consumer() <-chan AppendEntriesFuture
	Close() error
}

type AppendEntryRequest struct {
	*RPCHeader
	Term         uint64
	PrevLogIndex uint64
	PrevLogTerm  uint64
	Entries      []*LogEntry
	LeaderCommit uint64
}

type AppendEntryResponse struct {
	*RPCHeader
	Term        uint64
	Success     bool
	LatestIndex uint64 // peer 当前保存最新的日志 index ，用于新节点快速定位 nextIndex
}

type ApplyFuture interface {
	IndexFuture
	Future[nilRespFuture]
}

type BatchFSM interface {
	FSM
	BatchApply([]*LogEntry) []interface{}
}

type CacheLog struct {
	// contains filtered or unexported fields
}

type ClusterInfo struct {
	Servers []ServerInfo
}

type Config struct {
	ElectionTimeout         time.Duration
	HeartbeatTimeout        time.Duration
	LeaderLeaseTimeout      time.Duration
	ApplyBatch              bool
	MaxAppendEntries        uint64
	CommitTimeout           time.Duration
	SnapshotInterval        time.Duration
	SnapshotThreshold       uint64
	TrailingLogs            uint64
	Logger                  Logger
	LocalID                 string
	LeadershipCatchUpRounds uint
	LeadershipLostShutDown  bool
	Debug                   bool // 开启后使用 expvar 包导出 raft 状态信息，可以使用 /debug/vars 路由进行访问
}

type ConfigurationStorage interface {
	KVStorage
	SetConfiguration(index uint64, configuration ClusterInfo) error
}

type DataBus struct {
	// contains filtered or unexported fields
}

type DefaultPackageParser struct{}

type FSM interface {
	Apply(*LogEntry) interface{}
	ReStore(reader io.ReadCloser) error // 从快照恢复，需要自行实现觅等
	Snapshot() (FsmSnapshot, error)
}

type FastTimeoutRequest struct {
	*RPCHeader
	Term               uint64
	LeaderShipTransfer bool
}

type FastTimeoutResponse struct {
	*RPCHeader
	Success bool
}

type FileSnapshot struct {
	// contains filtered or unexported fields
}

type FileSnapshotSink struct {
	// contains filtered or unexported fields
}

type FileWithSync interface {
	fs.File
	Sync() error
}

type FsmSnapshot interface {
	Persist(sink SnapshotSink) error
	Release()
}

type Future[T any] interface {
	Response() (T, error)
}

type IndexFuture interface {
	Index() uint64
	// contains filtered or unexported methods
}

type InstallSnapshotRequest struct {
	*RPCHeader
	SnapshotMeta *SnapshotMeta
	Term         uint64
}

type InstallSnapshotResponse struct {
	*RPCHeader
	Term    uint64
	Success bool
}

type JsonRpcHandler struct{}

type KVStorage interface {
	// Get 用于存储日志
	Get(key []byte) (val []byte, err error)
	// Set 用于存储日志
	Set(key, val []byte) error

	// SetUint64 用于存储任期
	SetUint64(key []byte, val uint64) error
	// GetUint64 用于返回任期
	GetUint64(key []byte) (uint64, error)
}

type KvSchema [2]string

type LogEntry struct {
	Index     uint64    // 日志的日志索引
	Term      uint64    // 创建日志时的任期
	Data      []byte    // 日志内容
	Type      LogType   // 日志类型
	CreatedAt time.Time // 创建时间
}

type LogFuture struct {
	// contains filtered or unexported fields
}

type LogStore interface {
	// FirstIndex 返回第一个写入的索引，-1 代表没有
	FirstIndex() (uint64, error)
	// LastIndex 返回最后一个写入的索引，-1 代表没有
	LastIndex() (uint64, error)
	// GetLog 返回指定位置的索引
	GetLog(index uint64) (log *LogEntry, err error)
	// GetLogRange 按指定范围遍历索引，闭区间
	GetLogRange(from, to uint64) (log []*LogEntry, err error)
	// SetLogs 追加日志
	SetLogs(logs []*LogEntry) error
	// DeleteRange 批量删除指定范围的索引内容，用于快照生成
	DeleteRange(from, to uint64) error
}

type LogType uint8 // 日志类型

type Logger interface {
	Infof(format string, v ...any)
	Info(v ...any)
	Errorf(format string, v ...any)
	Error(v ...any)
	Warnf(format string, v ...any)
	Warn(v ...any)
	Debugf(format string, v ...any)
	Debug(v ...any)
}

type MemoryStore struct {
	// contains filtered or unexported fields
}

type NetLayer interface {
	net.Listener
	// Dial is used to create a new outgoing connection
	Dial(peer ServerAddr, timeout time.Duration) (net.Conn, error)
}

type NetTransport struct {
	TimeoutScale int64
	// contains filtered or unexported fields
}

type NetWorkTransportConfig struct {
	ServerAddressProvider ServerAddrProvider

	Logger Logger

	NetLayer NetLayer

	MaxPool int

	Timeout time.Duration
}

type OpenSnapshot = func() (*SnapshotMeta, io.ReadCloser, error)

type PackageParser interface {
	Encode(writer *bufio.Writer, rpcType rpcType, data []byte) (err error)
	Decode(reader *bufio.Reader) (rpcType, []byte, error)
}

type Processor interface {
	Do(rpcType, interface{}, io.Reader) (interface{}, error)
	SetFastPath(cb fastPath)
}

type ProcessorProxy struct {
	Processor
}

type RPC struct {
	RpcType  rpcType
	Request  any
	Response chan any
	Reader   io.Reader // 链接读接口，安装快照的时候用
}

type RPCHeader struct {
	ID   ServerID
	Addr ServerAddr
}

type Raft struct {
	// contains filtered or unexported fields
}

type ReloadableConfig struct {
	TrailingLogs      uint64
	SnapshotInterval  time.Duration
	SnapshotThreshold uint64
	HeartbeatTimeout  time.Duration
	ElectionTimeout   time.Duration
}

type RpcConvert interface {
	Deserialization(data []byte, i interface{}) error
	Serialization(i interface{}) (bytes []byte, err error)
}

type RpcInterface interface {
	// Consumer 返回一个可消费的 Chan
	Consumer() <-chan *RPC
	// VoteRequest 发起投票请求
	VoteRequest(*ServerInfo, *VoteRequest) (*VoteResponse, error)
	// AppendEntries 追加日志
	AppendEntries(*ServerInfo, *AppendEntryRequest) (*AppendEntryResponse, error)
	// AppendEntryPipeline 以 pipe 形式追加日志
	AppendEntryPipeline(*ServerInfo) (AppendEntryPipeline, error)
	// InstallSnapShot 安装快照
	InstallSnapShot(*ServerInfo, *InstallSnapshotRequest, io.Reader) (*InstallSnapshotResponse, error)
	// SetHeartbeatFastPath 用于快速处理，不用经过主流程，不支持也没关系
	SetHeartbeatFastPath(cb fastPath)
	// FastTimeout 快速超时转换为候选人
	FastTimeout(*ServerInfo, *FastTimeoutRequest) (*FastTimeoutResponse, error)

	LocalAddr() ServerAddr
	EncodeAddr(info *ServerInfo) []byte
	DecodeAddr([]byte) ServerAddr
}

type ServerAddr string

type ServerAddrProvider interface {
	GetAddr(id ServerID) (ServerAddr, error)
}

type ServerID string

type ServerInfo struct {
	Suffrage Suffrage
	Addr     ServerAddr
	ID       ServerID
}

type ServerProcessor struct {
	// contains filtered or unexported fields
}

type SnapShotFutureResp struct {
	// contains filtered or unexported fields
}

type SnapshotMeta struct {
	Version            SnapshotVersion
	ID                 string
	Index              uint64
	Term               uint64
	Configuration      ClusterInfo
	ConfigurationIndex uint64
	Size               int64
}

type SnapshotSink interface {
	io.WriteCloser
	ID() string
	Cancel() error
}

type SnapshotStore interface {
	Open(id string) (*SnapshotMeta, io.ReadCloser, error)
	List() ([]*SnapshotMeta, error)
	Create(version SnapshotVersion, index, term uint64, configuration ClusterInfo, configurationIndex uint64, rpc RpcInterface) (SnapshotSink, error)
}

type SnapshotVersion uint64

type State uint64

type StateChange struct {
	Before, After State
}

type Suffrage int // 是否有选举权，枚举： Voter NonVoter

type TcpLayer struct {
	// contains filtered or unexported fields
}

type VoteRequest struct {
	*RPCHeader
	Term           uint64
	CandidateID    ServerID
	LastLogIndex   uint64
	LastLogTerm    uint64
	LeaderTransfer bool
}

type VoteResponse struct {
	*RPCHeader
	Term    uint64
	Granted bool
}

type WithPeers interface {
	Connect(addr ServerAddr, rpc RpcInterface)
	Disconnect(addr ServerAddr)
	DisconnectAll()
}