signaler

Documentation

Index

• type Signaler
  • func New() *Signaler
  • func (s *Signaler) Close()
  • func (s *Signaler) Listen() <-chan struct{}
  • func (s *Signaler) Signal()
  • func (s *Signaler) Unregister(c chan struct{})

Types

type Signaler

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

Signaler allows subscribing to a singnaling hub

func New

func New() *Signaler

New returns a new Signaler

func (*Signaler) Close

func (s *Signaler) Close()

Close closes the Signaler. Any channel that wasn't explicitly unregistered, is closed.

func (*Signaler) Listen

func (s *Signaler) Listen() <-chan struct{}

Listen returns a new channel signaler

func (*Signaler) Signal

func (s *Signaler) Signal()

Signal triggers a new notification to all listeners

func (*Signaler) Unregister

func (s *Signaler) Unregister(c chan struct{})

Unregister unregisters a channel signaler from the hub