cache

Documentation

Index

• Constants
• func GetContextData(ctx context.Context, tp, key any) any
• func GetInt64(key string, getFunc func() (int64, error)) (int64, error)
• func GetString(key string, getFunc func() (string, error)) (string, error)
• func GetWithContextCache[T any](ctx context.Context, cacheGroupKey string, cacheTargetID any, ...) (T, error)
• func Init() error
• func Remove(key string)
• func RemoveContextData(ctx context.Context, tp, key any)
• func SetContextData(ctx context.Context, tp, key, value any)
• func Test() (time.Duration, error)
• func WithCacheContext(ctx context.Context) context.Context
• func WithNoCacheContext(ctx context.Context) context.Context
• type GetJSONError
  • func (e *GetJSONError) ToError() error
• type MemoryItem
• type RedisCacher
  • func (c *RedisCacher) Decr(key string) error
  • func (c *RedisCacher) Delete(key string) error
  • func (c *RedisCacher) Flush() error
  • func (c *RedisCacher) Get(key string) any
  • func (c *RedisCacher) Incr(key string) error
  • func (c *RedisCacher) IsExist(key string) bool
  • func (c *RedisCacher) Ping() error
  • func (c *RedisCacher) Put(key string, val any, expire int64) error
  • func (c *RedisCacher) StartAndGC(opts cache.Options) error
• type StringCache
  • func GetCache() StringCache
  • func NewStringCache(cacheConfig setting.Cache) (StringCache, error)
• type TwoQueueCache
  • func (c *TwoQueueCache) Decr(key string) error
  • func (c *TwoQueueCache) Delete(key string) error
  • func (c *TwoQueueCache) Flush() error
  • func (c *TwoQueueCache) Get(key string) any
  • func (c *TwoQueueCache) Incr(key string) error
  • func (c *TwoQueueCache) IsExist(key string) bool
  • func (c *TwoQueueCache) Ping() error
  • func (c *TwoQueueCache) Put(key string, val any, timeout int64) error
  • func (c *TwoQueueCache) StartAndGC(opts mc.Options) error
• type TwoQueueCacheConfig

Constants

const (
	SlowCacheThreshold = 100 * time.Microsecond
)

Functions

func GetContextData

func GetContextData(ctx context.Context, tp, key any) any

func GetInt64

func GetInt64(key string, getFunc func() (int64, error)) (int64, error)

GetInt64 returns key value from cache with callback when no key exists in cache

func GetString

func GetString(key string, getFunc func() (string, error)) (string, error)

GetString returns the key value from cache with callback when no key exists in cache

func GetWithContextCache

func GetWithContextCache[T any](ctx context.Context, cacheGroupKey string, cacheTargetID any, f func() (T, error)) (T, error)

GetWithContextCache returns the cache value of the given key in the given context.

func Init

func Init() error

Init start cache service

func Remove

func Remove(key string)

Remove key from cache

func RemoveContextData

func RemoveContextData(ctx context.Context, tp, key any)

func SetContextData

func SetContextData(ctx context.Context, tp, key, value any)

func Test

func Test() (time.Duration, error)

func WithCacheContext

func WithCacheContext(ctx context.Context) context.Context

func WithNoCacheContext

func WithNoCacheContext(ctx context.Context) context.Context

Types

type GetJSONError

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

func (*GetJSONError) ToError

func (e *GetJSONError) ToError() error

type MemoryItem

type MemoryItem struct {
	Val     any
	Created int64
	Timeout int64
}

MemoryItem represents a memory cache item.

type RedisCacher

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

RedisCacher represents a redis cache adapter implementation.

func (*RedisCacher) Decr

func (c *RedisCacher) Decr(key string) error

Decr decreases cached int-type value by given key as a counter.

func (*RedisCacher) Delete

func (c *RedisCacher) Delete(key string) error

Delete deletes cached value by given key.

func (*RedisCacher) Flush

func (c *RedisCacher) Flush() error

Flush deletes all cached data.

func (*RedisCacher) Get

func (c *RedisCacher) Get(key string) any

Get gets cached value by given key.

func (*RedisCacher) Incr

func (c *RedisCacher) Incr(key string) error

Incr increases cached int-type value by given key as a counter.

func (*RedisCacher) IsExist

func (c *RedisCacher) IsExist(key string) bool

IsExist returns true if cached value exists.

func (*RedisCacher) Ping

func (c *RedisCacher) Ping() error

Ping tests if the cache is alive.

func (*RedisCacher) Put

func (c *RedisCacher) Put(key string, val any, expire int64) error

Put puts value (string type) into cache with key and expire time. If expired is 0, it lives forever.

func (*RedisCacher) StartAndGC

func (c *RedisCacher) StartAndGC(opts cache.Options) error

StartAndGC starts GC routine based on config string settings. AdapterConfig: network=tcp,addr=:6379,password=macaron,db=0,pool_size=100,idle_timeout=180,hset_name=MacaronCache,prefix=cache:

type StringCache

type StringCache interface {
	Ping() error

	Get(key string) (string, bool)
	Put(key, value string, ttl int64) error
	Delete(key string) error
	IsExist(key string) bool

	PutJSON(key string, v any, ttl int64) error
	GetJSON(key string, ptr any) (exist bool, err *GetJSONError)

	ChiCache() chi_cache.Cache
}

func GetCache

func GetCache() StringCache

GetCache returns the currently configured cache

func NewStringCache

func NewStringCache(cacheConfig setting.Cache) (StringCache, error)

type TwoQueueCache

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

TwoQueueCache represents a LRU 2Q cache adapter implementation

func (*TwoQueueCache) Decr

func (c *TwoQueueCache) Decr(key string) error

Decr decreases cached int-type value by given key as a counter.

func (*TwoQueueCache) Delete

func (c *TwoQueueCache) Delete(key string) error

Delete deletes cached value by given key.

func (*TwoQueueCache) Flush

func (c *TwoQueueCache) Flush() error

Flush deletes all cached data.

func (*TwoQueueCache) Get

func (c *TwoQueueCache) Get(key string) any

Get gets cached value by given key.

func (*TwoQueueCache) Incr

func (c *TwoQueueCache) Incr(key string) error

Incr increases cached int-type value by given key as a counter.

func (*TwoQueueCache) IsExist

func (c *TwoQueueCache) IsExist(key string) bool

IsExist returns true if cached value exists.

func (*TwoQueueCache) Ping

func (c *TwoQueueCache) Ping() error

Ping tests if the cache is alive.

func (*TwoQueueCache) Put

func (c *TwoQueueCache) Put(key string, val any, timeout int64) error

Put puts value into cache with key and expire time.

func (*TwoQueueCache) StartAndGC

func (c *TwoQueueCache) StartAndGC(opts mc.Options) error

StartAndGC starts GC routine based on config string settings.

type TwoQueueCacheConfig

type TwoQueueCacheConfig struct {
	Size        int     `ini:"SIZE" json:"size"`
	RecentRatio float64 `ini:"RECENT_RATIO" json:"recent_ratio"`
	GhostRatio  float64 `ini:"GHOST_RATIO" json:"ghost_ratio"`
}

TwoQueueCacheConfig describes the configuration for TwoQueueCache