lfu

README

LFU Redis cache library for Golang

LFU Redis implements LFU Cache algorithm using Redis as data storage

LFU Redis Package gives you control over Cache Capacity in case you're using multipurpose Redis instance and avoid using eviction policy

Installation

go get -u github.com/m7shapan/lfu-redis

Quickstart

package lfu_test

import (
	"fmt"

	"github.com/go-redis/redis/v8"
	"github.com/m7shapan/lfu-redis"
)

func ExampleUsage() {
	redisClient := redis.NewClient(&redis.Options{})

	cache := lfu.New(10000, redisClient)

	err := cache.Put("key", "value")
	if err != nil {
		panic(err)
	}

	value, err := cache.Get("key")
	if err != nil {
		panic(err)
	}

	fmt.Println(value)
	// Output: value
}

Documentation

Index

• Constants
• type LFUCache
  • func New(capacity int64, redisClient *redis.Client) *LFUCache
  • func (c *LFUCache) DelItem(key string) (err error)
  • func (c *LFUCache) Flush() (err error)
  • func (c *LFUCache) Get(key string) (value string, err error)
  • func (c *LFUCache) Put(key string, value interface{}) (err error)

Constants

const LFUHashName = "LFUCacheHash"

const LFUSortedSetName = "LFUCacheSortedSet"

Types

type LFUCache

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

func New

func New(capacity int64, redisClient *redis.Client) *LFUCache

func (*LFUCache) DelItem

func (c *LFUCache) DelItem(key string) (err error)

DelItem remove item from cache

func (*LFUCache) Flush

func (c *LFUCache) Flush() (err error)

Flush remove all cache

func (*LFUCache) Get

func (c *LFUCache) Get(key string) (value string, err error)

Get return item from cache

func (*LFUCache) Put

func (c *LFUCache) Put(key string, value interface{}) (err error)

Put caches item