election

package

v0.1.2 Latest Latest Go to latest Published: Jan 11, 2023 License: Apache-2.0 Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/choria-io/asyncjobs

Links

Open Source Insights

Documentation ¶

Index ¶

type Backoff
type Election
- func NewElection(name string, key string, bucket nats.KeyValue, opts ...Option) (Election, error)
type Option
type State
- func (s State) String() string

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Backoff ¶

type Backoff interface {
	// Duration returns the time to sleep for the nth invocation
	Duration(n int) time.Duration
}

Backoff controls the interval of campaigns

type Election ¶

type Election interface {
	Start(ctx context.Context) error
	Stop()
}

Election manages leader elections

func NewElection ¶

func NewElection(name string, key string, bucket nats.KeyValue, opts ...Option) (Election, error)

type Option ¶

type Option func(o *options)

Option configures the election system

func OnCampaign ¶

func OnCampaign(cb func(s State)) Option

OnCampaign is called each time a campaign is done by the leader or a candidate

func OnLost ¶

func OnLost(cb func()) Option

OnLost is a callback called when losing an election

func OnWon ¶

func OnWon(cb func()) Option

OnWon is a callback called when winning an election

func WithBackoff ¶

func WithBackoff(bo Backoff) Option

WithBackoff will use the provided Backoff timer source to decrease campaign intervals over time

func WithDebug ¶

func WithDebug(cb func(format string, a ...any)) Option

WithDebug sets a function to do debug logging with

type State ¶

type State uint

State indicates the current state of the election

const (
	// UnknownState indicates the state is unknown, like when the election is not started
	UnknownState State = 0
	// CandidateState is a campaigner that is not the leader
	CandidateState State = 1
	// LeaderState is the leader
	LeaderState State = 2
)

func (State) String ¶

func (s State) String() string

Source Files ¶

View all Source files

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