cache

README

Go Memory Cache

No periodically scheduler is running without your actions. It times the cleanup to the next expiry.

Usage

import(
	"github.com/ProxeusApp/memcache"
	"fmt"
	"time"
)

func main(){
	c := cache.New(3 * time.Second)
	//or extend expiry on get 'true' | 'false'
	c = cache.NewExtendExpiryOnGet(3 * time.Second, true)

	c.Put("myKey", "my Value")
	c.PutWithOtherExpiry("myKey", "my Value", 6*time.Second)
	c.Put(123, 456)
	c.Put(1.456, 7.89)
	c.OnExpired = func(key interface{}, val interface{}){
		fmt.Println("on expired", key, val)
	}
	time.Sleep(10*time.Second)

	var myVal string
	err := c.Get("myKey", &myVal)
	if err != nil {
	    panic(err)
	}
	fmt.Println(myVal)

}

Documentation

Index

• Variables
• type Cache
  • func New(expiry time.Duration) *Cache
  • func NewExtendExpiryOnGet(expiry time.Duration, extendExpiry bool) *Cache
  • func (s *Cache) Clean()
  • func (s *Cache) Close()
  • func (s *Cache) Get(key interface{}, ref interface{}) error
  • func (s *Cache) GetAndExtendExpiry(key interface{}, ref interface{}, extendExpiry bool) error
  • func (s *Cache) Put(key interface{}, val interface{})
  • func (s *Cache) PutWithOtherExpiry(key interface{}, val interface{}, expiry time.Duration)
  • func (s *Cache) Remove(key interface{}) bool

Variables

var (
	ErrNotExist = errors.New("cache not exist")
)

Types

type Cache

type Cache struct {
	Expiry time.Duration

	OnExpired func(key interface{}, val interface{})
	// contains filtered or unexported fields
}

func New

func New(expiry time.Duration) *Cache

func NewExtendExpiryOnGet

func NewExtendExpiryOnGet(expiry time.Duration, extendExpiry bool) *Cache

func (*Cache) Clean

func (s *Cache) Clean()

func (*Cache) Close

func (s *Cache) Close()

func (*Cache) Get

func (s *Cache) Get(key interface{}, ref interface{}) error

func (*Cache) GetAndExtendExpiry

func (s *Cache) GetAndExtendExpiry(key interface{}, ref interface{}, extendExpiry bool) error

func (*Cache) Put

func (s *Cache) Put(key interface{}, val interface{})

func (*Cache) PutWithOtherExpiry

func (s *Cache) PutWithOtherExpiry(key interface{}, val interface{}, expiry time.Duration)

func (*Cache) Remove

func (s *Cache) Remove(key interface{}) bool