forcemaster

Documentation

Index

• type Election
  • func NewElection(id string) *Election
  • func (ne *Election) Await(ctx context.Context) error
  • func (ne *Election) Close(ctx context.Context) error
  • func (ne *Election) Resign(ctx context.Context) error
  • func (ne *Election) WithMastership(ctx context.Context) (context.Context, error)
• type Factory
  • func (nf Factory) NewElection(ctx context.Context, resourceID string) (election2.Election, error)

Types

type Election

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

Election is a stub Election that always believes to be the master.

func NewElection

func NewElection(id string) *Election

func (*Election) Await

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

Await returns immediately, as the instance is always the master.

func (*Election) Close

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

Close does nothing because Election is always the master.

func (*Election) Resign

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

Resign cancels the contexts obtained through WithMastership.

func (*Election) WithMastership

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

WithMastership returns a cancelable context derived from the passed in context.

type Factory

type Factory struct{}

Factory creates Election instances.

func (Factory) NewElection

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

NewElection creates a specific Election instance.