throttle

Documentation

Index

• type Throttle
  • func NewThrottle(max int) *Throttle
  • func (t *Throttle) Do() error
  • func (t *Throttle) Done(err error)
  • func (t *Throttle) Finish() error

Types

type Throttle

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

Throttle allows a limited number of workers to run at a time. It also provides a mechanism to check for errors encountered by workers and wait for them to finish.

How to use throttle? -> Call throttle.Do before starting the goroutine. -> Call throttle.Done in the goroutine. -> Call throttle.Finish to wait for all routines to finish.

func NewThrottle

func NewThrottle(max int) *Throttle

NewThrottle creates a new throttle with a max number of workers.

func (*Throttle) Do

func (t *Throttle) Do() error

Do should be called by workers before they start working. It blocks if there are already maximum number of workers working. If it detects an error from previously Done workers, it would return it.

func (*Throttle) Done

func (t *Throttle) Done(err error)

Done should be called by workers when they finish working. They can also pass the error status of work done.

func (*Throttle) Finish

func (t *Throttle) Finish() error

Finish waits until all workers have finished working. It would return any error passed by Done. If Finish is called multiple time, it will wait for workers to finish only once(first time). From next calls, it will return same error as found on first call.