cache

package

v0.4.6 Latest Latest Go to latest Published: Apr 10, 2024 License: AGPL-3.0 Imports: 24 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/admpub/webx

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func AddOptionParser(adapter string, parser func(cache.Options) (cache.Options, error))
func AdminRefreshable(ctx echo.Context, customer *dbschema.OfficialCustomer, ttl x.GetOption) x.GetOption
func Cache(ctx context.Context, args ...string) cache.Cache
func CacheNew(ctx context.Context, opts cache.Options, keys ...string) error
func CloseCache()
func Decr(ctx context.Context, key string, args ...string) error
func DefaultLockType() int32
func Delete(ctx context.Context, key string, args ...string) error
func Flush(ctx context.Context, args ...string) error
func GenOptions(ctx echo.Context, cacheSeconds int64) []x.GetOption
func Get(ctx context.Context, key string, recv interface{}, args ...string) error
func GetTTLByNumber(ttl int64, b x.GetOption) x.GetOption
func Incr(ctx context.Context, key string, args ...string) error
func IsDbAccount(v string) bool
func IsExist(ctx context.Context, key string, args ...string) (bool, error)
func NewDBCacher() factory.Cacher
func Put(ctx context.Context, key string, val interface{}, timeout int64, ...) error
func RedisClient() *redis.Client
func RedisMutex(key string, options ...redsync.Option) *redsync.Mutex
func RedisOptions() *redis.Options
func RedsyncClient() *redsync.Redsync
func RegisterTryLocker(t int32, fn TryLocker)
func SetDefaultLockType(lockType int32)
func TTLIf(condition bool, a x.GetOption, b x.GetOption) x.GetOption
func TTLIfCallback(condition func() bool, a x.GetOption, b x.GetOption) x.GetOption
func XFunc(ctx context.Context, key string, recv interface{}, fn func() error, ...) error
func XQuery(ctx context.Context, key string, recv interface{}, query x.Querier, ...) error
type QueryFunc
type TryLocker
type UnlockFunc
- func Lock(key string, types ...int32) (unlock UnlockFunc, err error)
- func TryLock(key string, types ...int32) (unlock UnlockFunc, err error)
- func TryLockWithContext(key string, ctx context.Context, types ...int32) (unlock UnlockFunc, err error)
- func TryLockWithTimeout(key string, timeout time.Duration, types ...int32) (unlock UnlockFunc, err error)

Constants ¶

View Source

const (
	CacheDisabled int64 = -1 // 禁用缓存
	CacheFresh    int64 = -2 // 强制缓存新数据
)

View Source

const (
	LockTypeMemory int32 = iota
	LockTypeRedis
)

Variables ¶

View Source

var (
	TTL               = x.TTL
	Query             = x.Query
	DisableCacheUsage = x.DisableCacheUsage
	UseFreshData      = x.UseFreshData
	Disabled          = DisableCacheUsage(true) // 禁用缓存
	Fresh             = UseFreshData(true)      // 强制缓存新数据
	Noop              = func(o *x.Options) {}
)

View Source

var DBCacher = NewDBCacher()

View Source

var ErrFailedToAcquireLock = errors.New("failed to acquire lock")

Functions ¶

func AddOptionParser ¶

func AddOptionParser(adapter string, parser func(cache.Options) (cache.Options, error))

func AdminRefreshable ¶

func AdminRefreshable(ctx echo.Context, customer *dbschema.OfficialCustomer, ttl x.GetOption) x.GetOption

func Cache ¶

func Cache(ctx context.Context, args ...string) cache.Cache

func CacheNew ¶

func CacheNew(ctx context.Context, opts cache.Options, keys ...string) error

func CloseCache ¶ added in v0.0.2

func CloseCache()

func Decr ¶

func Decr(ctx context.Context, key string, args ...string) error

Decr 自减

func DefaultLockType ¶

func DefaultLockType() int32

func Delete ¶

func Delete(ctx context.Context, key string, args ...string) error

Delete 删除缓存

func Flush ¶

func Flush(ctx context.Context, args ...string) error

Flush 删除所有缓存数据

func GenOptions ¶

func GenOptions(ctx echo.Context, cacheSeconds int64) []x.GetOption

func Get ¶

func Get(ctx context.Context, key string, recv interface{}, args ...string) error

Get 获取缓存

func GetTTLByNumber ¶ added in v0.4.4

func GetTTLByNumber(ttl int64, b x.GetOption) x.GetOption

func Incr ¶

func Incr(ctx context.Context, key string, args ...string) error

Incr 自增

func IsDbAccount ¶

func IsDbAccount(v string) bool

func IsExist ¶

func IsExist(ctx context.Context, key string, args ...string) (bool, error)

IsExist 是否存在缓存

func NewDBCacher ¶

func NewDBCacher() factory.Cacher

func Put ¶

func Put(ctx context.Context, key string, val interface{}, timeout int64, args ...string) error

Put 设置缓存

func RedisClient ¶

func RedisClient() *redis.Client

func RedisMutex ¶

func RedisMutex(key string, options ...redsync.Option) *redsync.Mutex

RedisMutex 分布式锁 example: mutex := RedisMutex(`goods_1`) err = mutex.Lock(ctx)

if err != nil {
	panic(err)
}

mutex.Unlock(ctx)

func RedisOptions ¶

func RedisOptions() *redis.Options

func RedsyncClient ¶

func RedsyncClient() *redsync.Redsync

func RegisterTryLocker ¶

func RegisterTryLocker(t int32, fn TryLocker)

func SetDefaultLockType ¶

func SetDefaultLockType(lockType int32)

func TTLIf ¶ added in v0.1.9

func TTLIf(condition bool, a x.GetOption, b x.GetOption) x.GetOption

func TTLIfCallback ¶ added in v0.1.9

func TTLIfCallback(condition func() bool, a x.GetOption, b x.GetOption) x.GetOption

func XFunc ¶

func XFunc(ctx context.Context, key string, recv interface{}, fn func() error, options ...x.GetOption) error

XFunc 获取缓存，如果不存在则执行函数获取数据并缓存【自动避免缓存穿透】

func XQuery ¶

func XQuery(ctx context.Context, key string, recv interface{}, query x.Querier, options ...x.GetOption) error

XQuery 获取缓存，如果不存在则执行函数获取数据并缓存【自动避免缓存穿透】

Types ¶

type QueryFunc ¶

type QueryFunc = x.QueryFunc

type TryLocker ¶

type TryLocker interface {
	Lock(key string) (unlock UnlockFunc, err error)
	TryLock(key string) (unlock UnlockFunc, err error)
	TryLockWithTimeout(key string, timeout time.Duration) (unlock UnlockFunc, err error)
	TryLockWithContext(key string, ctx context.Context) (unlock UnlockFunc, err error)
}

type UnlockFunc ¶

type UnlockFunc func() error

func Lock ¶

func Lock(key string, types ...int32) (unlock UnlockFunc, err error)

func TryLock ¶

func TryLock(key string, types ...int32) (unlock UnlockFunc, err error)

func TryLockWithContext ¶

func TryLockWithContext(key string, ctx context.Context, types ...int32) (unlock UnlockFunc, err error)

func TryLockWithTimeout ¶

func TryLockWithTimeout(key string, timeout time.Duration, types ...int32) (unlock UnlockFunc, err error)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL