core

Documentation

Overview

Package core implements commonly used tools.

Documentation Last Review: 08.10.2020

Index

• type Observable
• type Observer
• type Watcher
  • func NewWatcher() *Watcher
  • func (w *Watcher) Add(observer Observer)
  • func (w *Watcher) Notify(event interface{})
  • func (w *Watcher) Remove(observer Observer)

Types

type Observable

type Observable interface {
	// Add adds the observer to the list of observers that will be notified of
	// new events.
	Add(observer Observer)

	// Remove removes the observer from the list thus stopping it from receiving
	// new events.
	Remove(observer Observer)

	// Notify notifies the observers of a new event.
	Notify(event interface{})
}

Observable provides primitives to add and remove observers and to notify them of new events.

type Observer

type Observer interface {
	NotifyCallback(event interface{})
}

Observer is the interface to implement to watch events.

type Watcher

type Watcher struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Watcher is an implementation of the Observable interface.

- implements core.Observable

func NewWatcher

func NewWatcher() *Watcher

NewWatcher creates a new empty watcher.

func (*Watcher) Add

func (w *Watcher) Add(observer Observer)

Add implements core.Observable. It adds the observer to the list of observers that will be notified of new events.

func (*Watcher) Notify

func (w *Watcher) Notify(event interface{})

Notify implements core.Observable. It notifies the whole list of observers one after each other.

func (*Watcher) Remove

func (w *Watcher) Remove(observer Observer)

Remove implements core.Observable. It removes the observer from the list thus stopping it from receiving new events.