raft

Documentation

Index

• Constants
• type IndexedEntry
• type Indexes
  • func NewIndexesMap(clients []rpc.Client, log *Log) *Indexes
  • func (ni *Indexes) DecrementIndex(clientId int32) bool
  • func (ni *Indexes) Reset(clients []rpc.Client, log *Log)
  • func (ni *Indexes) SetIndex(clientId int32, i int32)
• type Log
  • func NewLog() *Log
  • func (l *Log) AppendEntries(entries []*schema.Entry)
  • func (l *Log) EntryByIndex(i int32) *IndexedEntry
  • func (l *Log) EntryByIndexDecomposed(i int32) (int32, int32)
  • func (l *Log) GetCommitIndex() int32
  • func (l *Log) GetEntriesFrom(i int32) []*schema.Entry
  • func (l *Log) GetLastApplied() int32
  • func (l *Log) IsCandidatesLogAtLeastAsUpToDateAsCurrent(lastLogTerm, lastLogIndex int32) bool
  • func (l *Log) IsEmpty() bool
  • func (l *Log) LastEntry() *IndexedEntry
  • func (l *Log) LastEntryDecomposed() (int32, int32)
  • func (l *Log) Len() int32
  • func (l *Log) SaveNewEntries(in schema.AppendEntriesInput)
  • func (l *Log) SetCommitIndex(i int32)
• type Logger
  • func NewLogger() *Logger
  • func (logger *Logger) Log(prefix string, v ...interface{})
• type Raft
  • func New(config env.Node, nodesAddresses []env.Node, clusterSize int) Raft
• type S
  • func (s S) String() string
• type State
  • func NewState() *State
  • func (s *State) GetState() S
  • func (s *State) GetTerm() int32
  • func (s *State) GetVote() int32
  • func (s *State) IncrementTerm()
  • func (s *State) SetState(newState S)
  • func (s *State) SetTerm(new int32)
  • func (s *State) SetVote(candidateId int32)
  • func (s *State) VotedInThisTerm() bool

Constants

const (
	PrefixHeartbeat      = "[HEARTBEAT] "
	PrefixStateChanged   = "[STATE CHANGED] "
	PrefixTermChanged    = "[TERM CHANGED] "
	PrefixElection       = "[ELECTION] "
	PrefixElectionResult = "[ELECTION RESULT] "
	PrefixElectionStop   = "[ELECTION STOPPED] "
	PrefixInfo           = "[INFO] "
	PrefixError          = "[ERROR] "
	PrefixAppendEntries  = "[APPEND ENTRIES] "
	PrefixRequestVote    = "[REQUEST VOTE] "
)

const (
	Follower = S(iota)
	Candidate
	Leader
)

Types

type IndexedEntry

type IndexedEntry struct {
	Index int32
	*schema.Entry
}

type Indexes

type Indexes struct {
	sync.Map
	sync.Mutex
}

func NewIndexesMap

func NewIndexesMap(clients []rpc.Client, log *Log) *Indexes

func (*Indexes) DecrementIndex

func (ni *Indexes) DecrementIndex(clientId int32) bool

func (*Indexes) Reset

func (ni *Indexes) Reset(clients []rpc.Client, log *Log)

func (*Indexes) SetIndex

func (ni *Indexes) SetIndex(clientId int32, i int32)

type Log

type Log struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func NewLog

func NewLog() *Log

func (*Log) AppendEntries

func (l *Log) AppendEntries(entries []*schema.Entry)

func (*Log) EntryByIndex

func (l *Log) EntryByIndex(i int32) *IndexedEntry

func (*Log) EntryByIndexDecomposed

func (l *Log) EntryByIndexDecomposed(i int32) (int32, int32)

func (*Log) GetCommitIndex

func (l *Log) GetCommitIndex() int32

func (*Log) GetEntriesFrom

func (l *Log) GetEntriesFrom(i int32) []*schema.Entry

func (*Log) GetLastApplied

func (l *Log) GetLastApplied() int32

func (*Log) IsCandidatesLogAtLeastAsUpToDateAsCurrent

func (l *Log) IsCandidatesLogAtLeastAsUpToDateAsCurrent(lastLogTerm, lastLogIndex int32) bool

func (*Log) IsEmpty

func (l *Log) IsEmpty() bool

func (*Log) LastEntry

func (l *Log) LastEntry() *IndexedEntry

func (*Log) LastEntryDecomposed

func (l *Log) LastEntryDecomposed() (int32, int32)

func (*Log) Len

func (l *Log) Len() int32

func (*Log) SaveNewEntries

func (l *Log) SaveNewEntries(in schema.AppendEntriesInput)

func (*Log) SetCommitIndex

func (l *Log) SetCommitIndex(i int32)

type Logger

type Logger struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func NewLogger

func NewLogger() *Logger

func (*Logger) Log

func (logger *Logger) Log(prefix string, v ...interface{})

type Raft

type Raft interface {
	Start(ctx context.Context)
	Stop()
	Stats() map[string]string
	GetState() *State
}

func New

func New(config env.Node, nodesAddresses []env.Node, clusterSize int) Raft

type S

type S int32

func (S) String

func (s S) String() string

type State

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

func NewState

func NewState() *State

func (*State) GetState

func (s *State) GetState() S

func (*State) GetTerm

func (s *State) GetTerm() int32

func (*State) GetVote

func (s *State) GetVote() int32

func (*State) IncrementTerm

func (s *State) IncrementTerm()

func (*State) SetState

func (s *State) SetState(newState S)

func (*State) SetTerm

func (s *State) SetTerm(new int32)

func (*State) SetVote

func (s *State) SetVote(candidateId int32)

func (*State) VotedInThisTerm

func (s *State) VotedInThisTerm() bool