monitor

package

v0.0.0-...-35d3f71 Latest Latest Go to latest Published: Feb 17, 2023 License: BSD-3-Clause Imports: 3 Imported by: 0

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

This section is empty.

This section is empty.

This section is empty.

type Config struct {
	Logger   *log.Logger
	Decks    *decks.Decks
	Filepath string
}

Config contains configuration and data needed to run the monitor.

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

Monitor monitors the given file for changes, and updates the status of the decks.

func New(cfg Config) (*Monitor, error)

New returns an initialised Monitor ready to watch the session file for changes.

func (m *Monitor) Close()

Close closes the file watcher when it's finished being used.

func (m *Monitor) Run(ch chan error)

Run begins monitoring the session file for changes, and notifies the decks when changes occur.