limitgroup

README

limitgroup

Documentation: https://godoc.org/github.com/facebookgo/limitgroup

Documentation

Overview

Package limitgroup provides a sync.WaitGroup equivalent with a configurable upper bound. This is implemented by having Add() block as well if necessary.

Index

• type LimitGroup
  • func NewLimitGroup(limit uint) *LimitGroup
  • func (l *LimitGroup) Add(delta int)
  • func (l *LimitGroup) Done()

Types

type LimitGroup

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

LimitGroup provides a WaitGroup with a limited upper bound. Once the limit is hit, Add will block until sufficient deltas are returned.

func NewLimitGroup

func NewLimitGroup(limit uint) *LimitGroup

NewLimitGroup creates a new LimitGroup with the configured limit.

func (*LimitGroup) Add

func (l *LimitGroup) Add(delta int)

Add adds delta, which may be negative. It will block if we have hit the limit, and will unblock as Done is called.

func (*LimitGroup) Done

func (l *LimitGroup) Done()

Done decrements the counter.