boltdbtreecache

Documentation

Index

• Variables
• type Cache
  • func Mount(db *bolt.DB) *Cache
  • func New(config *Config) (*Cache, error)
  • func (c *Cache) Action(name string, args ...interface{}) (map[string]*interface{}, error)
  • func (c *Cache) Close() error
  • func (c *Cache) Debug(action string)
  • func (c *Cache) Delete(key string)
  • func (c *Cache) Get(key string) (resp []byte, ok bool)
  • func (c *Cache) Ping() error
  • func (c *Cache) Set(key string, resp []byte)
• type Config

Variables

var (
	PluginConfig = &boltdbtreecacheConfig{
		done: make(chan struct{}),
	}
)

Config ...

Types

type Cache

type Cache struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func Mount

func Mount(db *bolt.DB) *Cache

Mount returns a new Cache using the provided (and opened) bolt database.

func New

func New(config *Config) (*Cache, error)

func (*Cache) Action

func (c *Cache) Action(name string, args ...interface{}) (map[string]*interface{}, error)

func (*Cache) Close

func (c *Cache) Close() error

Close closes the underlying boltdb database.

func (*Cache) Debug

func (c *Cache) Debug(action string)

func (*Cache) Delete

func (c *Cache) Delete(key string)

Delete removes the response with the given key from the cache.

func (*Cache) Get

func (c *Cache) Get(key string) (resp []byte, ok bool)

Get retrieves the response corresponding to the given key if present.

func (*Cache) Ping

func (c *Cache) Ping() error

Ping connects to the database. Returns nil if successful.

func (*Cache) Set

func (c *Cache) Set(key string, resp []byte)

Set stores a response to the cache at the given key.

type Config

type Config struct {
	BucketName  string
	StoragePath string
	Debug       bool
}