memcache

README

memcache

Memory cache with benefits

Features

• Key expiration
• Redis Sorted set emulation
• Lock/Unlock with key

Documentation

Index

• Constants
• type CacheType
  • func New(logger Logger) (memCache *CacheType)
  • func (mc *CacheType) Add(key string, value interface{}) (itemID int64)
  • func (mc *CacheType) Cache() (cache map[string]*ValueType)
  • func (mc *CacheType) Delete(key string)
  • func (mc *CacheType) Evictor()
  • func (mc *CacheType) Get(key string) (value interface{}, ok bool)
  • func (mc *CacheType) GetByID(itemID int64) (item interface{})
  • func (mc *CacheType) GetEx(key string) (*ValueType, bool)
  • func (mc *CacheType) Len() (cacheSize int64)
  • func (mc *CacheType) LenSafe() (cacheSize int64)
  • func (mc *CacheType) LockWithKey(key string)
  • func (mc *CacheType) Set(key string, value interface{})
  • func (mc *CacheType) SetEx(key string, value interface{}, expires int64)
  • func (mc *CacheType) SetLockWithKeyTimeout(timeout time.Duration)
  • func (mc *CacheType) Stop()
  • func (mc *CacheType) UnlockWithKey(key string)
  • func (mc *CacheType) UnsafeDelete(key string)
• type Logger
• type ValueType

Constants

const (
	LockWithKeyDefaultTimeout = 10 * time.Millisecond
)

Types

type CacheType

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

CacheType - cache structure with bound methods

func New

func New(logger Logger) (memCache *CacheType)

New - prepare and populate memcache instance

func (*CacheType) Add

func (mc *CacheType) Add(key string, value interface{}) (itemID int64)

Add - add item to cache and return resulting item ID

func (*CacheType) Cache

func (mc *CacheType) Cache() (cache map[string]*ValueType)

Cache - return whole cache contents

func (*CacheType) Delete

func (mc *CacheType) Delete(key string)

Delete - removes item from cache

func (*CacheType) Evictor

func (mc *CacheType) Evictor()

Evictor - background goroutine that periodically purges expired keys

func (*CacheType) Get

func (mc *CacheType) Get(key string) (value interface{}, ok bool)

Get - fetch item from cache with ok indicating status of the operation

func (*CacheType) GetByID

func (mc *CacheType) GetByID(itemID int64) (item interface{})

GetByID - fetch item from cache based on item ID. Return nil otherwise

func (*CacheType) GetEx

func (mc *CacheType) GetEx(key string) (*ValueType, bool)

GetEx - get key/value pair with expiration

func (*CacheType) Len

func (mc *CacheType) Len() (cacheSize int64)

Len - returns cache length

func (*CacheType) LenSafe

func (mc *CacheType) LenSafe() (cacheSize int64)

LenSafe - same as Len() but with read lock

func (*CacheType) LockWithKey

func (mc *CacheType) LockWithKey(key string)

func (*CacheType) Set

func (mc *CacheType) Set(key string, value interface{})

Set - set key/value pair without expiration

func (*CacheType) SetEx

func (mc *CacheType) SetEx(key string, value interface{}, expires int64)

SetEx - set key/value pair with expiration

func (*CacheType) SetLockWithKeyTimeout

func (mc *CacheType) SetLockWithKeyTimeout(timeout time.Duration)

func (*CacheType) Stop

func (mc *CacheType) Stop()

Stop - run some cleaning chores during shutdown

func (*CacheType) UnlockWithKey

func (mc *CacheType) UnlockWithKey(key string)

func (*CacheType) UnsafeDelete

func (mc *CacheType) UnsafeDelete(key string)

UnsafeDelete - removes item from cache

type Logger

type Logger interface {
	Printf(fmt string, args ...interface{})
	Debug(s ...interface{})
}

Logger - memcache logger interface. Can be stdlib log, logrus etc

type ValueType

type ValueType struct {
	Value    interface{}
	Expires  int64
	MetaData string
}

ValueType - memcache item