etcd

package

v1.7.2 Latest Latest Go to latest Published: Apr 25, 2025 License: Apache-2.0 Imports: 11 Imported by: 11

Details

Package etcd provides an implementation of master election based on etcd.

View Source

const ElectionName = "etcd"

ElectionName identifies the etcd election implementation.

This section is empty.

This section is empty.

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

Election is an implementation of election2.Election based on etcd.

func (e *Election) Await(ctx context.Context) error

Await blocks until the instance captures mastership.

func (e *Election) Close(ctx context.Context) error

Close resigns and permanently stops participating in election. No other method should be called after Close.

func (e *Election) Resign(ctx context.Context) error

Resign releases mastership for this instance. The instance can be elected again using Await. Idempotent, might be useful to retry if fails.

func (e *Election) WithMastership(ctx context.Context) (context.Context, error)

WithMastership returns a "mastership context" which remains active until the instance stops being the master, or the passed in context is canceled.

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

Factory creates Election instances.

func (f *Factory) NewElection(ctx context.Context, resourceID string) (election2.Election, error)

NewElection creates a specific Election instance.