signal

Documentation

Index

• type Signal
  • func New(ch chan struct{}) *Signal
  • func (s *Signal) Notify()
  • func (s *Signal) Wait() <-chan struct{}

Types

type Signal

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

Signal lets goroutines signal that some event has occurred. Other goroutines can wait for the signal.

func New

func New(ch chan struct{}) *Signal

New wraps a channel and turns it into a signal for a one-time event.

func (*Signal) Notify

func (s *Signal) Notify()

Notify alerts any goroutines waiting on this signal that the event has occurred. After the first call to Notify(), future calls are no-op.

func (*Signal) Wait

func (s *Signal) Wait() <-chan struct{}

Wait returns a channel which will be written to when Notify() is called for the first time. This channel will never be written to a second time.