cache

package
Version: v0.3.4 Latest Latest
Warning

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

Go to latest
Published: May 10, 2015 License: MIT Imports: 4 Imported by: 0

Documentation

Overview

Package cache provides interface and implementation of a cache algorithms.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Cache

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

Cache is a 'cache map'.

func NewCache added in v0.3.2

func NewCache(cacher Cacher) *Cache

NewCache creates a new 'cache map'. The cacher is optional and may be nil.

func (*Cache) Capacity

func (r *Cache) Capacity() int

Capacity returns cache capacity.

func (*Cache) Close added in v0.3.2

func (r *Cache) Close() error

Close closes the 'cache map' and releases all 'cache node'.

func (*Cache) Delete added in v0.3.2

func (r *Cache) Delete(ns, key uint64, onDel func()) bool

Delete removes and ban 'cache node' with the given namespace and key. A banned 'cache node' will never inserted into the 'cache tree'. Ban only attributed to the particular 'cache node', so when a 'cache node' is recreated it will not be banned.

If onDel is not nil, then it will be executed if such 'cache node' doesn't exist or once the 'cache node' is released.

Delete return true is such 'cache node' exist.

func (*Cache) Evict added in v0.3.2

func (r *Cache) Evict(ns, key uint64) bool

Evict evicts 'cache node' with the given namespace and key. This will simply call Cacher.Evict.

Evict return true is such 'cache node' exist.

func (*Cache) EvictAll added in v0.3.2

func (r *Cache) EvictAll()

EvictAll evicts all 'cache node'. This will simply call Cacher.EvictAll.

func (*Cache) EvictNS added in v0.3.2

func (r *Cache) EvictNS(ns uint64)

EvictNS evicts 'cache node' with the given namespace. This will simply call Cacher.EvictNS.

func (*Cache) Get added in v0.3.2

func (r *Cache) Get(ns, key uint64, setFunc func() (size int, value Value)) *Handle

Get gets 'cache node' with the given namespace and key. If cache node is not found and setFunc is not nil, Get will atomically creates the 'cache node' by calling setFunc. Otherwise Get will returns nil.

The returned 'cache handle' should be released after use by calling Release method.

func (*Cache) Nodes added in v0.3.2

func (r *Cache) Nodes() int

Nodes returns number of 'cache node' in the map.

func (*Cache) SetCapacity

func (r *Cache) SetCapacity(capacity int)

SetCapacity sets cache capacity.

func (*Cache) Size

func (r *Cache) Size() int

Size returns sums of 'cache node' size in the map.

type CacheGetter added in v0.3.2

type CacheGetter struct {
	Cache *Cache
	NS    uint64
}

func (*CacheGetter) Get added in v0.3.2

func (g *CacheGetter) Get(key uint64, setFunc func() (size int, value Value)) *Handle

type Cacher added in v0.3.2

type Cacher interface {
	// Capacity returns cache capacity.
	Capacity() int

	// SetCapacity sets cache capacity.
	SetCapacity(capacity int)

	// Promote promotes the 'cache node'.
	Promote(n *Node)

	// Ban evicts the 'cache node' and prevent subsequent 'promote'.
	Ban(n *Node)

	// Evict evicts the 'cache node'.
	Evict(n *Node)

	// EvictNS evicts 'cache node' with the given namespace.
	EvictNS(ns uint64)

	// EvictAll evicts all 'cache node'.
	EvictAll()

	// Close closes the 'cache tree'
	Close() error
}

Cacher provides interface to implements a caching functionality. An implementation must be goroutine-safe.

func NewLRU added in v0.3.2

func NewLRU(capacity int) Cacher

NewLRU create a new LRU-cache.

type Handle

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

func (*Handle) Release

func (h *Handle) Release()

func (*Handle) Value

func (h *Handle) Value() Value

type Node added in v0.3.2

type Node struct {
	CacheData unsafe.Pointer
	// contains filtered or unexported fields
}

Node is a 'cache node'.

func (*Node) GetHandle added in v0.3.2

func (n *Node) GetHandle() *Handle

GetHandle returns an handle for this 'cache node'.

func (*Node) Key added in v0.3.2

func (n *Node) Key() uint64

Key returns this 'cache node' key.

func (*Node) NS added in v0.3.2

func (n *Node) NS() uint64

NS returns this 'cache node' namespace.

func (*Node) Ref added in v0.3.2

func (n *Node) Ref() int32

Ref returns this 'cache node' ref counter.

func (*Node) Size added in v0.3.2

func (n *Node) Size() int

Size returns this 'cache node' size.

func (*Node) Value added in v0.3.2

func (n *Node) Value() Value

Value returns this 'cache node' value.

type Value added in v0.3.2

type Value interface{}

Value is a 'cacheable object'. It may implements util.Releaser, if so the the Release method will be called once object is released.

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL