trait CacheAlg[V] extends AnyRef
Abstract algebra describing the operations a cache can perform
- V
The value of types stored in the cache.
- Alphabetic
- By Inheritance
- CacheAlg
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
caching[F[_]](keyParts: Any*)(ttl: Option[Duration])(f: ⇒ V)(implicit mode: Mode[F], 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.
- F
The type of container in which the result will be wrapped. This is decided by the mode.
- 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
- mode
The operation mode, which decides the type of container in which to wrap the result
- flags
Flags used to conditionally alter the behaviour of ScalaCache
- returns
The value, either retrieved from the cache or computed
-
abstract
def
cachingF[F[_]](keyParts: Any*)(ttl: Option[Duration])(f: ⇒ F[V])(implicit mode: Mode[F], 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.
- F
The type of container in which the result will be wrapped. This is decided by the mode.
- 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
- mode
The operation mode, which decides the type of container in which to wrap the result
- flags
Flags used to conditionally alter the behaviour of ScalaCache
- returns
The value, either retrieved from the cache or computed
-
abstract
def
close[F[_]]()(implicit mode: Mode[F]): F[Any]
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.
- F
The type of container in which the result will be wrapped. This is decided by the mode.
- mode
The operation mode, which decides the type of container in which to wrap the result
-
abstract
def
get[F[_]](keyParts: Any*)(implicit mode: Mode[F], flags: Flags): F[Option[V]]
Get a value from the cache
Get a value from the cache
- F
The type of container in which the result will be wrapped. This is decided by the mode.
- keyParts
The cache key
- mode
The operation mode, which decides the type of container in which to wrap the result
- flags
Flags used to conditionally alter the behaviour of ScalaCache
- returns
The appropriate value, if it was found in the cache
-
abstract
def
put[F[_]](keyParts: Any*)(value: V, ttl: Option[Duration] = None)(implicit mode: Mode[F], flags: Flags): F[Any]
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)
- F
The type of container in which the result will be wrapped. This is decided by the mode.
- keyParts
The cache key
- value
The value to insert
- ttl
The time-to-live. The cache entry will expire after this time has elapsed.
- mode
The operation mode, which decides the type of container in which to wrap the result
- flags
Flags used to conditionally alter the behaviour of ScalaCache
-
abstract
def
remove[F[_]](keyParts: Any*)(implicit mode: Mode[F]): F[Any]
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.
- F
The type of container in which the result will be wrapped. This is decided by the mode.
- 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[_]]()(implicit mode: Mode[F]): F[Any]
Delete the entire contents of the cache.
Delete the entire contents of the cache. Use wisely!
- F
The type of container in which the result will be wrapped. This is decided by the mode.
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[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
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()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )