object Caching
Caching contains middlewares to support caching functionality.
Helper functions to support Caching.cache can be found in Caching.Helpers
- Source
- Caching.scala
- Alphabetic
- By Inheritance
- Caching
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- trait PartiallyAppliedCache[G[_]] extends AnyRef
- trait PartiallyAppliedNoStoreCache[G[_]] extends AnyRef
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 cache[G[_], F[_]](lifetime: Duration, isPublic: Either[public.type, private], methodToSetOn: (Method) => Boolean, statusToSetOn: (Status) => Boolean, http: Http[G, F])(implicit arg0: Temporal[G]): Http[G, F]
Construct a Middleware that will apply the appropriate caching headers.
Construct a Middleware that will apply the appropriate caching headers.
Helper functions for methodToSetOn and statusToSetOn can be found in Helpers.
Note: If set to Duration.Inf, lifetime falls back to 10 years for support of Http1 caches.
- def cacheResponse[G[_]](lifetime: Duration, isPublic: Either[public.type, private]): PartiallyAppliedCache[G]
Method in order to turn a generated Response into one that will be appropriately cached.
Method in order to turn a generated Response into one that will be appropriately cached.
Note: If set to Duration.Inf, lifetime falls back to 10 years for support of Http1 caches.
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- 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
- def no-store[G[_], F[_], A](http: Kleisli[G, A, Response[F]])(implicit arg0: Temporal[G]): Kleisli[G, A, Response[F]]
Middleware that implies responses should NOT be cached.
Middleware that implies responses should NOT be cached. This is a best attempt, many implementors of caching have done so differently.
- def no-store-response[G[_]]: PartiallyAppliedNoStoreCache[G]
Transform a Response so that it will not be cached.
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def privateCache[G[_], F[_]](lifetime: Duration, http: Http[G, F], fieldNames: List[CIString] = Nil)(implicit arg0: Temporal[G]): Http[G, F]
Sets headers for response to be privately cached for the specified duration.
Sets headers for response to be privately cached for the specified duration.
Note: If set to Duration.Inf, lifetime falls back to 10 years for support of Http1 caches.
- def privateCacheResponse[G[_]](lifetime: Duration, fieldNames: List[CIString] = Nil): PartiallyAppliedCache[G]
Privately Caches A Response for the given lifetime.
Privately Caches A Response for the given lifetime.
Note: If set to Duration.Inf, lifetime falls back to 10 years for support of Http1 caches.
- def publicCache[G[_], F[_]](lifetime: Duration, http: Http[G, F])(implicit arg0: Temporal[G]): Http[G, F]
Sets headers for response to be publicly cached for the specified duration.
Sets headers for response to be publicly cached for the specified duration.
Note: If set to Duration.Inf, lifetime falls back to 10 years for support of Http1 caches.
- def publicCacheResponse[G[_]](lifetime: Duration): PartiallyAppliedCache[G]
Publicly Cache a Response for the given lifetime.
Publicly Cache a Response for the given lifetime.
Note: If set to Duration.Inf, lifetime falls back to 10 years for support of Http1 caches.
- 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(classOf[java.lang.InterruptedException])
- 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()
- object Helpers
Helpers Contains the default arguments used to help construct middleware with caching.
Helpers Contains the default arguments used to help construct middleware with caching. They serve to support the default arguments for publicCache and privateCache.