raft

package module

Go to main page

Versions in this module

v0

v0.1.9

Feb 4, 2024

v0.1.8

Jan 31, 2024

Changes in this version

type Option

+ func WithLogLevel(level logging.Level) Option

v0.1.7

Jan 29, 2024

v0.1.6

Jan 19, 2024

Changes in this version

+ var ErrInvalidLease = errors.New("this node does not have a valid lease")

+ var ErrNoCommitThisTerm = errors.New("a log entry has not been committed in this term")

+ var ErrNotLeader = errors.New("this node is not the leader")

+ var ErrPendingConfiguration = errors.New("only one membership change may be committed at a time")

+ var ErrTimeout = errors.New(...)

+ type Configuration struct

+ Index uint64

+ IsVoter map[string]bool

+ Members map[string]string

+ func NewConfiguration(index uint64, members map[string]string) *Configuration

+ func (c *Configuration) Clone() Configuration

+ func (c *Configuration) String() string

+ type Future interface

+ Await func() Result[T]

type InstallSnapshotRequest

+ Configuration []byte

+ Done bool

+ Offset int64

type InstallSnapshotResponse

+ BytesWritten int64

type Log

+ Size func() int

type LogEntryType

+ const ConfigurationEntry

type OperationResponse

+ ApplicationResponse interface{}

type Option

+ func WithLog(log Log) Option

+ func WithSnapshotStorage(snapshotStorage SnapshotStorage) Option

+ func WithStateStorage(stateStorage StateStorage) Option

+ func WithTransport(transport Transport) Option

type Raft

+ func (r *Raft) AddServer(id string, address string, isVoter bool, timeout time.Duration) Future[Configuration]

+ func (r *Raft) Bootstrap(configuration map[string]string) error

+ func (r *Raft) Configuration() Configuration

+ func (r *Raft) RemoveServer(id string, timeout time.Duration) Future[Configuration]

+ func (r *Raft) Restart() error

type RequestVoteRequest

+ Prevote bool

+ type Response interface

+ type Result interface

+ Error func() error

+ Success func() T

+ type SnapshotFile interface

+ Discard func() error

+ Metadata func() SnapshotMetadata

+ type SnapshotMetadata struct

+ Configuration []byte

+ LastIncludedIndex uint64

+ LastIncludedTerm uint64

type SnapshotStorage

+ NewSnapshotFile func(lastIncludedIndex uint64, lastIncludedTerm uint64, configuration []byte) (SnapshotFile, error)

+ SnapshotFile func() (SnapshotFile, error)

type State

+ const Candidate

+ const PreCandidate

+ type Transport interface

+ Address func() string

+ Close func(address string) error

+ CloseAll func()

+ Connect func(address string) error

+ DecodeConfiguration func(data []byte) (Configuration, error)

+ EncodeConfiguration func(configuration *Configuration) ([]byte, error)

+ RegisterAppendEntriesHandler func(handler func(*AppendEntriesRequest, *AppendEntriesResponse) error)

+ RegisterRequestVoteHandler func(handler func(*RequestVoteRequest, *RequestVoteResponse) error)

+ RegsiterInstallSnapshotHandler func(handler func(*InstallSnapshotRequest, *InstallSnapshotResponse) error)

+ Run func() error

+ SendAppendEntries func(address string, request AppendEntriesRequest) (AppendEntriesResponse, error)

+ SendInstallSnapshot func(address string, request InstallSnapshotRequest) (InstallSnapshotResponse, error)

+ SendRequestVote func(address string, request RequestVoteRequest) (RequestVoteResponse, error)

+ Shutdown func() error

+ func NewTransport(address string) (Transport, error)

v0.1.5

Dec 25, 2023

Changes in this version

+ type InvalidOperationTypeError struct

+ OperationType OperationType

+ func (e InvalidOperationTypeError) Error() string

type Log

+ SizeInBytes func() (int64, error)

type LogEntry

+ EntryType LogEntryType

+ type LogEntryType uint32

+ const NoOpEntry

+ const OperationEntry

type Operation

+ OperationType OperationType

type OperationResponse

+ Err error

+ type OperationResponseFuture struct

+ func NewOperationResponseFuture(operation []byte, timeout time.Duration) *OperationResponseFuture

+ func (o *OperationResponseFuture) Await() OperationResponse

+ type OperationTimeoutError struct

+ Operation []byte

+ func (e OperationTimeoutError) Error() string

+ type OperationType uint32

+ const LeaseBasedReadOnly

+ const LinearizableReadOnly

+ const Replicated

+ func (o OperationType) String() string

+ type PersistentStorage interface

+ Close func() error

+ Open func() error

+ Replay func() error

+ type StateStorage interface

+ SetState func(term uint64, vote string) error

+ State func() (uint64, string, error)

+ func NewStateStorage(path string) StateStorage

v0.1.4

Aug 8, 2023

Changes in this version

type Log

+ func NewLog(path string) Log

type Peer

+ func NewPeer(id string, address net.Addr) Peer

+ Address func() net.Addr

+ type Protocol interface

+ AppendEntries func(request *AppendEntriesRequest, response *AppendEntriesResponse) error

+ InstallSnapshot func(request *InstallSnapshotRequest, response *InstallSnapshotResponse) error

+ ListSnapshots func() []Snapshot

+ RequestVote func(request *RequestVoteRequest, response *RequestVoteResponse) error

+ Start func() error

+ Status func() Status

+ Stop func() error

+ SubmitOperation func(operation []byte) (uint64, uint64, error)

+ SubmitReadOnlyOperation func(operation []byte) error

type SnapshotStorage

+ func NewSnapshotStorage(path string) SnapshotStorage

type Status

+ Address net.Addr

type Storage

+ func NewStorage(path string) Storage

v0.1.3

Jul 30, 2023

v0.1.2

Jul 30, 2023

Changes in this version

+ type InvalidLeaseError struct

+ ServerID string

+ func (e InvalidLeaseError) Error() string

+ type NotLeaderError struct

+ KnownLeader string

+ ServerID string

+ func (e NotLeaderError) Error() string

type Operation

+ IsReadOnly bool

+ LogIndex uint64

+ LogTerm uint64

type Option

+ func WithLeaseDuration(leaseDuration time.Duration) Option

type Raft

+ func (r *Raft) SubmitReadOnlyOperation(operation []byte) error

type Server

+ func (s *Server) SubmitReadOnlyOperation(operation []byte) error

v0.1.1

Jul 22, 2023

v0.1.0

Jul 9, 2023

retracted

Changes in this version

+ type AppendEntriesRequest struct

+ Entries []*LogEntry

+ LeaderCommit uint64

+ LeaderID string

+ PrevLogIndex uint64

+ PrevLogTerm uint64

+ Term uint64

+ type AppendEntriesResponse struct

+ Index uint64

+ Success bool

+ Term uint64

+ type InstallSnapshotRequest struct

+ Bytes []byte

+ LastIncludedIndex uint64

+ LastIncludedTerm uint64

+ LeaderID string

+ Term uint64

+ type InstallSnapshotResponse struct

+ Term uint64

+ type Log interface

+ AppendEntries func(entries []*LogEntry) error

+ AppendEntry func(entry *LogEntry) error

+ Close func() error

+ Compact func(index uint64) error

+ Contains func(index uint64) bool

+ DiscardEntries func(index uint64, term uint64) error

+ GetEntry func(index uint64) (*LogEntry, error)

+ LastIndex func() uint64

+ LastTerm func() uint64

+ NextIndex func() uint64

+ Open func() error

+ Replay func() error

+ Truncate func(index uint64) error

+ type LogEntry struct

+ Data []byte

+ Index uint64

+ Offset int64

+ Term uint64

+ func NewLogEntry(index uint64, term uint64, data []byte) *LogEntry

+ func (e *LogEntry) IsConflict(other *LogEntry) bool

+ type Logger interface

+ Debug func(args ...interface{})

+ Debugf func(format string, args ...interface{})

+ Error func(args ...interface{})

+ Errorf func(format string, args ...interface{})

+ Fatal func(args ...interface{})

+ Fatalf func(format string, args ...interface{})

+ Info func(args ...interface{})

+ Infof func(format string, args ...interface{})

+ Warn func(args ...interface{})

+ Warnf func(format string, args ...interface{})

+ type Operation struct

+ Bytes []byte

+ type OperationResponse struct

+ Index uint64

+ Operation []byte

+ Response interface{}

+ Term uint64

+ type Option func(options *options) error

+ func WithElectionTimeout(time time.Duration) Option

+ func WithHeartbeatInterval(time time.Duration) Option

+ func WithLogger(logger Logger) Option

+ func WithMaxEntriesPerRPC(maxEntriesPerRPC int) Option

+ type Peer interface

+ AppendEntries func(request AppendEntriesRequest) (AppendEntriesResponse, error)

+ Connect func() error

+ Disconnect func() error

+ ID func() string

+ InstallSnapshot func(request InstallSnapshotRequest) (InstallSnapshotResponse, error)

+ RequestVote func(request RequestVoteRequest) (RequestVoteResponse, error)

+ type PersistentState struct

+ Term uint64

+ VotedFor string

+ type Raft struct

+ func NewRaft(id string, peers map[string]Peer, log Log, storage Storage, ...) (*Raft, error)

+ func (r *Raft) AppendEntries(request *AppendEntriesRequest, response *AppendEntriesResponse) error

+ func (r *Raft) InstallSnapshot(request *InstallSnapshotRequest, response *InstallSnapshotResponse) error

+ func (r *Raft) ListSnapshots() []Snapshot

+ func (r *Raft) RequestVote(request *RequestVoteRequest, response *RequestVoteResponse) error

+ func (r *Raft) Start() error

+ func (r *Raft) Status() Status

+ func (r *Raft) Stop() error

+ func (r *Raft) SubmitOperation(operation Operation) (uint64, uint64, error)

+ type RequestVoteRequest struct

+ CandidateID string

+ LastLogIndex uint64

+ LastLogTerm uint64

+ Term uint64

+ type RequestVoteResponse struct

+ Term uint64

+ VoteGranted bool

+ type Server struct

+ func NewServer(id string, peers map[string]string, fsm StateMachine, logPath string, ...) (*Server, error)

+ func (s *Server) AppendEntries(ctx context.Context, request *pb.AppendEntriesRequest) (*pb.AppendEntriesResponse, error)

+ func (s *Server) InstallSnapshot(ctx context.Context, request *pb.InstallSnapshotRequest) (*pb.InstallSnapshotResponse, error)

+ func (s *Server) IsStarted() bool

+ func (s *Server) ListSnapshots() []Snapshot

+ func (s *Server) RequestVote(ctx context.Context, request *pb.RequestVoteRequest) (*pb.RequestVoteResponse, error)

+ func (s *Server) Start(ready <-chan interface{}) error

+ func (s *Server) Status() Status

+ func (s *Server) Stop()

+ func (s *Server) SubmitOperation(operation Operation) (uint64, uint64, error)

+ type Snapshot struct

+ Data []byte

+ LastIncludedIndex uint64

+ LastIncludedTerm uint64

+ func NewSnapshot(lastIncludedIndex uint64, lastIncludedTerm uint64, data []byte) *Snapshot

+ type SnapshotStorage interface

+ Close func() error

+ LastSnapshot func() (Snapshot, bool)

+ ListSnapshots func() []Snapshot

+ Open func() error

+ Replay func() error

+ SaveSnapshot func(snapshot *Snapshot) error

+ type State uint32

+ const Follower

+ const Leader

+ const Shutdown

+ func (s State) String() string

+ type StateMachine interface

+ Apply func(entry *LogEntry) interface{}

+ NeedSnapshot func() bool

+ Restore func(snapshot *Snapshot) error

+ Snapshot func() (Snapshot, error)

+ type Status struct

+ CommitIndex uint64

+ ID string

+ LastApplied uint64

+ State State

+ Term uint64

+ type Storage interface

+ Close func() error

+ GetState func() (PersistentState, error)

+ Open func() error

+ SetState func(persistentState *PersistentState) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL