package waitgroup

import "k8s.io/apimachinery/pkg/util/waitgroup"

Package waitgroup implements SafeWaitGroup wrap of sync.WaitGroup. Add with positive delta when waiting will fail, to prevent sync.WaitGroup race issue.

Index ¶

• type RateLimitedSafeWaitGroup
• func (wg *RateLimitedSafeWaitGroup) Add(delta int) error
• func (wg *RateLimitedSafeWaitGroup) Done()
• func (wg *RateLimitedSafeWaitGroup) Wait(limiterFactory RateLimiterFactoryFunc) (int, int, error)
• type RateLimiter
• type RateLimiterFactoryFunc
• type SafeWaitGroup
• func (wg *SafeWaitGroup) Add(delta int) error
• func (wg *SafeWaitGroup) Done()
• func (wg *SafeWaitGroup) Wait()

Types ¶

type RateLimitedSafeWaitGroup ¶

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

RateLimitedSafeWaitGroup must not be copied after first use.

func (*RateLimitedSafeWaitGroup) Add ¶

func (wg *RateLimitedSafeWaitGroup) Add(delta int) error

Add adds delta, which may be negative, similar to sync.WaitGroup. If Add with a positive delta happens after Wait, it will return error, which prevent unsafe Add.

func (*RateLimitedSafeWaitGroup) Done ¶

func (wg *RateLimitedSafeWaitGroup) Done()

Done decrements the WaitGroup counter, rate limiting is applied only when the wait group is in waiting mode.

func (*RateLimitedSafeWaitGroup) Wait ¶

func (wg *RateLimitedSafeWaitGroup) Wait(limiterFactory RateLimiterFactoryFunc) (int, int, error)

Wait blocks until the WaitGroup counter is zero or a hard limit has elapsed. It returns the number of active request(s) accounted for at the time Wait has been invoked, number of request(s) that have drianed (done using the wait group immediately before Wait returns). Ideally, the both numbers returned should be equal, to indicate that all request(s) using the wait group have released their lock.

type RateLimiter ¶

type RateLimiter interface {
	Wait(ctx context.Context) error
}

RateLimiter abstracts the rate limiter used by RateLimitedSafeWaitGroup. The implementation must be thread-safe.

type RateLimiterFactoryFunc ¶

type RateLimiterFactoryFunc func(count int) (RateLimiter, context.Context, context.CancelFunc)

RateLimiterFactoryFunc is used by the RateLimitedSafeWaitGroup to create a new instance of a RateLimiter that will be used to rate limit the return rate of the active number of request(s). 'count' is the number of requests in flight that are expected to invoke 'Done' on this wait group.

type SafeWaitGroup ¶

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

SafeWaitGroup must not be copied after first use.

func (*SafeWaitGroup) Add ¶

func (wg *SafeWaitGroup) Add(delta int) error

Add adds delta, which may be negative, similar to sync.WaitGroup. If Add with a positive delta happens after Wait, it will return error, which prevent unsafe Add.

func (*SafeWaitGroup) Done ¶

func (wg *SafeWaitGroup) Done()

Done decrements the WaitGroup counter.

func (*SafeWaitGroup) Wait ¶

func (wg *SafeWaitGroup) Wait()

Wait blocks until the WaitGroup counter is zero.

Source Files ¶

doc.go ratelimited_waitgroup.go waitgroup.go