worker

Documentation

Overview

Package worker provides background worker tasks.

Index

• type Worker
  • func (w *Worker) Go(fn func())
  • func (w *Worker) Halt()
  • func (w *Worker) HaltCh() <-chan interface{}

Types

type Worker

type Worker struct {
	sync.WaitGroup
	// contains filtered or unexported fields
}

Worker is a set of managed background go routines.

func (*Worker) Go

func (w *Worker) Go(fn func())

Go excutes the function fn in a new Go routine. Multiple Go routines may be started under the same Worker. It is the function's responsibility to monitor the channel returned by `Worker.HaltCh()` and to return.

func (*Worker) Halt

func (w *Worker) Halt()

Halt signals all Go routines started under a Worker to terminate, and waits till all go routines have returned.

func (*Worker) HaltCh

func (w *Worker) HaltCh() <-chan interface{}

HaltCh returns the channel that will be closed on a call to Halt.