object Caching

Caching contains middlewares to support caching functionality.

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

Source
Caching.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Caching
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. trait PartiallyAppliedCache[G[_]] extends AnyRef
  2. trait PartiallyAppliedNoStoreCache[G[_]] extends AnyRef

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def cache[G[_], F[_]](lifetime: Duration, isPublic: Either[public.type, private], methodToSetOn: (Method) ⇒ Boolean, statusToSetOn: (Status) ⇒ Boolean, http: Http[G, F])(implicit arg0: MonadError[G, Throwable], arg1: Clock[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.

  6. 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.

  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def no-store[G[_], F[_], A](http: Kleisli[G, A, Response[F]])(implicit arg0: Monad[G], arg1: Clock[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.

  16. def no-store-response[G[_]]: PartiallyAppliedNoStoreCache[G]

    Transform a Response so that it will not be cached.

  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. def privateCache[G[_], F[_]](lifetime: Duration, http: Http[G, F], fieldNames: List[CIString] = Nil)(implicit arg0: MonadError[G, Throwable], arg1: Clock[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.

  20. 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.

  21. def publicCache[G[_], F[_]](lifetime: Duration, http: Http[G, F])(implicit arg0: MonadError[G, Throwable], arg1: Clock[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.

  22. 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.

  23. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  28. 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.

Inherited from AnyRef

Inherited from Any

Ungrouped