cache

Documentation

Overview

Package cache provides ready-to-use in-memory cache mechanisms

Index

• func DefaultBigCacheConfig() bigcache.Config
• type Cache
  • func NewSharded(identifier string, opts ...Option) Cache
  • func NewShort(opts ...Option) Cache
• type EventWithContext
• type EventsBatcher
  • func NewEventsBatcher(ctx context.Context, debounce time.Duration, idle time.Duration, max int, ...) *EventsBatcher
  • func (b *EventsBatcher) Start()
• type InstrumentedCache
  • func (i *InstrumentedCache) Close() error
  • func (i *InstrumentedCache) Delete(key string) error
  • func (i *InstrumentedCache) KeysByPrefix(prefix string) (res []string, e error)
  • func (i *InstrumentedCache) Reset() error
  • func (i *InstrumentedCache) Set(key string, entry interface{}) error
• type Option
  • func WithCleanWindow(t time.Duration) Option
  • func WithEviction(t time.Duration) Option
• type Options

Functions

func DefaultBigCacheConfig

func DefaultBigCacheConfig() bigcache.Config

Types

type Cache

type Cache interface {
	Get(key string) (value interface{}, ok bool)
	GetBytes(key string) (value []byte, ok bool)
	Set(key string, value interface{}) error
	SetWithExpiry(key string, value interface{}, duration time.Duration) error
	Delete(k string) error
	Reset() error
	KeysByPrefix(prefix string) ([]string, error)
	Iterate(it func(key string, val interface{})) error
	Close() error
}

func NewSharded

func NewSharded(identifier string, opts ...Option) Cache

NewSharded creates a cache instance instrumented with a regular report of statistics

func NewShort

func NewShort(opts ...Option) Cache

type EventWithContext

type EventWithContext struct {
	*tree.NodeChangeEvent
	Ctx context.Context
}

EventWithContext composes a NodeChangeEvent and a context

type EventsBatcher

type EventsBatcher struct {
	Events chan *EventWithContext
	Done   chan bool
	// contains filtered or unexported fields
}

EventsBatcher debounces events on a given timeframe and calls process on them afterward Use globalCtx.Done() to stop listening to events

func NewEventsBatcher

func NewEventsBatcher(ctx context.Context, debounce time.Duration, idle time.Duration, max int, atomic bool, process func(context.Context, ...*tree.NodeChangeEvent)) *EventsBatcher

NewEventsBatcher initializes a new EventsBatcher

func (*EventsBatcher) Start

func (b *EventsBatcher) Start()

Start starts listening to incoming events

type InstrumentedCache

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

InstrumentedCache wraps BigCache with metrics

func (*InstrumentedCache) Close

func (i *InstrumentedCache) Close() error

Close stops internal timer for reporting statistics

func (*InstrumentedCache) Delete

func (i *InstrumentedCache) Delete(key string) error

func (*InstrumentedCache) KeysByPrefix

func (i *InstrumentedCache) KeysByPrefix(prefix string) (res []string, e error)

func (*InstrumentedCache) Reset

func (i *InstrumentedCache) Reset() error

func (*InstrumentedCache) Set

func (i *InstrumentedCache) Set(key string, entry interface{}) error

Set adds a key/value to the cache.

type Option

type Option func(o *Options)

func WithCleanWindow

func WithCleanWindow(t time.Duration) Option

func WithEviction

func WithEviction(t time.Duration) Option

type Options

type Options struct {
	EvictionTime time.Duration
	CleanWindow  time.Duration
}