trait CacheAlg[F[_], V] extends AnyRef
Abstract algebra describing the operations a cache can perform
- F
The effect monad in which all cache operations will be performed.
- V
The value of types stored in the cache.
- Alphabetic
- By Inheritance
- CacheAlg
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def caching(keyParts: Any*)(ttl: Option[Duration])(f: => V)(implicit flags: Flags): F[V]
Get a value from the cache if it exists.
Get a value from the cache if it exists. Otherwise compute it, insert it into the cache, and return it.
- keyParts
The cache key
- ttl
The time-to-live to use when inserting into the cache. The cache entry will expire after this time has elapsed.
- f
A block that computes the value
- flags
Flags used to conditionally alter the behaviour of ScalaCache
- returns
The value, either retrieved from the cache or computed
- abstract def cachingF(keyParts: Any*)(ttl: Option[Duration])(f: F[V])(implicit flags: Flags): F[V]
Get a value from the cache if it exists.
Get a value from the cache if it exists. Otherwise compute it, insert it into the cache, and return it.
- keyParts
The cache key
- ttl
The time-to-live to use when inserting into the cache. The cache entry will expire after this time has elapsed.
- f
A block that computes the value wrapped in a container
- flags
Flags used to conditionally alter the behaviour of ScalaCache
- returns
The value, either retrieved from the cache or computed
- abstract def close: F[Unit]
You should call this when you have finished using this Cache.
You should call this when you have finished using this Cache. (e.g. when your application shuts down)
It will take care of gracefully shutting down the underlying cache client.
Note that you should not try to use this Cache instance after you have called this method.
- abstract def get(keyParts: Any*)(implicit flags: Flags): F[Option[V]]
Get a value from the cache
Get a value from the cache
- keyParts
The cache key
- flags
Flags used to conditionally alter the behaviour of ScalaCache
- returns
The appropriate value, if it was found in the cache
- abstract def put(keyParts: Any*)(value: V, ttl: Option[Duration] = None)(implicit flags: Flags): F[Unit]
Insert a value into the cache, optionally setting a TTL (time-to-live)
Insert a value into the cache, optionally setting a TTL (time-to-live)
- keyParts
The cache key
- value
The value to insert
- ttl
The time-to-live. The cache entry will expire after this time has elapsed.
- flags
Flags used to conditionally alter the behaviour of ScalaCache
- abstract def remove(keyParts: Any*): F[Unit]
Remove the given key and its associated value from the cache, if it exists.
Remove the given key and its associated value from the cache, if it exists. If the key is not in the cache, do nothing.
- keyParts
data to be used to generate the cache key. This could be as simple as just a single String. See CacheKeyBuilder.
- abstract def removeAll: F[Unit]
Delete the entire contents of the cache.
Delete the entire contents of the cache. Use wisely!
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
- Deprecated
(Since version ) see corresponding Javadoc for more information.