ratelimiter

Documentation

Overview

Package ratelimiter defines rate limiters used by Controllers to limit how frequently requests may be queued.

Typical rate limiters that can be used are implemented in client-go's workqueue package.

Index

• type RateLimiter

Types

type RateLimiter

type RateLimiter interface {
	// When gets an item and gets to decide how long that item should wait
	When(item interface{}) time.Duration
	// Forget indicates that an item is finished being retried.  Doesn't matter whether its for perm failing
	// or for success, we'll stop tracking it
	Forget(item interface{})
	// NumRequeues returns back how many failures the item has had
	NumRequeues(item interface{}) int
}

RateLimiter is an identical interface of client-go workqueue RateLimiter.