mirror of
https://github.com/astaxie/beego.git
synced 2024-12-23 15:10:49 +00:00
75 lines
2.1 KiB
Go
75 lines
2.1 KiB
Go
// Beego (http://beego.me/)
|
|
//
|
|
// @description beego is an open-source, high-performance web framework for the Go programming language.
|
|
//
|
|
// @link http://github.com/astaxie/beego for the canonical source repository
|
|
//
|
|
// @license http://github.com/astaxie/beego/blob/master/LICENSE
|
|
//
|
|
// @authors astaxie
|
|
package cache
|
|
|
|
import (
|
|
"fmt"
|
|
)
|
|
|
|
// Cache interface contains all behaviors for cache adapter.
|
|
// usage:
|
|
// cache.Register("file",cache.NewFileCache()) // this operation is run in init method of file.go.
|
|
// c,err := cache.NewCache("file","{....}")
|
|
// c.Put("key",value,3600)
|
|
// v := c.Get("key")
|
|
//
|
|
// c.Incr("counter") // now is 1
|
|
// c.Incr("counter") // now is 2
|
|
// count := c.Get("counter").(int)
|
|
type Cache interface {
|
|
// get cached value by key.
|
|
Get(key string) interface{}
|
|
// set cached value with key and expire time.
|
|
Put(key string, val interface{}, timeout int64) error
|
|
// delete cached value by key.
|
|
Delete(key string) error
|
|
// increase cached int value by key, as a counter.
|
|
Incr(key string) error
|
|
// decrease cached int value by key, as a counter.
|
|
Decr(key string) error
|
|
// check if cached value exists or not.
|
|
IsExist(key string) bool
|
|
// clear all cache.
|
|
ClearAll() error
|
|
// start gc routine based on config string settings.
|
|
StartAndGC(config string) error
|
|
}
|
|
|
|
var adapters = make(map[string]Cache)
|
|
|
|
// Register makes a cache adapter available by the adapter name.
|
|
// If Register is called twice with the same name or if driver is nil,
|
|
// it panics.
|
|
func Register(name string, adapter Cache) {
|
|
if adapter == nil {
|
|
panic("cache: Register adapter is nil")
|
|
}
|
|
if _, ok := adapters[name]; ok {
|
|
panic("cache: Register called twice for adapter " + name)
|
|
}
|
|
adapters[name] = adapter
|
|
}
|
|
|
|
// Create a new cache driver by adapter name and config string.
|
|
// config need to be correct JSON as string: {"interval":360}.
|
|
// it will start gc automatically.
|
|
func NewCache(adapterName, config string) (adapter Cache, e error) {
|
|
adapter, ok := adapters[adapterName]
|
|
if !ok {
|
|
e = fmt.Errorf("cache: unknown adapter name %q (forgot to import?)", adapterName)
|
|
return
|
|
}
|
|
err := adapter.StartAndGC(config)
|
|
if err != nil {
|
|
adapter = nil
|
|
}
|
|
return
|
|
}
|