waitgroup

Documentation

Overview

The internal `waitgroup` package is a generic which provides a synchronization lock to read observe a list of provided entities.

Index

• type WaitGroup
  • func (wg *WaitGroup[T]) Add(k T)
  • func (wg *WaitGroup[T]) Contains(needle T) bool
  • func (wg *WaitGroup[T]) Done(needle T)
  • func (wg *WaitGroup[T]) Items() []T
  • func (wg *WaitGroup[T]) Wait()

Types

type WaitGroup

type WaitGroup[T comparable] struct {
	// contains filtered or unexported fields
}

func (*WaitGroup[T]) Add

func (wg *WaitGroup[T]) Add(k T)

Add to the wait group.

func (*WaitGroup[T]) Contains

func (wg *WaitGroup[T]) Contains(needle T) bool

Contains checks if the provided entity is still in the wait group.

func (*WaitGroup[T]) Done

func (wg *WaitGroup[T]) Done(needle T)

Done signals that the provided entity can be removed from the wait group.

func (*WaitGroup[T]) Items

func (wg *WaitGroup[T]) Items() []T

Items returns the list of items in the wait group.

func (*WaitGroup[T]) Wait

func (wg *WaitGroup[T]) Wait()

Wait for all items in the wait group to be removed.