sign

Documentation

Index

• Variables
• type Sign
  • func Signal() Sign
  • func (d Sign) Done()
  • func (d Sign) Signaled() bool
  • func (d Sign) WaitTimeout(timeout time.Duration) error

Variables

var ErrTimedOut = errors.New("timed out")

ErrTimedOut shows that the signal wasn't fired during the duration, given to the WaitTimeout.

Types

type Sign

type Sign chan struct{}

Sign is a helper structure which holds a simple signal, for instance, if a goroutine is stopped.

func Signal

func Signal() Sign

Signal makes new instance of Sign.

func (Sign) Done

func (d Sign) Done()

Done signs that the sign is done.

func (Sign) Signaled

func (d Sign) Signaled() bool

Signaled immediately checks if the signal was already given.

func (Sign) WaitTimeout

func (d Sign) WaitTimeout(timeout time.Duration) error

WaitTimeout waits until the signal is fired or timed out.