redis

Type Members

1. trait AkkaSerializer extends AnyRef

   

   Provides a encode and decode methods to serialize objects into strings and vise versa.

2. class AsExpiration extends AnyRef

   

   converts given timestamp indication expiration date into duration from now

   converts given timestamp indication expiration date into duration from now

   Definition Classes

   Expiration

3. class AsyncRedis extends RedisCache[Future] with CacheAsyncApi

   

   Annotations

   @Singleton()

4. trait CacheApi extends InternalCacheApi[Identity]

   

   Synchronous and blocking implementation of the connection to the redis database

5. trait CacheAsyncApi extends InternalCacheApi[Future]

   

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

6. trait Configuration extends AnyRef

   

   Configuration provider returns a connection settings to Redis server.

   Configuration provider returns a connection settings to Redis server. The application can run in various different environments and in many of them there might be very different connection settings. For example, for running the application on localhost is sufficient to set up configuration into the configuration file. Although for deploying the application into some PaaS it might be injected directly by the platform itself, e.g., via environment variable. This trait abstracts the configuration and allows its multiple implementations for every required environment.

7. case class ConnectionSettings(host: String, port: Int, database: Int, password: Option[String])(implicit invocationContext: ExecutionContext, timeout: Timeout) extends Product with Serializable

   

   Connection settings encapsulates host, port, and other settings considered by RedisConnectorImpl.

8. class ConnectionSettingsProvider extends Provider[ConnectionSettings]

   

   Converts Configuration instance into simple immutable ConnectionSettings

   Converts Configuration instance into simple immutable ConnectionSettings

   Annotations

   @Singleton()

9. class EnvironmentConfiguration extends StaticConfiguration

   

   Environment configuration expects the configuration to be injected through environment variable containing the connection string.

   Environment configuration expects the configuration to be injected through environment variable containing the connection string. This configuration is often used by PaaS environments.

   Annotations

   @Singleton()

10. class EnvironmentConfigurationProvider extends Provider[EnvironmentConfiguration]

    

    Reads environment variables for the connection string and returns EnvironmentConfiguration instance.

    Reads environment variables for the connection string and returns EnvironmentConfiguration instance. This configuration instance is designed to work in PaaS environments such as Heroku.

11. trait Exceptions extends AnyRef

    

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

12. trait Expiration extends AnyRef

    

    Provides implicit converters to convert expiration date into duration, which is accepted by CacheApi.

    Provides implicit converters to convert expiration date into duration, which is accepted by CacheApi. The conversion is performed from now, i.e., the formula is:

    expireAt in seconds - now in seconds = duration in seconds

13. trait Implicits extends AnyRef

    

    Implicit helpers used within the redis cache implementation.

    Implicit helpers used within the redis cache implementation. These handful tools simplifies code readability but has no major function.

14. trait InternalCacheApi[Result[_]] extends AnyRef

    

    Cache API inspired by basic Play play.api.cache.CacheApi.

    Cache API inspired by basic Play play.api.cache.CacheApi. It implements all its operations and in addition it declares couple more useful operations handful with cache storage. Furthermore, due to its parametrization it allows to decide whether it produces blocking results or non-blocking promises.

15. trait JavaCacheApi extends cache.CacheApi

    

    Java version of play.api.CacheApi

16. class JavaRedis extends JavaCacheApi

    

    Annotations

    @Singleton()

17. class RedisActorProvider extends Provider[RedisActor]

    

    Constructs an actor directly communicating with the redis server.

    Constructs an actor directly communicating with the redis server. Internally, it uses connection settings and Brando connector but encapsulates it with additional logic.

    Annotations

    @Singleton()

18. class RedisCache[Result[_]] extends InternalCacheApi[Result] with Implicits

    

    Implementation of plain API using redis-server cache and Brando connector implementation.

19. class RedisCacheModule extends Module with CoreBinding with DefaultBinding with SyncOrAsync with ConfigurationProvider

    

    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()

20. trait RedisConnector extends AnyRef

    

    Internal non-blocking Redis API implementing REDIS protocol

    Internal non-blocking Redis API implementing REDIS protocol

    See also

    http://redis.io/commands

21. class RedisConnectorImpl extends RedisConnector

    

    The connector directly connects with the REDIS instance, implements protocol commands and is supposed to by used internally by another wrappers.

    The connector directly connects with the REDIS instance, implements protocol commands and is supposed to by used internally by another wrappers. The connector does not directly implement CacheApi but provides fundamental functionality.

    Annotations

    @Singleton()

22. class StaticConfiguration extends Configuration

    

    This configuration source reads the static configuration in the application.conf file and provides settings located in there.

    This configuration source reads the static configuration in the application.conf file and provides settings located in there. This is default configuration provider. It expects all settings under the 'play.cache.redis' node.

    Annotations

    @Singleton()

23. class SyncRedis extends RedisCache[Identity] with CacheApi with cache.CacheApi

    

    Annotations

    @Singleton()