cache

Documentation

Overview

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

Index

• type Cache
  • func OpenCache(ctx context.Context, urlstr string) (Cache, error)
• 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
• type URLMux
  • func DefaultURLMux() *URLMux
  • func (mux *URLMux) OpenCache(ctx context.Context, urlstr string) (Cache, error)
  • func (mux *URLMux) Register(scheme string, opener URLOpener)
  • func (mux *URLMux) Schemes() []string
  • func (mux *URLMux) ValidScheme(scheme string) bool
• type URLOpener

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 OpenCache

func OpenCache(ctx context.Context, urlstr string) (Cache, error)

OpenCache opens a Cache identified by the URL given. See the URLOpener documentation in driver subpackages for details on supported URL formats, and https://gocloud.dev/concepts/urls for more information.

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
}

type URLMux

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

URLMux is a URL opener multiplexer. It matches the scheme of the URLs against a set of registered schemes and calls the opener that matches the URL's scheme. See https://gocloud.dev/concepts/urls/ for more information.

The zero value is a multiplexer with no registered schemes.

func DefaultURLMux

func DefaultURLMux() *URLMux

DefaultURLMux returns the URLMux used by OpenTopic and OpenSubscription.

Driver packages can use this to register their TopicURLOpener and/or SubscriptionURLOpener on the mux.

func (*URLMux) OpenCache

func (mux *URLMux) OpenCache(ctx context.Context, urlstr string) (Cache, error)

OpenCache calls OpenURL with the URL parsed from urlstr. OpenTopic is safe to call from multiple goroutines.

func (*URLMux) Register

func (mux *URLMux) Register(scheme string, opener URLOpener)

Register registers the opener with the given scheme. If an opener already exists for the scheme, Register panics.

func (*URLMux) Schemes

func (mux *URLMux) Schemes() []string

Schemes returns a sorted slice of the registered schemes.

func (*URLMux) ValidScheme

func (mux *URLMux) ValidScheme(scheme string) bool

ValidScheme returns true if scheme has been registered.

type URLOpener

type URLOpener interface {
	OpenURL(ctx context.Context, u *url.URL) (Cache, error)
}

URLOpener represents types than can open Registries based on a URL. The opener must not modify the URL argument. OpenURL must be safe to call from multiple goroutines.

This interface is generally implemented by types in driver packages.