alert

Documentation

Index

• type Notice
  • func (n *Notice) Alert()
  • func (n *Notice) Wait(kick <-chan struct{}) <-chan bool

Types

type Notice

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

Notice defines fields required to alert sub-systems of a change of state so a routine can re-check in memory data

func (*Notice) Alert

func (n *Notice) Alert()

Alert establishes a state change on the required struct.

func (*Notice) Wait

func (n *Notice) Wait(kick <-chan struct{}) <-chan bool

Wait pauses calling routine until change of state has been established via notice method Alert. Kick allows for cancellation of waiting or when the caller has been shut down, if this is not needed it can be set to nil. This returns a channel so strategies can cleanly wait on a select statement case.