cache

Documentation

Overview

Package cache defines the Trickster cache interfaces and provides general cache functionality

Index

• Variables
• type Cache
• type MemoryCache
• type ReferenceObject

Variables

var ErrKNF = errors.New("key not found in cache")

ErrKNF represents the error "key not found in cache"

Types

type Cache

type Cache interface {
	Connect() error
	Store(cacheKey string, data []byte, ttl time.Duration) error
	Retrieve(cacheKey string, allowExpired bool) ([]byte, status.LookupStatus, error)
	SetTTL(cacheKey string, ttl time.Duration)
	Remove(cacheKey string)
	BulkRemove(cacheKeys []string)
	Close() error
	Configuration() *options.Options
	Locker() locks.NamedLocker
	SetLocker(locks.NamedLocker)
}

Cache is the interface for the supported caching fabrics When making new cache providers, Retrieve() must return an error on cache miss

type MemoryCache

type MemoryCache interface {
	Connect() error
	Store(cacheKey string, data []byte, ttl time.Duration) error
	Retrieve(cacheKey string, allowExpired bool) ([]byte, status.LookupStatus, error)
	SetTTL(cacheKey string, ttl time.Duration)
	Remove(cacheKey string)
	BulkRemove(cacheKeys []string)
	Close() error
	Configuration() *options.Options
	StoreReference(cacheKey string, data ReferenceObject, ttl time.Duration) error
	RetrieveReference(cacheKey string, allowExpired bool) (interface{}, status.LookupStatus, error)
	Locker() locks.NamedLocker
	SetLocker(locks.NamedLocker)
}

MemoryCache is the interface for an in-memory cache This offers an additional method for storing references to bypass serialization

type ReferenceObject

type ReferenceObject interface {
	Size() int
}

ReferenceObject defines an interface for a cache object possessing the ability to report the approximate comprehensive byte size of its members, to assist with cache size management