core

README

HomeDashboard Core Comonents

This repository/packge contains central components and interfaces for theHomeDashboad project.

Links

• HomeDashboard Documentation

Documentation

Index

• type DataSource
• type Minion
  • func NewMinion(child Runable) *Minion
  • func (minion *Minion) Run(ctx context.Context) error
  • func (minion *Minion) Stop()
• type Runable

Types

type DataSource

type DataSource string

const (
	DATASOURCE_BILLINGREPORT DataSource = "billingreport"
	DATASOURCE_WEATHER       DataSource = "weather"
	DATASOURCE_INDOORCLIMATE DataSource = "indoorclimate"
	DATASOURCE_EXCHANGERATE  DataSource = "exchangerate"
	DATASOURCE_STRAVA        DataSource = "strava"
)

type Minion

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

Minion is a worker which observes execution of a child and OS signals for graceful shutdowns.

func NewMinion

func NewMinion(child Runable) *Minion

NewMinion returns a new runable minion with given child.

func (*Minion) Run

func (minion *Minion) Run(ctx context.Context) error

Run calls run on currentchild and observe os signals and manual stop.

func (*Minion) Stop

func (minion *Minion) Stop()

Stop can be called to manual stop execution of a minion.

type Runable

type Runable interface {

	// Run is used as an entry point to execute desired busines logic.
	// Should confirm wait group on exit.
	Run(context.Context, *sync.WaitGroup) error
}

Interface used for executables. Should listen to context cancel if graceful shutdown is desired.