boltdbttlcache

Documentation

Index

• Variables
• type ByIndexEntryExpiry
  • func (s ByIndexEntryExpiry) Len() int
  • func (s ByIndexEntryExpiry) Less(i, j int) bool
  • func (s ByIndexEntryExpiry) Swap(i, j int)
• 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()
  • func (c *Cache) CreateGroupIfNotExists(key string) (*Group, error)
  • func (c *Cache) Debug(action string)
  • func (c *Cache) Delete(key string)
  • func (c *Cache) DeleteGroup(key string) error
  • func (c *Cache) Get(key string) (resp []byte, ok bool)
  • func (c *Cache) Set(key string, resp []byte)
• type CacheEntry
• type Config
• type Group
  • func (g *Group) Count() int
  • func (g *Group) Delete(key []byte) error
  • func (g *Group) Get(key []byte) (*CacheEntry, error)
  • func (g *Group) Put(key []byte, value interface{}, ttl time.Duration) error
• type IndexEntry

Variables

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

Config ...

Types

type ByIndexEntryExpiry

type ByIndexEntryExpiry []IndexEntry

func (ByIndexEntryExpiry) Len

func (s ByIndexEntryExpiry) Len() int

func (ByIndexEntryExpiry) Less

func (s ByIndexEntryExpiry) Less(i, j int) bool

func (ByIndexEntryExpiry) Swap

func (s ByIndexEntryExpiry) Swap(i, j int)

type Cache

type Cache struct {
	Groups map[string]*Group
	// 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()

func (*Cache) CreateGroupIfNotExists

func (c *Cache) CreateGroupIfNotExists(key string) (*Group, error)

CreateGroupIfNotExists gets a group by key. If the grouiop does not exist, it will be created.

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) DeleteGroup

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

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) Set

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

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

type CacheEntry

type CacheEntry struct {
	Key       []byte
	Value     interface{}
	CreatedAt time.Time
	ExpiresAt time.Time
}

type Config

type Config struct {
	Debug            bool
	GroupsName       string
	GroupName        string
	BucketName       string
	StoragePath      string
	DefaultGroupName string
	CacheTTL         time.Duration
}

type Group

type Group struct {
	sync.Mutex
	Key []byte
	// contains filtered or unexported fields
}

func (*Group) Count

func (g *Group) Count() int

func (*Group) Delete

func (g *Group) Delete(key []byte) error

func (*Group) Get

func (g *Group) Get(key []byte) (*CacheEntry, error)

func (*Group) Put

func (g *Group) Put(key []byte, value interface{}, ttl time.Duration) error

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

type IndexEntry

type IndexEntry struct {
	Key       []byte
	ExpiresAt time.Time
}