cache

Documentation

Index

• func RegisterCache(reg CacheRegistration)
• func RegisteredCacheNames() []string
• type Cache
  • func ConstructCache(rawConfig map[string]interface{}, errorMessages config.ErrorMessages) (Cache, error)
• type CacheRegistration
  • func RegisteredCache(name string) (CacheRegistration, bool)
• type CacheWrapper
  • func (w CacheWrapper) Lookup(ctx context.Context, t pkg.TileRequest) (*pkg.Image, error)
  • func (w CacheWrapper) Save(ctx context.Context, t pkg.TileRequest, img *pkg.Image) error

Functions

func RegisterCache

func RegisterCache(reg CacheRegistration)

func RegisteredCacheNames

func RegisteredCacheNames() []string

Types

type Cache

type Cache interface {
	Lookup(ctx context.Context, t pkg.TileRequest) (*pkg.Image, error)
	Save(ctx context.Context, t pkg.TileRequest, img *pkg.Image) error
}

func ConstructCache

func ConstructCache(rawConfig map[string]interface{}, errorMessages config.ErrorMessages) (Cache, error)

type CacheRegistration

type CacheRegistration interface {
	Name() string
	Initialize(config any, errorMessages config.ErrorMessages) (Cache, error)
	InitializeConfig() any
}

func RegisteredCache

func RegisteredCache(name string) (CacheRegistration, bool)

type CacheWrapper

type CacheWrapper struct {
	Name  string
	Cache Cache
}

A struct that wraps all other caches in order to add in instrumentation, specifically child spans for tracing the requests to caches. This is used even when telemetry is disabled but OTEL handles no-op'ing in that case so performance impact is minimal

func (CacheWrapper) Lookup

func (w CacheWrapper) Lookup(ctx context.Context, t pkg.TileRequest) (*pkg.Image, error)

func (CacheWrapper) Save

func (w CacheWrapper) Save(ctx context.Context, t pkg.TileRequest, img *pkg.Image) error