globalclockupdater

Documentation

Index

• func Manifold(config ManifoldConfig) dependency.Manifold
• func NewWorker(config Config) (worker.Worker, error)
• type Config
  • func (config Config) Validate() error
• type Logger
• type ManifoldConfig
  • func (config ManifoldConfig) Validate() error

Functions

func Manifold

func Manifold(config ManifoldConfig) dependency.Manifold

Manifold returns a dependency.Manifold that will run a global clock updater worker.

func NewWorker

func NewWorker(config Config) (worker.Worker, error)

NewWorker returns a new global clock updater worker, using the given configuration.

Types

type Config

type Config struct {
	// NewUpdater returns a new global clock updater.
	NewUpdater func() (globalclock.Updater, error)

	// LocalClock is the local wall clock. The times returned must
	// contain a monotonic component (Go 1.9+).
	LocalClock clock.Clock

	// UpdateInterval is the amount of time in between clock updates.
	UpdateInterval time.Duration

	// Logger determines where we write log messages.
	Logger Logger
}

Config contains the configuration for the global clock updater worker.

func (Config) Validate

func (config Config) Validate() error

Validate validates the configuration.

type Logger

type Logger interface {
	Tracef(string, ...interface{})
	Infof(string, ...interface{})
	Warningf(string, ...interface{})
}

Logger defines the methods we use from loggo.Logger.

type ManifoldConfig

type ManifoldConfig struct {
	Clock            clock.Clock
	LeaseManagerName string
	RaftName         string

	NewWorker      func(Config) (worker.Worker, error)
	UpdateInterval time.Duration
	Logger         Logger
}

ManifoldConfig holds the information necessary to run a GlobalClockUpdater worker in a dependency.Engine.

func (ManifoldConfig) Validate

func (config ManifoldConfig) Validate() error