piececache

Documentation

Index

• type Cache
  • func New(maxSize int64, ttl time.Duration, parallelReads uint) *Cache
  • func (c *Cache) Clear()
  • func (c *Cache) Close()
  • func (c *Cache) Get(key string, loader Loader) ([]byte, error)
  • func (c *Cache) Len() int
  • func (c *Cache) LoadsActive() int
  • func (c *Cache) LoadsWaiting() int
  • func (c *Cache) Size() int64
  • func (c *Cache) Utilization() int
• type Loader

Types

type Cache

type Cache struct {
	NumCached      metrics.Meter
	NumTotal       metrics.Meter
	NumLoad        metrics.Meter
	NumLoadedBytes metrics.Meter
	// contains filtered or unexported fields
}

Cache is a LRU piece cache of certain size. Items in the cache are expired after the defined TTL.

func New

func New(maxSize int64, ttl time.Duration, parallelReads uint) *Cache

New returns new Cache.

func (*Cache) Clear

func (c *Cache) Clear()

Clear the cache. Drops all items in cache.

func (*Cache) Close

func (c *Cache) Close()

Close the cache and release all resources.

func (*Cache) Get

func (c *Cache) Get(key string, loader Loader) ([]byte, error)

Get item with the key from cache. If item is not in cache, load by calling `loader` func and put into the cache.

func (*Cache) Len

func (c *Cache) Len() int

Len returns the number of items in the cache. Items may be in different sizes.

func (*Cache) LoadsActive

func (c *Cache) LoadsActive() int

LoadsActive returns the number of active Loader calls.

func (*Cache) LoadsWaiting

func (c *Cache) LoadsWaiting() int

LoadsWaiting returns the number of waiting Loader calls.

func (*Cache) Size

func (c *Cache) Size() int64

Size returns the total size of the items in the cache.

func (*Cache) Utilization

func (c *Cache) Utilization() int

Utilization is a number between 0 and 100 that returns the hit-ratio of the cache.

type Loader

type Loader func() ([]byte, error)

Loader is a function that loads data from a piece.