lifeflag

package

v0.0.0-...-298751d Latest Latest Go to latest Published: Apr 19, 2024 License: AGPL-3.0 Imports: 11 Imported by: 4

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/juju/juju

Documentation ¶

Index ¶

Constants
func Manifold(config ManifoldConfig) dependency.Manifold
func NewWorker(config Config) (worker.Worker, error)
type Config
- func (config Config) Validate() error
type Facade
type ManifoldConfig
type Worker
- func New(config Config) (*Worker, error)

Constants ¶

View Source

const (
	// ErrNotFound indicates that the worker cannot run because
	// the configured entity does not exist.
	ErrNotFound = apilifeflag.ErrEntityNotFound

	// ErrValueChanged indicates that the result of Check is
	// outdated, and the worker should be restarted.
	ErrValueChanged = errors.ConstError("flag value changed")
)

Variables ¶

This section is empty.

Functions ¶

func Manifold ¶

func Manifold(config ManifoldConfig) dependency.Manifold

Manifold returns a dependency.Manifold that will run a Worker as configured.

func NewWorker ¶

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

Types ¶

type Config ¶

type Config struct {
	Facade         Facade
	Entity         names.Tag
	Result         life.Predicate
	NotFoundIsDead bool
}

Config holds the configuration and dependencies for a worker.

func (Config) Validate ¶

func (config Config) Validate() error

Validate returns an error if the config cannot be expected to drive a functional worker.

type Facade ¶

type Facade interface {
	Watch(names.Tag) (watcher.NotifyWatcher, error)
	Life(names.Tag) (life.Value, error)
}

Facade exposes capabilities required by the worker.

type ManifoldConfig ¶

type ManifoldConfig struct {
	APICallerName string
	AgentName     string

	Entity         names.Tag
	Result         life.Predicate
	Filter         dependency.FilterFunc
	NotFoundIsDead bool

	NewFacade func(base.APICaller) (Facade, error)
	NewWorker func(Config) (worker.Worker, error)
}

ManifoldConfig describes how to configure and construct a Worker, and what registered resources it may depend upon.

type Worker ¶

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

Worker holds the result of some predicate regarding an entity's life, and fails with ErrValueChanged when the result of the predicate changes.

func New ¶

func New(config Config) (*Worker, error)

New returns a worker that exposes the result of the configured predicate when applied to the configured entity's life value, and fails with ErrValueChanged when the result changes.

func (*Worker) Check ¶

func (w *Worker) Check() bool

Check is part of the util.Flag interface.

func (*Worker) Kill ¶

func (w *Worker) Kill()

Kill is part of the worker.Worker interface.

func (*Worker) Wait ¶

func (w *Worker) Wait() error

Wait is part of the worker.Worker interface.

Source Files ¶

View all Source files

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