cache

Documentation

Index

• func Fetch(ctx context.Context, ch chan<- FetcherResponse, name string, ...)
• type Cache
  • func (c *Cache) Get(name string) (entries []apiclient.APIResponse, found bool)
  • func (c *Cache) Run(ctx context.Context, interval time.Duration)
  • func (c *Cache) Stats() (stats map[string]int)
• type Fetcher
• type FetcherResponse
• type Holder

Functions

func Fetch

func Fetch(ctx context.Context, ch chan<- FetcherResponse, name string, g func(context.Context) ([]apiclient.APIResponse, error))

Fetch is a convenience function. It calls an API and sends the data back to the cache. If the API fails, the call will be retried maxRetries number of times

Types

type Cache

type Cache struct {
	Fetchers []Fetcher
	// contains filtered or unexported fields
}

Cache holds a list of measurements

func (*Cache) Get

func (c *Cache) Get(name string) (entries []apiclient.APIResponse, found bool)

Get retrieves a cached item

func (*Cache) Run

func (c *Cache) Run(ctx context.Context, interval time.Duration)

Run starts the cache and periodically pulls in new data

func (*Cache) Stats

func (c *Cache) Stats() (stats map[string]int)

Stats returns statistics on the cache

type Fetcher

type Fetcher interface {
	Update(ctx context.Context, ch chan<- FetcherResponse)
}

Fetcher interface contains all functions an API interface needs to implement to be used by Cache

type FetcherResponse

type FetcherResponse struct {
	Name     string
	Response []apiclient.APIResponse
}

FetcherResponse contains one update from a Fetcher

type Holder

type Holder interface {
	Get(name string) (entries []apiclient.APIResponse, found bool)
	Run(ctx context.Context, interval time.Duration)
	Stats() (stats map[string]int)
}

Holder interface contains all functions required to mock a Cache