cache

Documentation

Overview

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

Index

• func DefaultBigCacheConfig() bigcache.Config
• type EventWithContext
• type EventsBatcher
  • func NewEventsBatcher(ctx context.Context, debounce time.Duration, idle time.Duration, max int, ...) *EventsBatcher
  • func (b *EventsBatcher) Start()
  • func (b *EventsBatcher) Stop()
• type InstrumentedCache
  • func NewInstrumentedCache(serviceName string, cacheConfig ...bigcache.Config) *InstrumentedCache
  • func (i *InstrumentedCache) Close()
  • func (i *InstrumentedCache) Set(key string, entry []byte) error
• type KeyMutex
  • func NewKeyMutex() *KeyMutex
  • func (km *KeyMutex) Lock(key string)
  • func (km *KeyMutex) Unlock(key string)

Functions

func DefaultBigCacheConfig

func DefaultBigCacheConfig() bigcache.Config

Types

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

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

func (*EventsBatcher) Stop

func (b *EventsBatcher) Stop()

Stop stops listening to incoming events

type InstrumentedCache

type InstrumentedCache struct {
	bigcache.BigCache
	// contains filtered or unexported fields
}

InstrumentedCache wraps BigCache with metrics

func NewInstrumentedCache

func NewInstrumentedCache(serviceName string, cacheConfig ...bigcache.Config) *InstrumentedCache

NewInstrumentedCache creates a BigCache instance with a regular report of statistics

func (*InstrumentedCache) Close

func (i *InstrumentedCache) Close()

Close stops internal timer for reporting statistics

func (*InstrumentedCache) Set

func (i *InstrumentedCache) Set(key string, entry []byte) error

Set adds a key/value to the cache.

type KeyMutex

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

KeyMutex allows locking resource by a unique ID instead of using a global lock

func NewKeyMutex

func NewKeyMutex() *KeyMutex

NewKeyMutex creates a new KeyMutex.

func (*KeyMutex) Lock

func (km *KeyMutex) Lock(key string)

Lock locks the KeyMutex by unique ID.

func (*KeyMutex) Unlock

func (km *KeyMutex) Unlock(key string)

Unlock unlocks the KeyMutex by unique ID.