ICache

Interface for caches that are used to cache values to improve performance.

The ICache interface defines methods for caches that are used to cache values, in order to improve performance.

Removes a value from the cache by its key.

remove(context: Optional[IContext], key: str)

context: IContext - (optional) a context to trace execution through a call chain.
key: str - a unique value key.

Retrieves cached value from the cache using its key. If value is missing in the cache or expired it returns None.

retrieve(context: Optional[IContext], key: str): Any

context: IContext - (optional) a context to trace execution through a call chain.
key: str - a unique value key.
returns: Any - a cached value or None if value wasn’t found or timeout expired.

Stores value in the cache with expiration time.

store(context: Optional[IContext], key: str, value: Any, timeout: int): Any

context: IContext - (optional) a context to trace execution through a call chain.
key: str - a unique value key.
value: Any - a value to store.
timeout: int - expiration timeout in milliseconds.
returns: Any - a cached value stored in the cache.