engine

Documentation

Index

• Constants
• type Common
  • func (c Common) Engine() *Engine
  • func (c Common) TemplateName() string
• type Engine
  • func (engine *Engine) AddTemplates(paths []string, watch bool)
  • func (engine *Engine) Close()
  • func (engine *Engine) FileWatcher() *fsnotify.Watcher
  • func (engine *Engine) Sources() Sources
• type Registry
  • func (r *Registry) ExpandURI(uri md.LimitedURI) (md.LimitedURI, error)
  • func (r *Registry) Register(alias string, base md.LimitedURI) error
• type Relation
  • func EmptyRelation() Relation
  • func (d *Relation) ImpactedSource(value str) []string
  • func (d *Relation) ImpactedTarget(source str) []string
  • func (d *Relation) Relate(source str, target str)
• type Template
  • func NewTemplate(templ *hb.Template, realpath string, hashed string) *Template
  • func ParseTemplate(realpath string) (template *Template, err error)
  • func (template *Template) Hash() (string, error)
  • func (template *Template) Reload()

Constants

const (
	FIELD_ENGINE        = "engine"
	FIELD_TEMPLATE_NAME = "templateName"
)

const (
	FIELD_REALPATH      = "realpath"
	FIELD_TEMPLATE_NAME = "templateName"
)

Types

type Common

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

func (Common) Engine

func (c Common) Engine() *Engine

func (Common) TemplateName

func (c Common) TemplateName() string

type Engine

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

Engine : Main entrypoint of configuration daemon.

This struct manage - lifecycle of source.Source - template lifecycles - value caches

Template can be added dynamically but sources are statically defined at initialization.

func (*Engine) AddTemplates

func (engine *Engine) AddTemplates(paths []string, watch bool)

AddTemplates : Add several templates at runtime

What this method do : - parse template from paths - flag the template whether it need to be watched or not - init some template function (ALookup, SLookup, HLookup, Lookup) in each template

func (*Engine) Close

func (engine *Engine) Close()

Close : close the engine (io.Closer)

What this method do : - close filewatcher - close all sources

func (*Engine) FileWatcher

func (engine *Engine) FileWatcher() *fsnotify.Watcher

FileWatcher : Get all relevant file watcher that being used

by this engine

func (*Engine) Sources

func (engine *Engine) Sources() Sources

Sources : Get all available & declared engine sources

type Registry

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

Registry : registery (for uri alias) only registry no unregistration

func (*Registry) ExpandURI

func (r *Registry) ExpandURI(uri md.LimitedURI) (md.LimitedURI, error)

ExpandURI : expanding URI recursively

func (*Registry) Register

func (r *Registry) Register(alias string, base md.LimitedURI) error

type Relation

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

This can be used for defining which template that need to evaluated if there is value changes.

func EmptyRelation

func EmptyRelation() Relation

func (*Relation) ImpactedSource

func (d *Relation) ImpactedSource(value str) []string

func (*Relation) ImpactedTarget

func (d *Relation) ImpactedTarget(source str) []string

func (*Relation) Relate

func (d *Relation) Relate(source str, target str)

type Template

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

func NewTemplate

func NewTemplate(templ *hb.Template, realpath string, hashed string) *Template

func ParseTemplate

func ParseTemplate(realpath string) (template *Template, err error)

func (*Template) Hash

func (template *Template) Hash() (string, error)

func (*Template) Reload

func (template *Template) Reload()