redis

Type Members

1. trait AkkaSerializer extends AnyRef

   

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

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 Config extends Implicits

   

   Redis cache configuration providing settings of the cache instance to be used

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

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

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

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

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

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

13. class RedisCache[Result[_]] extends InternalCacheApi[Result] with Implicits with Config with AkkaSerializer

    

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

14. class RedisCacheModule extends Module 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()

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

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

    

    Annotations

    @Singleton()