cache

Documentation

Overview

Policy cache package maintains local a local copy of all romana policies and provides updates when a policy added/deleted/modified. Useful for the clients who lists entire policy storage often.

Index

• type Cache
  • func (c *Cache) List() []common.Policy
  • func (c *Cache) Run(stop <-chan struct{}) <-chan string
• type Config
• type Interface
  • func New(client *common.RestClient, config Config) Interface

Types

type Cache

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

Cache implements Interface.

func (*Cache) List

func (c *Cache) List() []common.Policy

List implements Interface.

func (*Cache) Run

func (c *Cache) Run(stop <-chan struct{}) <-chan string

Run implements Interface.

type Config

type Config struct {
	// CacheTickSeconds is a delay before attempts to refresh the cache.
	CacheTickSeconds int
}

Config represents configuration for the policy cache.

type Interface

type Interface interface {
	// Run starts main loop that synchronizes internal cache
	// with Policy service periodically and generates
	// notification if cache was updated.
	Run(stop <-chan struct{}) <-chan string

	// List returns a list of all romana policies in a cache.
	List() []common.Policy
}

Interface defines policy cache behavior.

func New

func New(client *common.RestClient, config Config) Interface

New creates new policy cache.