cacheqm

Documentation

Overview

Package cacheqm contains a caching quota.Manager implementation.

Index

• Constants
• func NewCachedManager(qm quota.Manager, minBatchSize, maxEntries int) (quota.Manager, error)

Constants

const (
	// DefaultMinBatchSize is the suggested default for minBatchSize.
	DefaultMinBatchSize = 100

	// DefaultMaxCacheEntries is the suggested default for maxEntries.
	DefaultMaxCacheEntries = 1000
)

Functions

func NewCachedManager

func NewCachedManager(qm quota.Manager, minBatchSize, maxEntries int) (quota.Manager, error)

NewCachedManager wraps a quota.Manager with an implementation that caches tokens locally.

minBatchSize determines the minimum number of tokens requested from qm for each GetTokens() request.

maxEntries determines the maximum number of cache entries, apart from global quotas. The oldest entries are evicted as necessary, their tokens replenished via PutTokens() to avoid excessive leakage.