Documentation
¶
Overview ¶
Package cache2 Cache item old implementation Based on https://github.com/ReneKroon/ttlcache
Index ¶
- Constants
- type Cache2
- func (cache *Cache2) Close()
- func (cache *Cache2) Count() int
- func (cache *Cache2) Delete(key any)
- func (cache *Cache2) Get(key string) (any, bool)
- func (cache *Cache2) Load(key any) (any, bool)
- func (cache *Cache2) Purge()
- func (cache *Cache2) Range(cb func(k, v any) bool)
- func (cache *Cache2) Remove(key string) bool
- func (cache *Cache2) Set(key string, data any)
- func (cache *Cache2) SetCheckExpirationCallback(callback checkExpireCallback)
- func (cache *Cache2) SetExpirationCallback(callback expireCallback)
- func (cache *Cache2) SetNewItemCallback(callback expireCallback)
- func (cache *Cache2) SetTTL(ttl time.Duration)
- func (cache *Cache2) SetWithTTL(key string, data any, ttl time.Duration)
- func (cache *Cache2) SkipTtlExtensionOnHit(value bool)
- func (cache *Cache2) Store(key any, value any)
- func (cache *Cache2) StoreWithTTL(key any, value any, ttl time.Duration)
Constants ¶
const ( // ItemNotExpire Will avoid the cachedItem being expired by TTL, but can still be exired by callback etc. ItemNotExpire time.Duration = -1 // ItemExpireWithGlobalTTL will use the global TTL when set. ItemExpireWithGlobalTTL time.Duration = 0 )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Cache2 ¶
type Cache2 struct {
// contains filtered or unexported fields
}
Cache2 is a synchronized map of items that can auto-expire once stale
func NewTtlCache2 ¶
func NewTtlCache2() *Cache2
NewTtlCache2 is a helper to create instance of the Cache struct
func (*Cache2) Close ¶
func (cache *Cache2) Close()
Close calls Purge, and then stops the goroutine that does ttl checking, for a clean shutdown. The cache is no longer cleaning up after the first call to Close, repeated calls are safe though.
func (*Cache2) Get ¶
Get is a thread-safe way to lookup items Every lookup, also touches the cachedItem, hence extending it's life
func (*Cache2) SetCheckExpirationCallback ¶
func (cache *Cache2) SetCheckExpirationCallback(callback checkExpireCallback)
SetCheckExpirationCallback sets a callback that will be called when an cachedItem is about to expire in order to allow external code to decide whether the cachedItem expires or remains for another TTL cycle
func (*Cache2) SetExpirationCallback ¶
func (cache *Cache2) SetExpirationCallback(callback expireCallback)
SetExpirationCallback sets a callback that will be called when an cachedItem expires
func (*Cache2) SetNewItemCallback ¶
func (cache *Cache2) SetNewItemCallback(callback expireCallback)
SetNewItemCallback sets a callback that will be called when a new cachedItem is added to the cache
func (*Cache2) SetWithTTL ¶
SetWithTTL is a thread-safe way to add new items to the map with individual ttl
func (*Cache2) SkipTtlExtensionOnHit ¶
SkipTtlExtensionOnHit allows the user to change the cache behaviour. When this flag is set to true it will no longer extend TTL of items when they are retrieved using Get, or when their expiration condition is evaluated using SetCheckExpirationCallback.
Source Files