cache

Documentation

Index

• type Cache
  • func New(log *logrus.Entry, timeout time.Duration, handler Handler) *Cache
  • func (c *Cache) Delete(index string)
  • func (c *Cache) Get(ctx context.Context, index string, fetchIndex string, opts *api.Options) (item interface{}, err error)
  • func (c *Cache) Shutdown()
  • func (c *Cache) Update(index string, item interface{})
• type Handler

Types

type Cache

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

Cache is a generic cache store - that supports a handler

func New

func New(log *logrus.Entry, timeout time.Duration, handler Handler) *Cache

New returns a new generic Cache.

func (*Cache) Delete

func (c *Cache) Delete(index string)

func (*Cache) Get

func (c *Cache) Get(ctx context.Context, index string, fetchIndex string, opts *api.Options) (item interface{}, err error)

Get returns the cache item from the store given the index. Will populate the cache if the index does not currently exist.

func (*Cache) Shutdown

func (c *Cache) Shutdown()

func (*Cache) Update

func (c *Cache) Update(index string, item interface{})

type Handler

type Handler interface {
	// Fetch should fetch an item by the given index and options
	Fetch(ctx context.Context, index string, opts *api.Options) (interface{}, error)
}

Handler is an interface for implementations of the cache fetch.