eleum

eleum

eleum is an instance cache provider to avoid i/o operation. It was made to be simple and fast.

• Safe for multiple goroutines
• Simple
• Fast

Install

go get -u github.com/kauehmoreno/eleum

Usage

Simple One

cache := eleum.New()
key := eleum.FormatKey("key", "param1", "param2")
var expected string
err := cache.Get(key, &expected)
if err != nil{
    result := fn()
    defer cache.Expire(key, time.Second*30)
    cache.Set(key, result)
}

With context

cache := eleum.New()
key := eleum.FormatKey("key", "param1", "param2")
ctx := context.Background()
err := cache.GetWithContext(ctx, key, &expected)
if err != nil{
    result := fn()
    cache.SetWithContext(ctx, key, result)
}

New options

• MaxNumberOfKeys to be set on cache object

cache:= eleum.New(eleum.MaxNumOfKeys(10000))

• WriteTimeout and ReadTimeout it's used with GetWithContext and SetWithContext

cache:= eleum.New(
    eleum.ReadTimeout(time.Milliseconds*10), eleum.WriteTimeout(time.Milliseconds*10))

TotalKeys()

• Return total of keys on cache object

cache := eleum.New()
total:= cache.TotalKeys()

Flushall()

• Return total of keys on cache object

 eleum.New().Flushall()

Del()

• Delete a key from cache object

eleum.New().Del("key")

Expire()

• Is rensposable for expire key/value pair from cache
• it must be use together with background
• without it will only mark a key to be expired but will not do it

eleum.New().Expire(key, time.Second*30)

Background()

• A goroutine is started to operate background check to expire all keys based - on expiration set from each key
• it runs a time ticker defined by client
• Background should be used one time preferably.

eleum.New().Background(time.Minute)

Benchmark

All benchmark tests were made on IMAC Intel(R) Core(TM) i5-7400 CPU @ 3.00GHz

Third Party Libraries

License

MIT Free Software, Hell Yeah!