raft

Documentation

Index

• type Protocol
  • func NewProtocol(config *config.ProtocolConfig) *Protocol
  • func (p *Protocol) Client() node.Client
  • func (p *Protocol) Start(cluster cluster.Cluster, registry *node.Registry) error
  • func (p *Protocol) Stop() error
• type Server
  • func NewServer(clusterConfig cluster.Cluster, registry *node.Registry, ...) *Server
  • func (s *Server) Start() error
  • func (s *Server) Stop() error
  • func (s *Server) WaitForReady() error

Types

type Protocol

type Protocol struct {
	node.Protocol
	// contains filtered or unexported fields
}

Protocol is an implementation of the Client interface providing the Raft consensus protocol

func NewProtocol

func NewProtocol(config *config.ProtocolConfig) *Protocol

NewProtocol returns a new Raft Protocol instance

func (*Protocol) Client

func (p *Protocol) Client() node.Client

Client returns the Raft protocol client

func (*Protocol) Start

func (p *Protocol) Start(cluster cluster.Cluster, registry *node.Registry) error

Start starts the Raft protocol

func (*Protocol) Stop

func (p *Protocol) Stop() error

Stop stops the Raft protocol

type Server

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

Server implements the Raft consensus protocol server

func NewServer

func NewServer(clusterConfig cluster.Cluster, registry *node.Registry, protocolConfig *config.ProtocolConfig) *Server

NewServer returns a new Raft consensus protocol server

func (*Server) Start

func (s *Server) Start() error

Start starts the Raft server

func (*Server) Stop

func (s *Server) Stop() error

Stop shuts down the Raft server

func (*Server) WaitForReady

func (s *Server) WaitForReady() error

WaitForReady blocks the current goroutine until the server is ready