watcher

Documentation

Overview

Package watcher contains components that are used for configuration reloading of kelon.

Index

• type ChangeType
• type ConfigWatcher

Types

type ChangeType

type ChangeType int

Type of changes that can occur during Watch()

const (
	// Passed to Watch() on initial load
	ChangeAll ChangeType = 0
	// Passed to Watch() if any file with ending '.rego' changed
	ChangeRego ChangeType = 1
	// Passed to Watch() if any file with ending .yml or .yaml changed
	ChangeConf ChangeType = 2
	// Passed to Watch() if any file with unknown file ending changed
	ChangeUnknown ChangeType = 3
)

type ConfigWatcher

type ConfigWatcher interface {

	// Watches for configuration changes and calls the passed callback procedure every
	// time the config changes.
	Watch(callback func(ChangeType, *configs.ExternalConfig, error))
}

ConfigWatcher is the interface that manages configuration reloading.

Therefore a callback procedure is provided, which is always called if any configuration changes.