bbolt

Documentation

Overview

Package bbolt is the bbolt implementation of the Trickster Cache

Index

• func New(fileName, bucketName string) (cache.Cache, error)
• type Cache
  • func (c *Cache) BulkRemove(cacheKeys []string)
  • func (c *Cache) Close() error
  • func (c *Cache) Configuration() *options.Options
  • func (c *Cache) Connect() error
  • func (c *Cache) Locker() locks.NamedLocker
  • func (c *Cache) Remove(cacheKey string)
  • func (c *Cache) Retrieve(cacheKey string, allowExpired bool) ([]byte, status.LookupStatus, error)
  • func (c *Cache) SetLocker(l locks.NamedLocker)
  • func (c *Cache) SetTTL(cacheKey string, ttl time.Duration)
  • func (c *Cache) Store(cacheKey string, data []byte, ttl time.Duration) error

Functions

func New

func New(fileName, bucketName string) (cache.Cache, error)

New returns a new bbolt cache as a Trickster Cache Interface type

Types

type Cache

type Cache struct {
	Name   string
	Config *options.Options
	Logger interface{}
	Index  *index.Index
	// contains filtered or unexported fields
}

Cache describes a BBolt Cache

func (*Cache) BulkRemove

func (c *Cache) BulkRemove(cacheKeys []string)

BulkRemove removes a list of objects from the cache

func (*Cache) Close

func (c *Cache) Close() error

Close closes the Cache

func (*Cache) Configuration

func (c *Cache) Configuration() *options.Options

Configuration returns the Configuration for the Cache object

func (*Cache) Connect

func (c *Cache) Connect() error

Connect instantiates the Cache mutex map and starts the Expired Entry Reaper goroutine

func (*Cache) Locker

func (c *Cache) Locker() locks.NamedLocker

Locker returns the cache's locker

func (*Cache) Remove

func (c *Cache) Remove(cacheKey string)

Remove removes an object in cache, if present

func (*Cache) Retrieve

func (c *Cache) Retrieve(cacheKey string, allowExpired bool) ([]byte, status.LookupStatus, error)

Retrieve looks for an object in cache and returns it (or an error if not found)

func (*Cache) SetLocker

func (c *Cache) SetLocker(l locks.NamedLocker)

SetLocker sets the cache's locker

func (*Cache) SetTTL

func (c *Cache) SetTTL(cacheKey string, ttl time.Duration)

SetTTL updates the TTL for the provided cache object

func (*Cache) Store

func (c *Cache) Store(cacheKey string, data []byte, ttl time.Duration) error

Store places an object in the cache using the specified key and ttl