syncwg

Documentation

Index

• type WaitGroup
  • func (wg *WaitGroup) Add(n int)
  • func (wg *WaitGroup) Wait()
  • func (wg *WaitGroup) WaitAndBlock()

Types

type WaitGroup

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

WaitGroup wraps sync.WaitGroup and makes safe to call Add/Wait from concurrent goroutines.

An additional limitation is that call to Wait prohibits further calls to Add until return.

func (*WaitGroup) Add

func (wg *WaitGroup) Add(n int)

Add registers n additional workers. Add may be called from concurrent goroutines.

func (*WaitGroup) Wait

func (wg *WaitGroup) Wait()

Wait waits until all the goroutines call Done.

Wait may be called from concurrent goroutines.

Further calls to Add are blocked until return from Wait.

func (*WaitGroup) WaitAndBlock

func (wg *WaitGroup) WaitAndBlock()

WaitAndBlock waits until all the goroutines call Done and then prevents from new goroutines calling Add.

Further calls to Add are always blocked. This is useful for graceful shutdown when other goroutines calling Add must be stopped.

wg cannot be used after this call.