raft

type Addresses interface {
	Local() (local string, err error)
	Members() (addresses []string, err error)
}

type AppendEntriesRequest struct {
	RPCHeader
	Term              uint64
	PrevLogEntry      uint64
	PrevLogTerm       uint64
	LeaderCommitIndex uint64
	Key               []byte
	Entries           []*Log
}

type AppendEntriesResponse struct {
	RPCHeader
	Term           uint64
	LastLog        uint64
	Succeed        bool
	NoRetryBackoff bool
}

type ClusterRequest struct {
	RPCHeader
	Command  []byte
	Argument []byte
}

type ClusterResponse struct {
	RPCHeader
	Result []byte
	Error  []byte
}

type Configuration struct {
	Servers []Server
}

type FSM interface {
	Apply(data []byte) (result []byte, err error)
	Read(command []byte, argument []byte) (result []byte, err error)
	Snapshot() (FSMSnapshot, error)
	Restore(snapshot io.ReadCloser) error
	Close() (err error)
}

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

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

type FsmReadRequest struct {
	RPCHeader
	Command  []byte
	Argument []byte
}

type FsmReadResponse struct {
	RPCHeader
	Result []byte
	Error  []byte
}

type Future[R any] interface {
	Wait(ctx context.Context) (result R, err error)
}

type Handler struct {
}

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

type HeartbeatPayload struct {
	PrevLogEntry      uint64
	PrevLogTerm       uint64
	LeaderCommitIndex uint64
}

type HeartbeatRequest struct {
	RPCHeader
	Term uint64
	Key  []byte
	// contains filtered or unexported fields
}

type HeartbeatResponse struct {
	RPCHeader
}

type InstallSnapshotRequest struct {
	RPCHeader
	Term               uint64
	LastLogIndex       uint64
	LastLogTerm        uint64
	ConfigurationIndex uint64
	Size               uint64
	Leader             []byte
	Configuration      []byte
	Snapshot           io.Reader
}

type InstallSnapshotResponse struct {
	RPCHeader
	Term    uint64
	Succeed bool
}

type LeaderOptions struct {
	HeartbeatTimeout time.Duration
	ElectionTimeout  time.Duration
	CommitTimeout    time.Duration
	// LeaseTimeout
	// 用于控制“租约”的持续时间
	// 作为领导者而无法联系法定人数
	// 个节点。如果我们在没有联系的情况下达到这个间隔，我们将
	// 辞去领导职务。
	LeaseTimeout time.Duration
}

type Log struct {
	Index      uint64
	Term       uint64
	Type       LogType
	Data       []byte
	Extensions []byte
	AppendedAt time.Time
	Committed  bool
}

type LogMeta interface {
	Term() (term uint64, err error)
	SetTerm(term uint64) (err error)
	Set(key []byte, val []byte) (err error)
	Get(key []byte) (val []byte, err error)
}

type LogType uint8

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

type MessageReader interface {
	ReadFrom(r io.Reader) (n int64, err error)
	RequestType() (typ MessageRequestType)
	Bytes() (p []byte)
	Trunk() (trunk *Trunk, has bool)
}

type MessageRequestType uint16

type MessageWriter interface {
	WriteTo(w io.Writer) (n int64, err error)
}

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

type Options struct {
	Id        string
	Addresses Addresses
	Nonvoter  bool
	TLS       TLS
	Leader    LeaderOptions
	Snapshot  SnapshotOptions
	Store     Store
	FSM       FSM
	Transport Transport
}

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

type Promise[R any] struct {
	// contains filtered or unexported fields
}

type RPC interface {
	Encode() (writer MessageWriter, err error)
	Decode(msg MessageReader) (err error)
}

type RPCHeader struct {
	// Id is the ServerId of the node sending the RPC Request or Response
	Id []byte
	// Addr is the ServerAddr of the node sending the RPC Request or Response
	Addr []byte
}

type Raft interface {
	// Run start node
	//
	// check cluster was serving, when serving, then call leader to add this node,
	// when not serving, then boot a cluster.
	Run(ctx context.Context) (err error)
	// Close shutdown node
	//
	// check leader, when this node is leader, then just shutdown,
	// when this nod is not leader, then call leader to remove this node and shutdown.
	Close(ctx context.Context) (err error)
	// Apply make fsm to apply a log
	Apply(ctx context.Context, key []byte, body []byte, timeout time.Duration) (result []byte, err error)
}

type Server struct {
	Suffrage ServerSuffrage
	Id       string
	Address  string
}

type ServerSuffrage int

type SnapshotMeta struct {
	Id                 string
	Index              uint64
	Term               uint64
	Configuration      Configuration
	ConfigurationIndex uint64
	Size               uint64
	CRC                []byte
	CreateAT           time.Time
}

type SnapshotMetas []*SnapshotMeta

type SnapshotOptions struct {
	Store SnapshotStore
	// TrailingLogs控制快照后留下的日志数量。这是为了让我们可以快速回放跟踪者的日志，而不是被迫发送整个快照。此处传递的值是使用的初始设置。这可以在运行期间使用ReloadConfig进行调整。
	TrailingLogs uint64
	// SnapshotThreshold控制在执行快照之前必须有多少未完成的日志。这是为了通过重放一小组日志来防止过度快照。此处传递的值是使用的初始设置。这可以在运行期间使用ReloadConfig进行调整。
	Threshold                uint64
	Interval                 time.Duration
	NoSnapshotRestoreOnStart bool
}

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

type SnapshotStore interface {
	Create(index uint64, term uint64, configuration Configuration, configurationIndex uint64) (sink SnapshotSink, err error)
	List() (metas []*SnapshotMeta, err error)
	Open(id string) (meta *SnapshotMeta, reader io.ReadCloser, err error)
}

type State uint32

type Store interface {
	AcquireIndex() (term uint64, index uint64, err error)
	Meta() (meta LogMeta)
	FirstIndex() (index uint64, err error)
	LastIndex() (index uint64, err error)
	Read(index uint64) (log *Log, err error)
	Write(logs ...*Log) (err error)
	Commit(logs ...*Log) (err error)
	Remove(logs ...*Log) (err error)
	Close()
}

type TLS interface {
	Config() (server *tls.Config, client *tls.Config, err error)
}

type TimeoutNowRequest struct {
	RPCHeader
}

type TimeoutNowResponse struct {
	RPCHeader
}

type Transport interface {
	Dial(address string) (conn net.Conn, err error)
	Listen(address string) (ln net.Listener, err error)
}

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

type VoteRequest struct {
	RPCHeader
	Term               uint64
	LastLogIndex       uint64
	LastLogTerm        uint64
	LeadershipTransfer bool
}

type VoteResponse struct {
	RPCHeader
	Term    uint64
	Granted bool
}