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)
• type ActionKind
  • func (k ActionKind) String() string
• 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 FastCache
  • func NewFast(opt ...func(o *Options)) *FastCache
  • func (l *FastCache) Callback(h handler)
  • func (l *FastCache) Delete(key string)
  • func (l *FastCache) ForEach(walker func(key string, iface interface{}) bool)
  • func (l *FastCache) Get(key string) (interface{}, bool)
  • func (l *FastCache) GetBytes(key string) ([]byte, bool)
  • func (l *FastCache) ProvideGet(key string, provide func() (interface{}, bool), expiration ...time.Duration) (interface{}, bool)
  • func (l *FastCache) Set(key string, val interface{}, expiration ...time.Duration)
  • func (l *FastCache) SetBytes(key string, b []byte)
• 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) IntervalLifeSpan() bool
  • 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 Options
• 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) Set(key string, data interface{}, lifeSpanSecond 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) 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 Raw 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)

Types

type ActionKind

type ActionKind int

const (
	SET ActionKind = iota + 1
	GET
	DELETE
)

func (ActionKind) String

func (k ActionKind) String() string

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 FastCache

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

FastCache concurrent LRU cache structure

func NewFast

func NewFast(opt ...func(o *Options)) *FastCache

NewFast Fast LRU cache

func (*FastCache) Callback

func (l *FastCache) Callback(h handler)

Callback set callback function for cache

func (*FastCache) Delete

func (l *FastCache) Delete(key string)

Delete item by key from cache

func (*FastCache) ForEach

func (l *FastCache) ForEach(walker func(key string, iface interface{}) bool)

ForEach walk through all items in cache

func (*FastCache) Get

func (l *FastCache) Get(key string) (interface{}, bool)

Get value of key from cache with result

func (*FastCache) GetBytes

func (l *FastCache) GetBytes(key string) ([]byte, bool)

GetBytes value of key from cache with result

func (*FastCache) ProvideGet

func (l *FastCache) ProvideGet(key string, provide func() (interface{}, bool), expiration ...time.Duration) (interface{}, bool)

ProvideGet get value of key from cache with result and provide default value

func (*FastCache) Set

func (l *FastCache) Set(key string, val interface{}, expiration ...time.Duration)

Set an item into cache

func (*FastCache) SetBytes

func (l *FastCache) SetBytes(key string, b []byte)

SetBytes an item into cache

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) IntervalLifeSpan

func (item *Item) IntervalLifeSpan() bool

LifeSpan LifeSpan

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 Options

type Options struct {
	Callback   func(ActionKind, string, uintptr)
	Expiration time.Duration
	Bucket     uint16
	Cap        uint16
	LRU2Cap    uint16
}

type Table

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

Table Table

func New

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

Deprecated: please use zcache.NewFast 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 Raw 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 Raw of the specified key, set if it does not exist

func (*Table) Set

func (table *Table) Set(key string, data interface{}, lifeSpanSecond 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) SetRaw

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

SetRaw set cache