Freckle.App.Memcached

App-level caching backed by Memcached

Usage:

1. Have a Reader-like monad stack over some App
2. Set up that App with HasMemcachedClient
3. Give the value to cache a Cachable instance
4. Use caching

To avoid Cachable, see cachingAs and cachingAsJSON.

Documentation

class Cachable a where

Methods

toCachable :: a -> ByteString

fromCachable :: ByteString -> Either String a

Instances

Cachable ByteString

Defined in Freckle.App.Memcached

Methods

toCachable :: ByteString -> ByteString

fromCachable :: ByteString -> Either String ByteString

Cachable ByteString

Defined in Freckle.App.Memcached

Methods

toCachable :: ByteString -> ByteString0

fromCachable :: ByteString0 -> Either String ByteString

Cachable Text

Defined in Freckle.App.Memcached

Methods

toCachable :: Text -> ByteString

fromCachable :: ByteString -> Either String Text

caching :: (MonadUnliftIO m, MonadLogger m, MonadTracer m, MonadReader env m, HasMemcachedClient env, Cachable a, HasCallStack) => CacheKey -> CacheTTL -> m a -> m a

Memoize an action using Memcached and Cachable

cachingAs :: (MonadUnliftIO m, MonadLogger m, MonadTracer m, MonadReader env m, HasMemcachedClient env, HasCallStack) => (ByteString -> Either String a) -> (a -> ByteString) -> CacheKey -> CacheTTL -> m a -> m a

Like caching, but with explicit conversion functions

cachingAsJSON :: (MonadUnliftIO m, MonadLogger m, MonadTracer m, MonadReader env m, HasMemcachedClient env, FromJSON a, ToJSON a, HasCallStack) => CacheKey -> CacheTTL -> m a -> m a

Like caching, but de/serializing the value as JSON

cachingAsCBOR :: (MonadUnliftIO m, MonadLogger m, MonadTracer m, MonadReader env m, HasMemcachedClient env, Serialise a, HasCallStack) => CacheKey -> CacheTTL -> m a -> m a

Cache data in memcached in CBOR format

Re-exports

class HasMemcachedClient env where

Methods

memcachedClientL :: Lens' env MemcachedClient

Instances

HasMemcachedClient MemcachedClient

Defined in Freckle.App.Memcached.Client

Methods

memcachedClientL :: Lens' MemcachedClient MemcachedClient

HasMemcachedClient site => HasMemcachedClient (HandlerData child site)

Defined in Freckle.App.Memcached.Client

Methods

memcachedClientL :: Lens' (HandlerData child site) MemcachedClient

module Freckle.App.Memcached.CacheKey

module Freckle.App.Memcached.CacheTTL

module Freckle.App.Memcached.MD5