election

Documentation

Index

• Constants
• type ElectionConfig
• type LeaderElectionAdapter
  • func NewAdapter(gossip gossip, pkiid common.PKIidType, channel common.ChannelID, ...) LeaderElectionAdapter
• type LeaderElectionService
  • func NewLeaderElectionService(adapter LeaderElectionAdapter, id string, callback leadershipCallback, ...) LeaderElectionService
• type Msg
• type Peer

Constants

const (
	DefStartupGracePeriod       = time.Second * 15
	DefMembershipSampleInterval = time.Second
	DefLeaderAliveThreshold     = time.Second * 10
	DefLeaderElectionDuration   = time.Second * 5
)

Types

type ElectionConfig

type ElectionConfig struct {
	StartupGracePeriod       time.Duration
	MembershipSampleInterval time.Duration
	LeaderAliveThreshold     time.Duration
	LeaderElectionDuration   time.Duration
}

type LeaderElectionAdapter

type LeaderElectionAdapter interface {
	Gossip(Msg)

	Accept() <-chan Msg

	CreateMessage(isDeclaration bool) Msg

	Peers() []Peer

	ReportMetrics(isLeader bool)
}

func NewAdapter

func NewAdapter(gossip gossip, pkiid common.PKIidType, channel common.ChannelID,
	metrics *metrics.ElectionMetrics) LeaderElectionAdapter

type LeaderElectionService

type LeaderElectionService interface {
	IsLeader() bool

	Stop()

	Yield()
}

func NewLeaderElectionService

func NewLeaderElectionService(adapter LeaderElectionAdapter, id string, callback leadershipCallback, config ElectionConfig) LeaderElectionService

type Msg

type Msg interface {
	SenderID() peerID

	IsProposal() bool

	IsDeclaration() bool
}

type Peer

type Peer interface {
	ID() peerID
}