signaler

Documentation

Index

• type Signaler
  • func Setup() *Signaler
  • func (s *Signaler) ManualShutdown(timeout time.Duration) error
  • func (s *Signaler) Start(task func(context.Context) error)
  • func (s *Signaler) Wait(timeout time.Duration) error

Types

type Signaler

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

Signaler sets up a signal catcing channel and allows background tasks to be canceled in unison

func Setup

func Setup() *Signaler

func (*Signaler) ManualShutdown

func (s *Signaler) ManualShutdown(timeout time.Duration) error

ManualShutdown triggers an artificial shutdown and then calls Wait with the given timeout

func (*Signaler) Start

func (s *Signaler) Start(task func(context.Context) error)

Start starts the given task on a goroutine using the global context

func (*Signaler) Wait

func (s *Signaler) Wait(timeout time.Duration) error

Wait blocks until all of the started tasks are completed and returns any errors that occur