unidocs/org.http4s.server.middleware/Caching

Caching

object Caching

Caching contains middlewares to support caching functionality.

Helper functions to support Caching.cache can be found in Caching.Helpers

class Object
trait Matchable
class Any
Caching.type

Type members

Classlikes

object Helpers

Helpers Contains the default arguments used to help construct middleware with caching. They serve to support the default arguments for publicCache and privateCache.

Helpers Contains the default arguments used to help construct middleware with caching. They serve to support the default arguments for publicCache and privateCache.

trait PartiallyAppliedCache[G[_]]
trait PartiallyAppliedNoStoreCache[G[_]]

Value members

Concrete methods

def cache[G[_] : Temporal, F[_]](lifetime: Duration, isPublic: Either[public.type, `private`], methodToSetOn: Method => Boolean, statusToSetOn: Status => Boolean, http: Http[G, F]): 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 no-store[G[_] : Temporal, F[_], A](http: Kleisli[G, A, Response[F]]): Kleisli[G, A, Response[F]]

Middleware that implies responses should NOT be cached. This is a best attempt, many implementors of caching have done so differently.

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.

Transform a Response so that it will not be cached.

def privateCache[G[_] : Temporal, F[_]](lifetime: Duration, http: Http[G, F], fieldNames: List[CIString]): 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]): 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[_] : Temporal, F[_]](lifetime: Duration, http: Http[G, F]): 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.