nim-libp2p/libp2p/protocols/pubsub/timedcache.nim

## Nim-LibP2P
## Copyright (c) 2019 Status Research & Development GmbH
## Licensed under either of
##  * Apache License, version 2.0, ([LICENSE-APACHE](LICENSE-APACHE))
##  * MIT license ([LICENSE-MIT](LICENSE-MIT))
## at your option.
## This file may not be copied, modified, or distributed except according to
## those terms.

import tables
import chronos, chronicles

logScope:
  topic = "TimedCache"

const Timeout* = 10.seconds # default timeout in ms

type
  ExpireHandler*[V] = proc(key: string, val: V) {.gcsafe.}
  TimedEntry*[V] = object of RootObj
    val: V
    handler: ExpireHandler[V]

  TimedCache*[V] = ref object of RootObj
    cache*: Table[string, TimedEntry[V]]
    onExpire*: ExpireHandler[V]
    timeout*: Duration

# TODO: This belong in chronos, temporary left here until chronos is updated
proc addTimer*(at: Duration, cb: CallbackFunc, udata: pointer = nil) =
  ## Arrange for the callback ``cb`` to be called at the given absolute
  ## timestamp ``at``. You can also pass ``udata`` to callback.
  addTimer(Moment.fromNow(at), cb, udata)

proc put*[V](t: TimedCache[V],
             key: string,
             val: V = "",
             timeout: Duration,
             handler: ExpireHandler[V] = nil) =
  trace "adding entry to timed cache", key = key
  t.cache[key] = TimedEntry[V](val: val, handler: handler)

  addTimer(
    timeout,
    proc (arg: pointer = nil) {.gcsafe.} =
      trace "deleting expired entry from timed cache", key = key
      if key in t.cache:
        let entry = t.cache[key]
        t.cache.del(key)
        if not isNil(entry.handler):
          entry.handler(key, entry.val)
  )

proc put*[V](t: TimedCache[V],
             key: string,
             val: V = "",
             handler: ExpireHandler[V] = nil) =
  t.put(key, val, t.timeout, handler)

proc contains*[V](t: TimedCache[V], key: string): bool =
  t.cache.contains(key)

proc del*[V](t: TimedCache[V], key: string) =
  trace "deleting entry from timed cache", key = key
  t.cache.del(key)

proc get*[V](t: TimedCache[V], key: string): V =
  t.cache[key].val

proc `[]`*[V](t: TimedCache[V], key: string): V =
  t.get(key)

proc `[]=`*[V](t: TimedCache[V], key: string, val: V): V =
  t.put(key, val)

proc newTimedCache*[V](timeout: Duration = Timeout): TimedCache[V] =
  new result
  result.cache = initTable[string, TimedEntry[V]]()
  result.timeout = timeout