Redis Cache for Play
API
Generated with
Redis Cache for Play/play.api.cache.redis

play.api.cache.redis

package play.api.cache.redis

Members list

Packages

package play.api.cache.redis.configuration
package play.api.cache.redis.connector
package play.api.cache.redis.impl

Type members

Classlikes

final implicit class AnyOps[A](self: A) extends AnyVal

Attributes

Supertypes
class AnyVal
trait Matchable
class Any
trait CacheApi

Synchronous and blocking implementation of the connection to the redis database

Synchronous and blocking implementation of the connection to the redis database

Attributes

Supertypes
class Object
trait Matchable
class Any
trait CacheAsyncApi

Asynchronous non-blocking implementation of the connection to the redis database

Asynchronous non-blocking implementation of the connection to the redis database

Attributes

Supertypes
class Object
trait Matchable
class Any
final class CacheName(val name: String) extends AnyVal

Attributes

Companion
object
Supertypes
class AnyVal
trait Matchable
class Any
object CacheName

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
CacheName.type
trait CondensedReports extends Reports

Condensed reports policy produces logs without causes, i.e., logs are shorter but less informative.

Condensed reports policy produces logs without causes, i.e., logs are shorter but less informative.

Attributes

Supertypes
trait Reports
class Object
trait Matchable
class Any
trait DetailedReports extends Reports

Detailed reports policy produces logs with failure causes

Detailed reports policy produces logs with failure causes

Attributes

Supertypes
trait Reports
class Object
trait Matchable
class Any
trait ExceptionImplicits

Helper trait providing simplified and unified API to exception handling in play-redis

Helper trait providing simplified and unified API to exception handling in play-redis

Attributes

Supertypes
class Object
trait Matchable
class Any
final case class ExecutionFailedException(key: Option[String], command: String, statement: String, cause: Throwable) extends RedisException

Command execution failed with exception

Command execution failed with exception

Attributes

Supertypes
trait Product
trait Equals
class RuntimeException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
final class Expiration(val expireAt: Long) extends AnyVal

computes cache duration from the given expiration date time.

computes cache duration from the given expiration date time.

Value parameters

expireAt

The class accepts timestamp in milliseconds since 1970

Attributes

Supertypes
class AnyVal
trait Matchable
class Any
trait FailThrough extends RecoveryPolicy

It fails on failure, i.e., propages the exception to upper layers

It fails on failure, i.e., propages the exception to upper layers

Attributes

Supertypes
class Object
trait Matchable
class Any
object GuiceProvider extends ProviderImplicits

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
trait GuiceProviderImplicits extends ProviderImplicits

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class GuiceRedisCacheProvider(instance: RedisInstanceProvider) extends Provider[RedisCaches], GuiceProviderImplicits

Attributes

Supertypes
trait Provider[RedisCaches]
class Object
trait Matchable
class Any
Show all
@Singleton
class GuiceRedisInstanceResolver(val injector: Injector) extends RedisInstanceResolver, GuiceProviderImplicits

Attributes

Supertypes
class Object
trait Matchable
class Any
Show all
final implicit class HigherKindedAnyOps[F[_], A](self: F[A]) extends AnyVal

Attributes

Supertypes
class AnyVal
trait Matchable
class Any
class NamedCacheInstanceProvider[T](f: RedisCaches => T)(implicit name: CacheName) extends Provider[T], GuiceProviderImplicits

Attributes

Supertypes
trait Provider[T]
class Object
trait Matchable
class Any
Show all
trait ProviderImplicits

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object GuiceProvider.type
trait RecoverWithDefault extends RecoveryPolicy

Recovers with a default value instead of failing through

Recovers with a default value instead of failing through

Attributes

Supertypes
class Object
trait Matchable
class Any
trait RecoveryPolicy

Recovery policy triggers when a request fails. Based on the implementation, it may try it again, recover with a default value or just simply log the failure. Either way, it is up to user to define what to do on failure.

Recovery policy triggers when a request fails. Based on the implementation, it may try it again, recover with a default value or just simply log the failure. Either way, it is up to user to define what to do on failure.

Attributes

Since

1.3.0

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait FailThrough
trait Reports
trait RecoveryPolicyResolver

This resolver represents an abstraction over translation of the policy name into the instance. It has two subclasses, one for guice and the other for compile-time injection.

This resolver represents an abstraction over translation of the policy name into the instance. It has two subclasses, one for guice and the other for compile-time injection.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object RecoveryPolicyResolver

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
class RecoveryPolicyResolverGuice(injector: Injector) extends RecoveryPolicyResolver

resolves a policies with guice enabled

resolves a policies with guice enabled

Attributes

Supertypes
class Object
trait Matchable
class Any
class RecoveryPolicyResolverImpl extends RecoveryPolicyResolver

Attributes

Supertypes
class Object
trait Matchable
class Any
trait RedisCacheComponents

Components for compile-time dependency injection. It binds components from configuration package

Components for compile-time dependency injection. It binds components from configuration package

Attributes

Supertypes
class Object
trait Matchable
class Any
@Singleton
class RedisCacheModule extends Module

Play framework module implementing play.api.cache.CacheApi for redis-server key/value storage. For more details see README.

Play framework module implementing play.api.cache.CacheApi for redis-server key/value storage. For more details see README.

Attributes

Supertypes
class Module
class Object
trait Matchable
class Any
sealed abstract class RedisException(message: String, cause: Throwable) extends RuntimeException

Generic exception produced by the library indicating internal failure

Generic exception produced by the library indicating internal failure

Attributes

Supertypes
class RuntimeException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
Known subtypes
trait RedisList[Elem, Result[_]]

Redis Lists are simply lists of strings, sorted by insertion order. It is possible to add elements to a Redis List pushing new elements on the head (on the left) or on the tail (on the right) of the list.

Redis Lists are simply lists of strings, sorted by insertion order. It is possible to add elements to a Redis List pushing new elements on the head (on the left) or on the tail (on the right) of the list.

Type parameters

Elem

Data type of the inserted element

Attributes

Supertypes
class Object
trait Matchable
class Any
trait RedisMap[Elem, Result[_]]

Redis Hashes are simply hash maps with strings as keys. It is possible to add elements to a Redis Hashes by adding new elements into the collection.

Redis Hashes are simply hash maps with strings as keys. It is possible to add elements to a Redis Hashes by adding new elements into the collection.

This simplified wrapper implements only unordered Maps.

Type parameters

Elem

Data type of the inserted element

Attributes

Supertypes
class Object
trait Matchable
class Any
trait RedisSet[Elem, Result[_]]

Redis Sets are simply unsorted sets of objects. It is possible to add elements to a Redis Set by adding new elements into the collection.

Redis Sets are simply unsorted sets of objects. It is possible to add elements to a Redis Set by adding new elements into the collection.

This simplified wrapper implements only unordered Sets.

Type parameters

Elem

Data type of the inserted element

Attributes

Supertypes
class Object
trait Matchable
class Any
trait RedisSortedSet[Elem, Result[_]]

Attributes

Supertypes
class Object
trait Matchable
class Any
trait Reports extends RecoveryPolicy

Abstract recovery policy provides a general helpers for failure reporting. These might be usable when implementing own recovery policy.

Abstract recovery policy provides a general helpers for failure reporting. These might be usable when implementing own recovery policy.

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
final case class SerializationException(key: String, message: String, cause: Throwable) extends RedisException

Value serialization or deserialization failed.

Value serialization or deserialization failed.

Attributes

Supertypes
trait Product
trait Equals
class RuntimeException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
final case class TimeoutException(cause: Throwable) extends RedisException

Request timeouts

Request timeouts

Attributes

Supertypes
trait Product
trait Equals
class RuntimeException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
final case class UnexpectedResponseException(key: Option[String], command: String) extends RedisException

Request succeeded but returned unexpected value

Request succeeded but returned unexpected value

Attributes

Supertypes
trait Product
trait Equals
class RuntimeException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all

Types

type AsynchronousResult[A] = Future[A]
type Done = Done
type SynchronousResult[A] = A

Value members

Inherited methods

def failed(key: Option[String], command: String, statement: String, cause: Throwable): Nothing

helper indicating command execution failed with exception

helper indicating command execution failed with exception

Attributes

Inherited from:
ExceptionImplicits
def invalidConfiguration(message: String): Nothing

helper indicating invalid configuration

helper indicating invalid configuration

Attributes

Inherited from:
ExceptionImplicits
def serializationFailed(key: String, message: String, cause: Throwable): Nothing

helper indicating serialization failure, it throws an exception

helper indicating serialization failure, it throws an exception

Attributes

Inherited from:
ExceptionImplicits
def timedOut(cause: Throwable): Nothing

helper indicating command execution timed out

helper indicating command execution timed out

Attributes

Inherited from:
ExceptionImplicits
def unexpected(key: Option[String], command: String): Nothing

helper indicating the command execution returned unexpected exception

helper indicating the command execution returned unexpected exception

Attributes

Inherited from:
ExceptionImplicits
def unsupported(message: String): Nothing

helper throwing UnsupportedOperationException

helper throwing UnsupportedOperationException

Attributes

Inherited from:
ExceptionImplicits

Implicits

Implicits

final implicit def AnyOps[A](self: A): AnyOps[A]
final implicit def HigherKindedAnyOps[F[_], A](self: F[A]): HigherKindedAnyOps[F, A]

Inherited implicits

implicit def java8Date2AsExpiration(expireAt: LocalDateTime): Expiration

Attributes

Inherited from:
ExpirationImplicits (hidden)
implicit def javaDate2AsExpiration(expireAt: Date): Expiration

Attributes

Inherited from:
ExpirationImplicits (hidden)
Generated with