leader

Documentation

Overview

Package leader implements leader election between cored processes of a Chain Core.

Index

• func Address(ctx context.Context) (string, error)
• func IsLeading() bool
• func Run(db *sql.DB, addr string, lead func(context.Context))

Functions

func Address

func Address(ctx context.Context) (string, error)

Address retrieves the IP address of the current core leader.

func IsLeading

func IsLeading() bool

IsLeading returns true if this process is the core leader.

func Run

func Run(db *sql.DB, addr string, lead func(context.Context))

Run runs as a goroutine, trying once every five seconds to become the leader for the core. If it succeeds, then it calls the function lead (for generating or fetching blocks, and for expiring reservations) and enters a leadership-keepalive loop.

Function lead is called when the local process becomes the leader. Its context is canceled when the process is deposed as leader.

The Chain Core has up to a 10-second refractory period after shutdown, during which no process can become the new leader.