signal

Documentation

Overview

Package signal provides mechanism for notifying multiple listeners when something happened.

Index

• type Signal
  • func New() *Signal
  • func (s *Signal) Bind() chan context.Context
  • func (s *Signal) Broadcast(ctx context.Context)
  • func (s *Signal) Unbind(ch chan context.Context)

Types

type Signal

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

A Signal is used to let multiple listeners know when something happened.

func New

func New() *Signal

New creates a new Signal.

func (*Signal) Bind

func (s *Signal) Bind() chan context.Context

Bind creates a new listening channel bound to the signal. The channel used has a size of 1 and any given broadcast will signal at least one event, but may signal more than one.

func (*Signal) Broadcast

func (s *Signal) Broadcast(ctx context.Context)

Broadcast signals all the listeners. Broadcast never blocks.

func (*Signal) Unbind

func (s *Signal) Unbind(ch chan context.Context)

Unbind stops the listening channel bound to the signal.