cache01

Documentation

Index

• Constants
• type Cache
  • func NewCache(dir *CacheDir, filename string, cb func() ([]byte, error)) (*Cache, error)
  • func (self *Cache) GetFileName() string
  • func (self *Cache) GetValue() ([]byte, error)
  • func (self *Cache) SetValue(value []byte) error
• type CacheDir
  • func NewCacheDir(directory string, settings *Settings) (*CacheDir, error)
  • func (self *CacheDir) Cache(name string, cb func() ([]byte, error)) (*Cache, error)
  • func (self *CacheDir) GetCfgFileName() string
  • func (self *CacheDir) GetTimeout() (time.Duration, error)
  • func (self *CacheDir) SetTimeout(value time.Duration) error
• type Settings
  • func MakeDefaultSettings() *Settings

Constants

const FILENAME = "config.ini"

const KEY_NAME = "timeout"

const SECTION_NAME = "cache-cfg"

Types

type Cache

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

func NewCache

func NewCache(
	dir *CacheDir,
	filename string,

	cb func() ([]byte, error),
) (*Cache, error)

func (*Cache) GetFileName

func (self *Cache) GetFileName() string

func (*Cache) GetValue

func (self *Cache) GetValue() ([]byte, error)

func (*Cache) SetValue

func (self *Cache) SetValue(value []byte) error

type CacheDir

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

func NewCacheDir

func NewCacheDir(directory string, settings *Settings) (*CacheDir, error)

func (*CacheDir) Cache

func (self *CacheDir) Cache(name string, cb func() ([]byte, error)) (*Cache, error)

func (*CacheDir) GetCfgFileName

func (self *CacheDir) GetCfgFileName() string

func (*CacheDir) GetTimeout

func (self *CacheDir) GetTimeout() (time.Duration, error)

func (*CacheDir) SetTimeout

func (self *CacheDir) SetTimeout(value time.Duration) error

type Settings

type Settings struct {
	// disables the cache. cache files, though, should not be deleted until
	// CacheSingleFileLifetime passes
	PassThrough bool

	ListDirTimeout time.Duration
}

func MakeDefaultSettings

func MakeDefaultSettings() *Settings