zcache

Documentation

Overview

Package zcache cache operation

Index

• Variables
• func Clear()
• func Get(key string) (value interface{}, err error)
• func GetInt(key string) (value int, err error)
• func GetString(key string) (value string, err error)
• func MustGet(key string, ...) (data interface{}, err error)
• func Set(key string, data interface{}, lifeSpan uint, interval ...bool)
• func SetDeleteCallback(fn func(key string) bool)
• func SetLogger(logger *zlog.Logger)
• type CacheItemPair
• type CacheItemPairList
  • func (p CacheItemPairList) Len() int
  • func (p CacheItemPairList) Less(i, j int) bool
  • func (p CacheItemPairList) Swap(i, j int)
• type Item
  • func Delete(key string) (*Item, error)
  • func GetT(key string) (*Item, error)
  • func NewCacheItem(key string, data interface{}, lifeSpan time.Duration) *Item
  • func (item *Item) AccessCount() int64
  • func (item *Item) AccessedTime() time.Time
  • func (item *Item) CreatedTime() time.Time
  • func (item *Item) Data() interface{}
  • func (item *Item) Key() interface{}
  • func (item *Item) LifeSpan() time.Duration
  • func (item *Item) LifeSpanUint() uint
  • func (item *Item) RemainingLife() time.Duration
  • func (item *Item) SetDeleteCallback(fn func(key string) bool)
• type Table
  • func New(table string, accessCount ...bool) *Table
  • func (table *Table) Add(key string, data interface{}, lifeSpan time.Duration, intervalLifeSpan ...bool) bool
  • func (table *Table) Clear()
  • func (table *Table) Count() int
  • func (table *Table) Delete(key string) (*Item, error)
  • func (table *Table) Exists(key string) bool
  • func (table *Table) ForEach(trans func(key string, value interface{}) bool)
  • func (table *Table) ForEachRaw(trans func(key string, value *Item) bool)
  • func (table *Table) Get(key string, args ...interface{}) (value interface{}, err error)
  • func (table *Table) GetInt(key string, args ...interface{}) (value int, err error)
  • func (table *Table) GetString(key string, args ...interface{}) (value string, err error)
  • func (table *Table) GetT(key string, args ...interface{}) (*Item, error)
  • func (table *Table) MostAccessed(count int64) []*Item
  • func (table *Table) MustGet(key string, ...) (data interface{}, err error)
  • func (table *Table) PersistenceToFile(file string, DisableAutoLoad bool, register ...interface{}) func() error
  • func (table *Table) Set(key string, data interface{}, lifeSpan uint, interval ...bool) *Item
  • func (table *Table) SetAddCallback(f func(*Item))
  • func (table *Table) SetDeleteCallback(f func(key string) bool)
  • func (table *Table) SetLoadNotCallback(f func(key string, args ...interface{}) *Item)
  • func (table *Table) SetLogger(logger *zlog.Logger)
  • func (table *Table) SetRaw(key string, data interface{}, lifeSpan time.Duration, intervalLifeSpan ...bool) *Item

Variables

var (
	// ErrKeyNotFound ErrKeyNotFound
	ErrKeyNotFound = errors.New("key is not in cache")
	// ErrKeyNotFoundAndNotCallback ErrKeyNotFoundAndNotCallback
	ErrKeyNotFoundAndNotCallback = errors.New("key is not in cache and no callback is set")
)

Functions

func Clear

func Clear()

func Get

func Get(key string) (value interface{}, err error)

func GetInt

func GetInt(key string) (value int, err error)

func GetString

func GetString(key string) (value string, err error)

func MustGet

func MustGet(key string, do func(set func(data interface{},
	lifeSpan time.Duration, interval ...bool)) (
	err error)) (data interface{}, err error)

MustGet get the data of the specified key, set if it does not exist

func Set

func Set(key string, data interface{}, lifeSpan uint, interval ...bool)

func SetDeleteCallback

func SetDeleteCallback(fn func(key string) bool)

func SetLogger

func SetLogger(logger *zlog.Logger)

Types

type CacheItemPair

type CacheItemPair struct {
	Key         string
	AccessCount int64
}

CacheItemPair maps key to access counter

type CacheItemPairList

type CacheItemPairList []CacheItemPair

CacheItemPairList CacheItemPairList

func (CacheItemPairList) Len

func (p CacheItemPairList) Len() int

func (CacheItemPairList) Less

func (p CacheItemPairList) Less(i, j int) bool

func (CacheItemPairList) Swap

func (p CacheItemPairList) Swap(i, j int)

type Item

type Item struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Item Item

func Delete

func Delete(key string) (*Item, error)

func GetT

func GetT(key string) (*Item, error)

func NewCacheItem

func NewCacheItem(key string, data interface{}, lifeSpan time.Duration) *Item

NewCacheItem NewCacheItem

func (*Item) AccessCount

func (item *Item) AccessCount() int64

AccessCount AccessCount

func (*Item) AccessedTime

func (item *Item) AccessedTime() time.Time

AccessedTime AccessedTime

func (*Item) CreatedTime

func (item *Item) CreatedTime() time.Time

CreatedTime CreatedTime

func (*Item) Data

func (item *Item) Data() interface{}

Data data

func (*Item) Key

func (item *Item) Key() interface{}

Key item key

func (*Item) LifeSpan

func (item *Item) LifeSpan() time.Duration

LifeSpan LifeSpan

func (*Item) LifeSpanUint

func (item *Item) LifeSpanUint() uint

LifeSpanUint LifeSpanUint

func (*Item) RemainingLife

func (item *Item) RemainingLife() time.Duration

RemainingLife RemainingLife

func (*Item) SetDeleteCallback

func (item *Item) SetDeleteCallback(fn func(key string) bool)

SetDeleteCallback SetDeleteCallback

type Table

type Table struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Table Table

func New

func New(table string, accessCount ...bool) *Table

New new cache

func (*Table) Add

func (table *Table) Add(key string, data interface{}, lifeSpan time.Duration, intervalLifeSpan ...bool) bool

Add if the cache does not exist then adding does not take effect

func (*Table) Clear

func (table *Table) Clear()

Clear Clear

func (*Table) Count

func (table *Table) Count() int

Count get the number of caches

func (*Table) Delete

func (table *Table) Delete(key string) (*Item, error)

Delete Delete cache

func (*Table) Exists

func (table *Table) Exists(key string) bool

Exists Exists

func (*Table) ForEach

func (table *Table) ForEach(trans func(key string, value interface{}) bool)

ForEach traversing the cache

func (*Table) ForEachRaw

func (table *Table) ForEachRaw(trans func(key string, value *Item) bool)

ForEachRaw traversing the cache

func (*Table) Get

func (table *Table) Get(key string, args ...interface{}) (value interface{}, err error)

Get get the data of the specified key

func (*Table) GetInt

func (table *Table) GetInt(key string, args ...interface{}) (value int, err error)

func (*Table) GetString

func (table *Table) GetString(key string, args ...interface{}) (value string, err error)

func (*Table) GetT

func (table *Table) GetT(key string, args ...interface{}) (*Item, error)

GetT GetT

func (*Table) MostAccessed

func (table *Table) MostAccessed(count int64) []*Item

MostAccessed MostAccessed

func (*Table) MustGet

func (table *Table) MustGet(key string, do func(set func(data interface{},
	lifeSpan time.Duration, interval ...bool)) (
	err error)) (data interface{}, err error)

MustGet get the data of the specified key, set if it does not exist

func (*Table) PersistenceToFile

func (table *Table) PersistenceToFile(file string, DisableAutoLoad bool, register ...interface{}) func() error

func (*Table) Set

func (table *Table) Set(key string, data interface{}, lifeSpan uint,
	interval ...bool) *Item

Set set cache whether to automatically renew

func (*Table) SetAddCallback

func (table *Table) SetAddCallback(f func(*Item))

SetAddCallback SetAddCallback

func (*Table) SetDeleteCallback

func (table *Table) SetDeleteCallback(f func(key string) bool)

SetDeleteCallback SetDeleteCallback

func (*Table) SetLoadNotCallback

func (table *Table) SetLoadNotCallback(f func(key string, args ...interface{}) *Item)

SetLoadNotCallback SetLoadNotCallback

func (*Table) SetLogger

func (table *Table) SetLogger(logger *zlog.Logger)

SetLogger SetLogger

func (*Table) SetRaw

func (table *Table) SetRaw(key string, data interface{}, lifeSpan time.Duration,
	intervalLifeSpan ...bool) *Item

SetRaw set cache