cache

Documentation

Index

• Constants
• type List
  • func GetMockCacheList(ctx context.Context, langs []string) (*List, error)
• type NavigationCache
  • func NewNavigationCache(ctx context.Context, updateInterval *time.Duration) (*NavigationCache, error)
  • func (nc *NavigationCache) AddUpdateFunc(key string, updateFunc func() *models.Navigation)
  • func (nc *NavigationCache) GetCachingKeyForNavigationLanguage(lang string) string
  • func (nc *NavigationCache) GetNavigationData(ctx context.Context, lang string) (*models.Navigation, error)

Constants

const (
	// NavigationCacheKey is used to cache the navigation bar data
	NavigationCacheKey = "navigation-cache"
)

Types

type List

type List struct {
	Navigation *NavigationCache
}

List is a list of caches for the dp-frontend-dataset-controller

func GetMockCacheList

func GetMockCacheList(ctx context.Context, langs []string) (*List, error)

GetMockCacheList returns a mocked list of cache which contains the census topic cache and navigation cache

type NavigationCache

type NavigationCache struct {
	*dpcache.Cache
}

NavigationCache is a wrapper to dpcache.Cache which has additional fields and methods specifically for caching navigation data

func NewNavigationCache

func NewNavigationCache(ctx context.Context, updateInterval *time.Duration) (*NavigationCache, error)

NewNavigationCache create a navigation cache object to be used in the service which will update at every updateInterval If updateInterval is nil, this means that the cache will only be updated once at the start of the service

func (*NavigationCache) AddUpdateFunc

func (nc *NavigationCache) AddUpdateFunc(key string, updateFunc func() *models.Navigation)

AddUpdateFunc adds an update function to the cache

func (*NavigationCache) GetCachingKeyForNavigationLanguage

func (nc *NavigationCache) GetCachingKeyForNavigationLanguage(lang string) string

func (*NavigationCache) GetNavigationData

func (nc *NavigationCache) GetNavigationData(ctx context.Context, lang string) (*models.Navigation, error)