memory_ttl_storage

README

memory_ttl_storage

A Personal implementation of memcached. Allow backup/restore on init, finish and on process.

You can store any struct with a TTL and retrieve by key.

Current Functions

func Add(key string, content interface{}, ttl *int64)
func Get(key string) (interface{}, bool)
func GetAndRefresh(key string) (interface{}, bool)
func Delete(key string) 
func RegisterInterface(i interface{})
// Stop ticker and Store data if UseBackup
func Stop()

Basic Usage

Import the package

import "github.com/hpardora/memory_ttl_storage"

To work with default values

type Example struct {}

mts := New(nil)
mts.Add("key",&Example{}, nil)

item, ok := mts.Get("key")
if !ok {
    t.Error("cannot retrieve from service")
}

restored := item.(*Example)

Start with custom config

cfg := &MemoryTTLStoreConfig{
	TickerTime: (*time.Duration)  // How often the ticker ticks
	TTLValue:   (int64)            // Default number of seconds for items TTL 
	ShowLogs:   (bool)             // if you what to show basic logs...
	UseBackup:  (bool)             // true for save cache data on Stop(), on process and restore on startup
	BackupPath: (string)           // by default /opt/memory_ttl_storage/mtstorage.dat
}
mts := New(cfg)

⚠ If you want to store custom structs, you must add the following code: mts.RegisterInterface(YourStruct{})

Update the DefaultTTL

mts := New(nil)
mts.SetDefaultTTL(100)

TODO

• Add a size limit

Documentation

Index

• type Item
• type MemoryTTLStorage
  • func New(cfg *MemoryTTLStoreConfig) *MemoryTTLStorage
  • func (mts *MemoryTTLStorage) Add(key string, content interface{}, ttl *int64)
  • func (mts *MemoryTTLStorage) Delete(key string)
  • func (mts *MemoryTTLStorage) Get(key string) (interface{}, bool)
  • func (mts *MemoryTTLStorage) GetAndRefresh(key string) (interface{}, bool)
  • func (mts *MemoryTTLStorage) NewBackupTicker() *time.Ticker
  • func (mts *MemoryTTLStorage) NewCleanerTicker(tickerTime time.Duration) *time.Ticker
  • func (mts *MemoryTTLStorage) RegisterInterface(i interface{})
  • func (mts *MemoryTTLStorage) SetDefaultTTL(defaultTTL int64)
  • func (mts *MemoryTTLStorage) Stop()
• type MemoryTTLStoreConfig
• type StorageManager
  • func NewStorageManager(backupFilePath string) *StorageManager
  • func (b *StorageManager) Restore(i interface{}) error
  • func (b *StorageManager) Store(i interface{}) error

Types

type Item

type Item struct {
	Content         interface{}
	ExpireTimestamp int64
	TTL             int64
}

type MemoryTTLStorage

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

func New

func New(cfg *MemoryTTLStoreConfig) *MemoryTTLStorage

func (*MemoryTTLStorage) Add

func (mts *MemoryTTLStorage) Add(key string, content interface{}, ttl *int64)

func (*MemoryTTLStorage) Delete

func (mts *MemoryTTLStorage) Delete(key string)

func (*MemoryTTLStorage) Get

func (mts *MemoryTTLStorage) Get(key string) (interface{}, bool)

func (*MemoryTTLStorage) GetAndRefresh

func (mts *MemoryTTLStorage) GetAndRefresh(key string) (interface{}, bool)

func (*MemoryTTLStorage) NewBackupTicker

func (mts *MemoryTTLStorage) NewBackupTicker() *time.Ticker

func (*MemoryTTLStorage) NewCleanerTicker

func (mts *MemoryTTLStorage) NewCleanerTicker(tickerTime time.Duration) *time.Ticker

func (*MemoryTTLStorage) RegisterInterface

func (mts *MemoryTTLStorage) RegisterInterface(i interface{})

func (*MemoryTTLStorage) SetDefaultTTL

func (mts *MemoryTTLStorage) SetDefaultTTL(defaultTTL int64)

func (*MemoryTTLStorage) Stop

func (mts *MemoryTTLStorage) Stop()

type MemoryTTLStoreConfig

type MemoryTTLStoreConfig struct {
	TickerTime time.Duration
	TTLValue   int64
	ShowLogs   bool
	UseBackup  bool
	BackupPath string
}

type StorageManager

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

func NewStorageManager

func NewStorageManager(backupFilePath string) *StorageManager

func (*StorageManager) Restore

func (b *StorageManager) Restore(i interface{}) error

func (*StorageManager) Store

func (b *StorageManager) Store(i interface{}) error