cache

Documentation

Index

• func Register(cacheType string, init InitFunc) error
• func Registered() (c []string)
• type ErrGettingFromCache
  • func (e ErrGettingFromCache) Error() string
• type ErrInvalidFileKey
  • func (e ErrInvalidFileKey) Error() string
• type ErrInvalidFileKeyParts
  • func (e ErrInvalidFileKeyParts) Error() string
• type ErrPurgingCache
  • func (e ErrPurgingCache) Error() string
• type ErrSettingToCache
  • func (e ErrSettingToCache) Error() string
• type InitFunc
• type Interface
  • func For(cacheType string, config dict.Dicter) (Interface, error)
• type Key
  • func ParseKey(str string) (*Key, error)
  • func (k Key) String() string
• type Wrapped

Functions

func Register

func Register(cacheType string, init InitFunc) error

Register is called by the init functions of the cache.

func Registered

func Registered() (c []string)

Registered returns the cache's that have been registered.

Types

type ErrGettingFromCache

type ErrGettingFromCache struct {
	Err       error
	CacheType string
}

func (ErrGettingFromCache) Error

func (e ErrGettingFromCache) Error() string

type ErrInvalidFileKey

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

func (ErrInvalidFileKey) Error

func (e ErrInvalidFileKey) Error() string

type ErrInvalidFileKeyParts

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

func (ErrInvalidFileKeyParts) Error

func (e ErrInvalidFileKeyParts) Error() string

type ErrPurgingCache

type ErrPurgingCache struct {
	Err       error
	CacheType string
}

func (ErrPurgingCache) Error

func (e ErrPurgingCache) Error() string

type ErrSettingToCache

type ErrSettingToCache struct {
	Err       error
	CacheType string
}

func (ErrSettingToCache) Error

func (e ErrSettingToCache) Error() string

type InitFunc

type InitFunc func(dict.Dicter) (Interface, error)

InitFunc initialize a cache given a config map. The InitFunc should validate the config map, and report any errors. This is called by the For function.

type Interface

type Interface interface {
	Get(key *Key) (val []byte, hit bool, err error)
	Set(key *Key, val []byte) error
	Purge(key *Key) error
}

Interface defines a cache back end

func For

func For(cacheType string, config dict.Dicter) (Interface, error)

For function returns a configured cache of the given type, provided the correct config map.

type Key

type Key struct {
	MapName   string
	LayerName string
	Z         uint
	X         uint
	Y         uint
}

func ParseKey

func ParseKey(str string) (*Key, error)

ParseKey will parse a string in the format /:map/:layer/:z/:x/:y into a Key struct. The :layer value is optional ParseKey also supports other OS delimiters (i.e. Windows - "\")

func (Key) String

func (k Key) String() string

type Wrapped

type Wrapped interface {
	Original() Interface
}

Wrapped Cache are for cache backend that wrap other cache backends Original will return the first cache backend to be wrapped