package redis
- Alphabetic
- By Inheritance
- redis
- ExceptionImplicits
- ExpirationImplicits
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- type AsynchronousResult[A] = Future[A]
- trait CacheApi extends AbstractCacheApi[SynchronousResult]
Synchronous and blocking implementation of the connection to the redis database
- trait CacheAsyncApi extends AbstractCacheApi[AsynchronousResult]
Asynchronous non-blocking implementation of the connection to the redis database
- final class CacheName extends AnyVal
- trait CondensedReports extends Reports
Condensed reports policy produces logs without causes, i.e., logs are shorter but less informative.
- trait DetailedReports extends Reports
Detailed reports policy produces logs with failure causes
- type Done = akka.Done
- Annotations
- @inline()
- trait ExceptionImplicits extends AnyRef
Helper trait providing simplified and unified API to exception handling in play-redis
- case class ExecutionFailedException(key: Option[String], command: String, statement: String, cause: Throwable) extends RedisException with Product with Serializable
Command execution failed with exception
- final class Expiration extends AnyVal
computes cache duration from the given expiration date time.
- trait FailThrough extends RecoveryPolicy
It fails on failure, i.e., propages the exception to upper layers
- trait GuiceProviderImplicits extends ProviderImplicits
- class GuiceRedisCacheProvider extends Provider[RedisCaches] with GuiceProviderImplicits
- class GuiceRedisInstanceResolver extends redis.configuration.RedisInstanceResolver with GuiceProviderImplicits
- Annotations
- @Singleton()
- class NamedCacheInstanceProvider[T] extends Provider[T] with GuiceProviderImplicits
- trait ProviderImplicits extends AnyRef
- trait RecoverWithDefault extends RecoveryPolicy
Recovers with a default value instead of failing through
- trait RecoveryPolicy extends AnyRef
Recovery policy triggers when a request fails.
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.
- Since
1.3.0
- trait RecoveryPolicyResolver extends AnyRef
This resolver represents an abstraction over translation of the policy name into the instance.
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.
- class RecoveryPolicyResolverGuice extends RecoveryPolicyResolver
resolves a policies with guice enabled
- class RecoveryPolicyResolverImpl extends RecoveryPolicyResolver
- trait RedisCacheComponents extends AnyRef
Components for compile-time dependency injection.
Components for compile-time dependency injection. It binds components from configuration package
- class RedisCacheModule extends Module
Play framework module implementing play.api.cache.CacheApi for redis-server key/value storage.
Play framework module implementing play.api.cache.CacheApi for redis-server key/value storage. For more details see README.
- Annotations
- @Singleton()
- type RedisCaches = redis.impl.RedisCaches
- type RedisConnector = redis.connector.RedisConnector
- sealed abstract class RedisException extends RuntimeException
Generic exception produced by the library indicating internal failure
- type RedisInstanceResolver = redis.configuration.RedisInstanceResolver
- trait RedisList[Elem, Result[_]] extends RedisCollection[List[Elem], Result]
Redis Lists are simply lists of strings, sorted by insertion order.
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.
- Elem
Data type of the inserted element
- trait RedisMap[Elem, Result[_]] extends RedisCollection[Map[String, Elem], Result]
Redis Hashes are simply hash maps with strings as keys.
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.
- Elem
Data type of the inserted element
- trait RedisSet[Elem, Result[_]] extends RedisCollection[Set[Elem], Result]
Redis Sets are simply unsorted sets of objects.
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.
- Elem
Data type of the inserted element
- trait Reports extends RecoveryPolicy
Abstract recovery policy provides a general helpers for failure reporting.
Abstract recovery policy provides a general helpers for failure reporting. These might be usable when implementing own recovery policy.
- case class SerializationException(key: String, message: String, cause: Throwable) extends RedisException with Product with Serializable
Value serialization or deserialization failed.
- type SynchronousResult[A] = A
- case class TimeoutException(cause: Throwable) extends RedisException with Product with Serializable
Request timeouts
- case class UnexpectedResponseException(key: Option[String], command: String) extends RedisException with Product with Serializable
Request succeeded but returned unexpected value
Value Members
- 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
- Definition Classes
- ExceptionImplicits
- Annotations
- @throws(scala.this.throws.<init>$default$1[play.api.cache.redis.ExecutionFailedException])
- def invalidConfiguration(message: String): Nothing
helper indicating invalid configuration
helper indicating invalid configuration
- Definition Classes
- ExceptionImplicits
- Annotations
- @throws(scala.this.throws.<init>$default$1[IllegalStateException])
- implicit def java8Date2AsExpiration(expireAt: LocalDateTime): Expiration
- Definition Classes
- ExpirationImplicits
- implicit def javaDate2AsExpiration(expireAt: Date): Expiration
- Definition Classes
- ExpirationImplicits
- 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
- Definition Classes
- ExceptionImplicits
- Annotations
- @throws(scala.this.throws.<init>$default$1[play.api.cache.redis.SerializationException])
- def timedOut(cause: Throwable): Nothing
helper indicating command execution timed out
helper indicating command execution timed out
- Definition Classes
- ExceptionImplicits
- Annotations
- @throws(scala.this.throws.<init>$default$1[play.api.cache.redis.TimeoutException])
- def unexpected(key: Option[String], command: String): Nothing
helper indicating the command execution returned unexpected exception
helper indicating the command execution returned unexpected exception
- Definition Classes
- ExceptionImplicits
- Annotations
- @throws(scala.this.throws.<init>$default$1[play.api.cache.redis.UnexpectedResponseException])
- def unsupported(message: String): Nothing
helper throwing UnsupportedOperationException
helper throwing UnsupportedOperationException
- Definition Classes
- ExceptionImplicits
- Annotations
- @throws(scala.this.throws.<init>$default$1[UnsupportedOperationException])
- object CacheName
- object GuiceProvider extends ProviderImplicits
- object RecoveryPolicyResolver