broker

Documentation

Index

• type GenericNotifier
  • func NewGenericNotifier() *GenericNotifier
  • func (g *GenericNotifier) Notify(msg interface{})
  • func (g *GenericNotifier) Run(stopCh <-chan struct{})
  • func (g *GenericNotifier) WaitForChange(timeout time.Duration) interface{}

Types

type GenericNotifier

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

GenericNotifier allows a process to send updates to many subscribers in an easy manner.

func NewGenericNotifier

func NewGenericNotifier() *GenericNotifier

NewGenericNotifier returns a generic notifier which can be used by a process to notify many subscribers when a specific update is triggered.

func (*GenericNotifier) Notify

func (g *GenericNotifier) Notify(msg interface{})

Notify allows the implementer to notify all subscribers with a specific update. There is no guarantee the order in which subscribers receive the message which is sent linearly.

func (*GenericNotifier) Run

func (g *GenericNotifier) Run(stopCh <-chan struct{})

Run is a long-lived process which handles updating subscribers as well as ensuring any update is sent to them. The passed stopCh is used to coordinate shutdown.

func (*GenericNotifier) WaitForChange

func (g *GenericNotifier) WaitForChange(timeout time.Duration) interface{}

WaitForChange allows a subscriber to wait until there is a notification change, or the timeout is reached. The function will block until one condition is met.