cache

Documentation

Overview

Package cache implements generic cache used throughout this application. By default it persists values to disk cache (using BadgerDB). Mainly the cache is used for STS Temporary Session Credentials and Yubikey OATH Application Password caching.

Index

• func Key(prefix string, checksum string) string
• type Cache
  • func (c *Cache) Close() error
  • func (c *Cache) Delete(key string) error
  • func (c *Cache) DeleteAll() error
  • func (c *Cache) DeleteByPrefix(keyPrefix string) error
  • func (c *Cache) Read(key string) ([]byte, error)
  • func (c *Cache) Write(key string, data []byte, ttl time.Duration) error
• type Repository
  • func New(cachePath string) Repository

Functions

func Key

func Key(prefix string, checksum string) string

Types

type Cache

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

Cache struct is used to define all the high-level repository methods, that internally call the low-level (disk cache) repository (which has the same interface to interact with BadgerDB).

func (*Cache) Close

func (c *Cache) Close() error

Close the cache connection.

func (*Cache) Delete

func (c *Cache) Delete(key string) error

Delete a value from cache.

func (*Cache) DeleteAll

func (c *Cache) DeleteAll() error

DeleteAll clears the whole cache.

func (*Cache) DeleteByPrefix

func (c *Cache) DeleteByPrefix(keyPrefix string) error

DeleteByPrefix clears all values with key prefix from cache.

func (*Cache) Read

func (c *Cache) Read(key string) ([]byte, error)

Read a value from cache.

func (*Cache) Write

func (c *Cache) Write(key string, data []byte, ttl time.Duration) error

Write a value to cache.

type Repository

type Repository interface {
	Write(key string, value []byte, ttl time.Duration) error
	Read(key string) ([]byte, error)
	Delete(key string) error
	DeleteByPrefix(keyPrefix string) error
	DeleteAll() error
	Close() error
}

Repository interface defines the methods that any cache implementation must implement.

func New

func New(cachePath string) Repository

Initializes a new (disk-based) cache.