Packages

t

play.api.cache

AsyncCacheApi

trait AsyncCacheApi extends AnyRef

The cache API

Source
AsyncCacheApi.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
CaffeineCacheApi, EhCacheApi
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AsyncCacheApi
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def get[T](key: String)(implicit arg0: ClassTag[T]): Future[Option[T]]

    Retrieve a value from the cache for the given type

    Retrieve a value from the cache for the given type

    key

    Item key.

    returns

    result as a future of Option[T]

  2. abstract def getOrElseUpdate[A](key: String, expiration: Duration = Duration.Inf)(orElse: ⇒ Future[A])(implicit arg0: ClassTag[A]): Future[A]

    Retrieve a value from the cache, or set it from a default function.

    Retrieve a value from the cache, or set it from a default function.

    key

    Item key.

    expiration

    expiration period in seconds.

    orElse

    The default function to invoke if the value was not found in cache.

  3. abstract def remove(key: String): Future[Done]

    Remove a value from the cache

  4. abstract def removeAll(): Future[Done]

    Removes all values from the cache.

    Removes all values from the cache. This may be useful as an admin user operation if it is supported by your cache.

    returns

    a Future[Done], which is completed with either a Done or an exception if the clear did not work.

    Exceptions thrown

    UnsupportedOperationException if this cache implementation does not support removing all values.

  5. abstract def set(key: String, value: Any, expiration: Duration = Duration.Inf): Future[Done]

    Set a value into the cache.

    Set a value into the cache.

    key

    Item key.

    value

    Item value.

    expiration

    Expiration time.

Concrete 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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. lazy val sync: SyncCacheApi

    Get an instance of SyncCacheApi to make synchronous calls.

  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped