Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

raft

package

Go to main page

Versions in this module

v1

v1.1.0-rc.1

Mar 31, 2026

v1.0.0

Mar 12, 2026

Changes in this version

+ var ErrLeadershipLost = fmt.Errorf("leader lock lost")

+ type Config struct

+ Bootstrap bool

+ HeartbeatTimeout time.Duration

+ LeaderLeaseTimeout time.Duration

+ NodeID string

+ Peers []string

+ RaftAddr string

+ RaftDir string

+ SendTimeout time.Duration

+ SnapCount uint64

+ type DynamicLeaderElection struct

+ func NewDynamicLeaderElection(logger zerolog.Logger, leaderFactory func() (Runnable, error), ...) *DynamicLeaderElection

+ func (d *DynamicLeaderElection) IsRunning() bool

+ func (d *DynamicLeaderElection) Run(ctx context.Context) error

+ type FSM struct

+ func (f *FSM) Apply(log *raft.Log) any

+ func (f *FSM) Restore(rc io.ReadCloser) error

+ func (f *FSM) Snapshot() (raft.FSMSnapshot, error)

+ type Node struct

+ func NewNode(cfg *Config, logger zerolog.Logger) (*Node, error)

+ func (n *Node) AddPeer(nodeID, addr string) error

+ func (n *Node) Broadcast(ctx context.Context, state *RaftBlockState) error

+ func (n *Node) Config() Config

+ func (n *Node) GetState() *RaftBlockState

+ func (n *Node) HasQuorum() bool

+ func (n *Node) IsLeader() bool

+ func (n *Node) NodeID() string

+ func (n *Node) RemovePeer(nodeID string) error

+ func (n *Node) SetApplyCallback(ch chan<- RaftApplyMsg)

+ func (n *Node) Shutdown() error

+ func (n *Node) Start(_ context.Context) error

+ func (n *Node) Stop() error

+ type RaftApplyMsg struct

+ Index uint64

+ State *RaftBlockState

+ type RaftBlockState = pb.RaftBlockState

+ type Runnable interface

+ IsSynced func(*RaftBlockState) (int, error)

+ Recover func(ctx context.Context, state *RaftBlockState) error

+ Run func(ctx context.Context) error

v1.0.0-rc.5

Mar 9, 2026

v1.0.0-rc.4

Feb 10, 2026

v1.0.0-rc.3

Feb 5, 2026

v1.0.0-rc.2

Feb 2, 2026

v1.0.0-rc.1

Jan 28, 2026