gcache

package
v0.0.0-...-8506bae Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 30, 2024 License: MIT Imports: 21 Imported by: 0

README

GMC Cache

  1. Support of Redis.
  2. Support of Multiple redis source.

Configuration

cache configuration section in app.toml

########################################################
# cache configuration
########################################################
# redis supported
# support of mutiple redis server 
# notic: each config section must have an unique id 
########################################################
[cache]
default="redis"
[[cache.redis]]
debug=true
enable=true
id="default"
address="127.0.0.1:6379"
prefix=""
password=""
# seconds
timeout=10
dbnum=0
maxidle=10
maxactive=30
# seconds
idletimeout=300
# seconds
maxconnlifetime=3600
wait=true

Example

package main

import (
	"github.com/snail007/gmc"
	"time"
)

func main() {
	cfg := gmc.New.Config()
	cfg.SetConfigFile("../../app.toml")
	err := cfg.ReadInConfig()
	if err != nil {
		panic(err)
	}
	// Init only using [cache] section in app.toml
	gmc.Cache.Init(cfg)

	// cache default is redis in app.toml
	// so gmc.Cache() equal to  gmc.Redis()
	// we can connect to multiple cache drivers at same time, id is the unique name of driver
	// gmc.Cache(id) to load `id` named default driver.
	c := gmc.Cache.Cache()
	c.Set("test", "aaa", time.Second)
	c.Get("test")
}

Documentation

Index

Constants

View Source 
const (
	// NoExpiration for use with functions that take an expiration time.
	NoExpiration time.Duration = -1
	// DefaultExpiration for use with functions that take an expiration time. Equivalent to
	// passing in the same expiration duration as was given to New() or
	// NewFrom() when the cache was created (e.g. 5 minutes.)
	DefaultExpiration time.Duration = 0
)

Variables

View Source 
var (
	// ErrKeyNotExists is the error of key not exists
	ErrKeyNotExists = fmt.Errorf("key not exists")
)

Functions

func AddCacheU 

func AddCacheU(id string, c gcore.Cache)

func Cache 

func Cache(id ...string) gcore.Cache

func CacheU 

func CacheU(id ...string) gcore.Cache

func Exists 

func Exists(path string) bool

func Init 

func Init(cfg0 gcore.Config) (err error)

Init parse app.toml database configuration, `cfg` is Config object of app.toml

func SetLogger 

func SetLogger(l gcore.Logger)

Types

type FileCache 

type FileCache struct {
	gcore.Cache
	// contains filtered or unexported fields
}

FileCache represents a file cache adapter implementation.

func File 

func File(id ...string) *FileCache

File acquires a file cache object associated the id, id default is : `default`

func NewFileCache 

func NewFileCache(cfg interface{}) (cache *FileCache, err error)

NewFileCache creates and returns a new file cache.

func (*FileCache) Clear 

func (c *FileCache) Clear() error

Clear deletes all cached data.

func (*FileCache) Decr 

func (c *FileCache) Decr(key string) (int64, error)

Decr decrease cached int value.

func (*FileCache) DecrN 

func (c *FileCache) DecrN(key string, n int64) (val int64, err error)

DecrN decrease value N by key

func (*FileCache) Del 

func (c *FileCache) Del(key string) error

Del deletes cached value by given key.

func (*FileCache) DelMulti 

func (c *FileCache) DelMulti(keys []string) (err error)

func (*FileCache) Get 

func (c *FileCache) Get(key string) (val string, err error)

Get gets cached value by given key.

func (*FileCache) GetMulti 

func (c *FileCache) GetMulti(keys []string) (map[string]string, error)

GetMulti get multiple keys values.

func (*FileCache) Has 

func (c *FileCache) Has(key string) (bool, error)

Has returns true if cached value exists.

func (*FileCache) Incr 

func (c *FileCache) Incr(key string) (int64, error)

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

func (*FileCache) IncrN 

func (c *FileCache) IncrN(key string, n int64) (val int64, err error)

IncrN increase value N by key

func (*FileCache) Set 

func (c *FileCache) Set(key string, val string, ttl time.Duration) error

Set sets value into cache with key and expire time. If expired is 0, it will be deleted by next GC operation.

func (*FileCache) SetMulti 

func (c *FileCache) SetMulti(values map[string]string, ttl time.Duration) (err error)

func (*FileCache) String 

func (c *FileCache) String() string

type FileCacheConfig 

type FileCacheConfig struct {
	Dir             string
	CleanupInterval time.Duration
}

func NewFileCacheConfig 

func NewFileCacheConfig() *FileCacheConfig

type Item 

type Item struct {
	Val     string
	Created int64
	TTL     int64
}

Item represents a cache item.

type MemCache 

type MemCache struct {
	gcore.Cache
	// contains filtered or unexported fields
}

func Memory 

func Memory(id ...string) *MemCache

Memory acquires a memory cache object associated the id, id default is : `default`

func NewMemCache 

func NewMemCache(cfg interface{}) *MemCache

func (*MemCache) Clear 

func (s *MemCache) Clear() error

func (*MemCache) Decr 

func (s *MemCache) Decr(key string) (v int64, err error)

func (*MemCache) DecrN 

func (s *MemCache) DecrN(key string, n int64) (v int64, err error)

func (*MemCache) Del 

func (s *MemCache) Del(key string) error

func (*MemCache) DelMulti 

func (s *MemCache) DelMulti(keys []string) (err error)

func (*MemCache) Get 

func (s *MemCache) Get(key string) (string, error)

func (*MemCache) GetMulti 

func (s *MemCache) GetMulti(keys []string) (map[string]string, error)

func (*MemCache) Has 

func (s *MemCache) Has(key string) (bool, error)

func (*MemCache) Incr 

func (s *MemCache) Incr(key string) (v int64, err error)

func (*MemCache) IncrN 

func (s *MemCache) IncrN(key string, n int64) (v int64, err error)

func (*MemCache) Set 

func (s *MemCache) Set(key string, value string, ttl time.Duration) error

func (*MemCache) SetMulti 

func (s *MemCache) SetMulti(values map[string]string, ttl time.Duration) (err error)

func (*MemCache) String 

func (s *MemCache) String() string

type MemCacheConfig 

type MemCacheConfig struct {
	CleanupInterval time.Duration
}

func NewMemCacheConfig 

func NewMemCacheConfig() *MemCacheConfig

type MemoryCache 

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

func NewMemoryCache 

func NewMemoryCache(defaultExpiration, cleanupInterval time.Duration) *MemoryCache

NewMemoryCache returns a new cache with a given default expiration duration and cleanup interval. If the expiration duration is less than one (or NoExpiration), the items in the cache never expire (by default), and must be deleted manually. If the cleanup interval is less than one, expired items are not deleted from the cache before calling c.DeleteExpired().

func NewMemoryCacheFrom 

func NewMemoryCacheFrom(defaultExpiration, cleanupInterval time.Duration, items map[string]MemoryCacheItem) *MemoryCache

NewMemoryCacheFrom returns a new cache with a given default expiration duration and cleanup interval. If the expiration duration is less than one (or NoExpiration), the items in the cache never expire (by default), and must be deleted manually. If the cleanup interval is less than one, expired items are not deleted from the cache before calling c.DeleteExpired().

NewFrom() also accepts an items map which will serve as the underlying map for the cache. This is useful for starting from a deserialized cache (serialized using e.g. gob.Encode() on c.MemoryCacheItems()), or passing in e.g. make(map[string]MemoryCacheItem, 500) to improve startup performance when the cache is expected to reach a certain minimum size.

Only the cache's methods synchronize access to this map, so it is not recommended to keep any references to the map around after creating a cache. If need be, the map can be accessed at a later point using c.MemoryCacheItems() (subject to the same caveat.)

Note regarding serialization: When using e.g. gob, make sure to gob.Register() the individual types stored in the cache before encoding a map retrieved with c.MemoryCacheItems(), and to register those same types before decoding a blob containing an items map.

func (MemoryCache) Add 

func (c MemoryCache) Add(k string, x interface{}, d time.Duration) error

Add an item to the cache only if an item doesn't already exist for the given key, or if the existing item has expired. Returns an error otherwise.

func (MemoryCache) Decrement 

func (c MemoryCache) Decrement(k string, n int64) error

Decrement an item of type int, int8, int16, int32, int64, uintptr, uint, uint8, uint32, or uint64, float32 or float64 by n. Returns an error if the item's value is not an integer, if it was not found, or if it is not possible to decrement it by n. To retrieve the decremented value, use one of the specialized methods, e.g. DecrementInt64.

func (MemoryCache) DecrementFloat 

func (c MemoryCache) DecrementFloat(k string, n float64) error

Decrement an item of type float32 or float64 by n. Returns an error if the item's value is not floating point, if it was not found, or if it is not possible to decrement it by n. Pass a negative number to decrement the value. To retrieve the decremented value, use one of the specialized methods, e.g. DecrementFloat64.

func (MemoryCache) DecrementFloat32 

func (c MemoryCache) DecrementFloat32(k string, n float32) (float32, error)

Decrement an item of type float32 by n. Returns an error if the item's value is not an float32, or if it was not found. If there is no error, the decremented value is returned.

func (MemoryCache) DecrementFloat64 

func (c MemoryCache) DecrementFloat64(k string, n float64) (float64, error)

Decrement an item of type float64 by n. Returns an error if the item's value is not an float64, or if it was not found. If there is no error, the decremented value is returned.

func (MemoryCache) DecrementInt 

func (c MemoryCache) DecrementInt(k string, n int) (int, error)

Decrement an item of type int by n. Returns an error if the item's value is not an int, or if it was not found. If there is no error, the decremented value is returned.

func (MemoryCache) DecrementInt16 

func (c MemoryCache) DecrementInt16(k string, n int16) (int16, error)

Decrement an item of type int16 by n. Returns an error if the item's value is not an int16, or if it was not found. If there is no error, the decremented value is returned.

func (MemoryCache) DecrementInt32 

func (c MemoryCache) DecrementInt32(k string, n int32) (int32, error)

Decrement an item of type int32 by n. Returns an error if the item's value is not an int32, or if it was not found. If there is no error, the decremented value is returned.

func (MemoryCache) DecrementInt64 

func (c MemoryCache) DecrementInt64(k string, n int64) (int64, error)

Decrement an item of type int64 by n. Returns an error if the item's value is not an int64, or if it was not found. If there is no error, the decremented value is returned.

func (MemoryCache) DecrementInt8 

func (c MemoryCache) DecrementInt8(k string, n int8) (int8, error)

Decrement an item of type int8 by n. Returns an error if the item's value is not an int8, or if it was not found. If there is no error, the decremented value is returned.

func (MemoryCache) DecrementUint 

func (c MemoryCache) DecrementUint(k string, n uint) (uint, error)

Decrement an item of type uint by n. Returns an error if the item's value is not an uint, or if it was not found. If there is no error, the decremented value is returned.

func (MemoryCache) DecrementUint16 

func (c MemoryCache) DecrementUint16(k string, n uint16) (uint16, error)

Decrement an item of type uint16 by n. Returns an error if the item's value is not an uint16, or if it was not found. If there is no error, the decremented value is returned.

func (MemoryCache) DecrementUint32 

func (c MemoryCache) DecrementUint32(k string, n uint32) (uint32, error)

Decrement an item of type uint32 by n. Returns an error if the item's value is not an uint32, or if it was not found. If there is no error, the decremented value is returned.

func (MemoryCache) DecrementUint64 

func (c MemoryCache) DecrementUint64(k string, n uint64) (uint64, error)

Decrement an item of type uint64 by n. Returns an error if the item's value is not an uint64, or if it was not found. If there is no error, the decremented value is returned.

func (MemoryCache) DecrementUint8 

func (c MemoryCache) DecrementUint8(k string, n uint8) (uint8, error)

Decrement an item of type uint8 by n. Returns an error if the item's value is not an uint8, or if it was not found. If there is no error, the decremented value is returned.

func (MemoryCache) DecrementUintptr 

func (c MemoryCache) DecrementUintptr(k string, n uintptr) (uintptr, error)

Decrement an item of type uintptr by n. Returns an error if the item's value is not an uintptr, or if it was not found. If there is no error, the decremented value is returned.

func (MemoryCache) Delete 

func (c MemoryCache) Delete(k string)

Delete an item from the cache. Does nothing if the key is not in the cache.

func (MemoryCache) DeleteExpired 

func (c MemoryCache) DeleteExpired()

Delete all expired items from the cache.

func (MemoryCache) Flush 

func (c MemoryCache) Flush()

Delete all items from the cache.

func (MemoryCache) Get 

func (c MemoryCache) Get(k string) (interface{}, bool)

Get an item from the cache. Returns the item or nil, and a bool indicating whether the key was found.

func (MemoryCache) GetWithExpiration 

func (c MemoryCache) GetWithExpiration(k string) (interface{}, time.Time, bool)

GetWithExpiration returns an item and its expiration time from the cache. It returns the item or nil, the expiration time if one is set (if the item never expires a zero value for time.Time is returned), and a bool indicating whether the key was found.

func (MemoryCache) Increment 

func (c MemoryCache) Increment(k string, n int64) error

Increment an item of type int, int8, int16, int32, int64, uintptr, uint, uint8, uint32, or uint64, float32 or float64 by n. Returns an error if the item's value is not an integer, if it was not found, or if it is not possible to increment it by n. To retrieve the incremented value, use one of the specialized methods, e.g. IncrementInt64.

func (MemoryCache) IncrementFloat 

func (c MemoryCache) IncrementFloat(k string, n float64) error

Increment an item of type float32 or float64 by n. Returns an error if the item's value is not floating point, if it was not found, or if it is not possible to increment it by n. Pass a negative number to decrement the value. To retrieve the incremented value, use one of the specialized methods, e.g. IncrementFloat64.

func (MemoryCache) IncrementFloat32 

func (c MemoryCache) IncrementFloat32(k string, n float32) (float32, error)

Increment an item of type float32 by n. Returns an error if the item's value is not an float32, or if it was not found. If there is no error, the incremented value is returned.

func (MemoryCache) IncrementFloat64 

func (c MemoryCache) IncrementFloat64(k string, n float64) (float64, error)

Increment an item of type float64 by n. Returns an error if the item's value is not an float64, or if it was not found. If there is no error, the incremented value is returned.

func (MemoryCache) IncrementInt 

func (c MemoryCache) IncrementInt(k string, n int) (int, error)

Increment an item of type int by n. Returns an error if the item's value is not an int, or if it was not found. If there is no error, the incremented value is returned.

func (MemoryCache) IncrementInt16 

func (c MemoryCache) IncrementInt16(k string, n int16) (int16, error)

Increment an item of type int16 by n. Returns an error if the item's value is not an int16, or if it was not found. If there is no error, the incremented value is returned.

func (MemoryCache) IncrementInt32 

func (c MemoryCache) IncrementInt32(k string, n int32) (int32, error)

Increment an item of type int32 by n. Returns an error if the item's value is not an int32, or if it was not found. If there is no error, the incremented value is returned.

func (MemoryCache) IncrementInt64 

func (c MemoryCache) IncrementInt64(k string, n int64) (int64, error)

Increment an item of type int64 by n. Returns an error if the item's value is not an int64, or if it was not found. If there is no error, the incremented value is returned.

func (MemoryCache) IncrementInt8 

func (c MemoryCache) IncrementInt8(k string, n int8) (int8, error)

Increment an item of type int8 by n. Returns an error if the item's value is not an int8, or if it was not found. If there is no error, the incremented value is returned.

func (MemoryCache) IncrementUint 

func (c MemoryCache) IncrementUint(k string, n uint) (uint, error)

Increment an item of type uint by n. Returns an error if the item's value is not an uint, or if it was not found. If there is no error, the incremented value is returned.

func (MemoryCache) IncrementUint16 

func (c MemoryCache) IncrementUint16(k string, n uint16) (uint16, error)

Increment an item of type uint16 by n. Returns an error if the item's value is not an uint16, or if it was not found. If there is no error, the incremented value is returned.

func (MemoryCache) IncrementUint32 

func (c MemoryCache) IncrementUint32(k string, n uint32) (uint32, error)

Increment an item of type uint32 by n. Returns an error if the item's value is not an uint32, or if it was not found. If there is no error, the incremented value is returned.

func (MemoryCache) IncrementUint64 

func (c MemoryCache) IncrementUint64(k string, n uint64) (uint64, error)

Increment an item of type uint64 by n. Returns an error if the item's value is not an uint64, or if it was not found. If there is no error, the incremented value is returned.

func (MemoryCache) IncrementUint8 

func (c MemoryCache) IncrementUint8(k string, n uint8) (uint8, error)

Increment an item of type uint8 by n. Returns an error if the item's value is not an uint8, or if it was not found. If there is no error, the incremented value is returned.

func (MemoryCache) IncrementUintptr 

func (c MemoryCache) IncrementUintptr(k string, n uintptr) (uintptr, error)

Increment an item of type uintptr by n. Returns an error if the item's value is not an uintptr, or if it was not found. If there is no error, the incremented value is returned.

func (MemoryCache) ItemCount 

func (c MemoryCache) ItemCount() int

Returns the number of items in the cache. This may include items that have expired, but have not yet been cleaned up.

func (MemoryCache) Load 

func (c MemoryCache) Load(r io.Reader) error

Add (Gob-serialized) cache items from an io.Reader, excluding any items with keys that already exist (and haven't expired) in the current cache.

NOTE: This method is deprecated in favor of c.MemoryCacheItems() and NewFrom() (see the documentation for NewFrom().)

func (MemoryCache) LoadFile 

func (c MemoryCache) LoadFile(fname string) error

Load and add cache items from the given filename, excluding any items with keys that already exist in the current cache.

NOTE: This method is deprecated in favor of c.MemoryCacheItems() and NewFrom() (see the documentation for NewFrom().)

func (MemoryCache) MemoryCacheItems 

func (c MemoryCache) MemoryCacheItems() map[string]MemoryCacheItem

Copies all unexpired items in the cache into a new map and returns it.

func (MemoryCache) OnEvicted 

func (c MemoryCache) OnEvicted(f func(string, interface{}))

Sets an (optional) function that is called with the key and value when an item is evicted from the cache. (Including when it is deleted manually, but not when it is overwritten.) Set to nil to disable.

func (MemoryCache) Replace 

func (c MemoryCache) Replace(k string, x interface{}, d time.Duration) error

Set a new value for the cache key only if it already exists, and the existing item hasn't expired. Returns an error otherwise.

func (MemoryCache) Save 

func (c MemoryCache) Save(w io.Writer) (err error)

Write the cache's items (using Gob) to an io.Writer.

NOTE: This method is deprecated in favor of c.MemoryCacheItems() and NewFrom() (see the documentation for NewFrom().)

func (MemoryCache) SaveFile 

func (c MemoryCache) SaveFile(fname string) error

Save the cache's items to the given filename, creating the file if it doesn't exist, and overwriting it if it does.

NOTE: This method is deprecated in favor of c.MemoryCacheItems() and NewFrom() (see the documentation for NewFrom().)

func (MemoryCache) Set 

func (c MemoryCache) Set(k string, x interface{}, d time.Duration)

Add an item to the cache, replacing any existing item. If the duration is 0 (DefaultExpiration), the cache's default expiration time is used. If it is -1 (NoExpiration), the item never expires.

func (MemoryCache) SetDefault 

func (c MemoryCache) SetDefault(k string, x interface{})

Add an item to the cache, replacing any existing item, using the default expiration.

type MemoryCacheItem 

type MemoryCacheItem struct {
	Object     interface{}
	Expiration int64
}

func (MemoryCacheItem) Expired 

func (item MemoryCacheItem) Expired() bool

Expired returns true if the item has expired.

type RedisCache 

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

func NewRedisCache 

func NewRedisCache(cfg interface{}) *RedisCache

NewRedisCache returns a new redis cache object.

func Redis 

func Redis(id ...string) *RedisCache

Redis acquires a redis cache object associated the id, id default is : `default`

func (*RedisCache) Clear 

func (c *RedisCache) Clear() error

Clear all caches

func (*RedisCache) Decr 

func (c *RedisCache) Decr(key string) (val int64, err error)

Decr value by key

func (*RedisCache) DecrN 

func (c *RedisCache) DecrN(key string, n int64) (val int64, err error)

DecrN value N by key

func (*RedisCache) Del 

func (c *RedisCache) Del(key string) (err error)

Del value by key

func (*RedisCache) DelMulti 

func (c *RedisCache) DelMulti(keys []string) (err error)

DelMulti values by keys

func (*RedisCache) Get 

func (c *RedisCache) Get(key string) (val string, err error)

Get value by key

func (*RedisCache) GetMulti 

func (c *RedisCache) GetMulti(keys []string) (map[string]string, error)

GetMulti values by keys

func (*RedisCache) Has 

func (c *RedisCache) Has(key string) (bool, error)

Has cache key

func (*RedisCache) Incr 

func (c *RedisCache) Incr(key string) (val int64, err error)

Incr value by key

func (*RedisCache) IncrN 

func (c *RedisCache) IncrN(key string, n int64) (val int64, err error)

IncrN value N by key

func (*RedisCache) Pool 

func (c *RedisCache) Pool() *redis.Pool

func (*RedisCache) Set 

func (c *RedisCache) Set(key string, val string, ttl time.Duration) (err error)

Set value by key

func (*RedisCache) SetMulti 

func (c *RedisCache) SetMulti(values map[string]string, ttl time.Duration) (err error)

SetMulti values

func (*RedisCache) String 

func (c *RedisCache) String() string

String get

type RedisCacheConfig 

type RedisCacheConfig struct {
	Debug           bool
	Prefix          string
	Logger          gcore.Logger
	Addr            string
	Password        string
	DBNum           int
	MaxIdle         int
	MaxActive       int
	IdleTimeout     time.Duration
	Wait            bool
	MaxConnLifetime time.Duration
	Timeout         time.Duration
}

func NewRedisCacheConfig 

func NewRedisCacheConfig() *RedisCacheConfig

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.