Copyright	(c) Gargantext 2024-Present
License	AGPL
Maintainer	gargantext@iscpif.fr
Stability	experimental
Portability	POSIX
Safe Haskell	None
Language	Haskell2010

Async.Worker.Broker.Redis

Description

Based on lists: https:/redis.ioglossaryredis-queue

The design is as follows: - for each queue we have an 'id counter' - each queue is represented as a set of message ids - each message is stored under unique key, derived from its id - the above allows us to have an archive with messages - deleting a message means removing it's unique key from Redis

The queue itself is a list, the archive is a set (so that we can use SISMEMBER).

Synopsis

data RedisBroker
data family BrokerInitParams b a
data RedisWithMsgId a = RedisWithMsgId {
- rmida :: a
- rmidId :: Int
}

Documentation

data RedisBroker Source #

Instances

Instances details

(SerializableMessage a, Show a) => MessageBroker RedisBroker a Source #

Instance details

Defined in Async.Worker.Broker.Redis

Associated Types

data Broker RedisBroker a
Instance details Defined in Async.Worker.Broker.Redis data Broker RedisBroker a = RedisBroker' { conn :: Connection }
data BrokerMessage RedisBroker a
Instance details Defined in Async.Worker.Broker.Redis data BrokerMessage RedisBroker a = RedisBM (RedisWithMsgId a)
data Message RedisBroker a
Instance details Defined in Async.Worker.Broker.Redis data Message RedisBroker a = RedisM a
data MessageId RedisBroker
Instance details Defined in Async.Worker.Broker.Redis data MessageId RedisBroker = RedisMid Int
data BrokerInitParams RedisBroker a
Instance details Defined in Async.Worker.Broker.Redis data BrokerInitParams RedisBroker a = RedisBrokerInitParams ConnectInfo

Methods

messageId :: BrokerMessage RedisBroker a -> MessageId RedisBroker #

getMessage :: BrokerMessage RedisBroker a -> Message RedisBroker a #

toMessage :: a -> Message RedisBroker a #

toA :: Message RedisBroker a -> a #

initBroker :: BrokerInitParams RedisBroker a -> IO (Broker RedisBroker a) #

deinitBroker :: Broker RedisBroker a -> IO () #

createQueue :: Broker RedisBroker a -> Queue -> IO () #

dropQueue :: Broker RedisBroker a -> Queue -> IO () #

readMessageWaiting :: Broker RedisBroker a -> Queue -> IO (BrokerMessage RedisBroker a) #

popMessageWaiting :: Broker RedisBroker a -> Queue -> IO (BrokerMessage RedisBroker a) #

setMessageTimeout :: Broker RedisBroker a -> Queue -> MessageId RedisBroker -> TimeoutS -> IO () #

sendMessage :: Broker RedisBroker a -> Queue -> Message RedisBroker a -> IO (MessageId RedisBroker) #

sendMessageDelayed :: Broker RedisBroker a -> Queue -> Message RedisBroker a -> TimeoutS -> IO (MessageId RedisBroker) #

deleteMessage :: Broker RedisBroker a -> Queue -> MessageId RedisBroker -> IO () #

archiveMessage :: Broker RedisBroker a -> Queue -> MessageId RedisBroker -> IO () #

getQueueSize :: Broker RedisBroker a -> Queue -> IO Int #

getArchivedMessage :: Broker RedisBroker a -> Queue -> MessageId RedisBroker -> IO (Maybe (BrokerMessage RedisBroker a)) #

listPendingMessageIds :: Broker RedisBroker a -> Queue -> IO [MessageId RedisBroker] #

getMessageById :: Broker RedisBroker a -> Queue -> MessageId RedisBroker -> IO (Maybe (BrokerMessage RedisBroker a)) #

FromJSON (MessageId RedisBroker) Source #

Instance details

Defined in Async.Worker.Broker.Redis

Methods

parseJSON :: Value -> Parser (MessageId RedisBroker) #

parseJSONList :: Value -> Parser [MessageId RedisBroker] #

omittedField :: Maybe (MessageId RedisBroker) #

ToJSON (MessageId RedisBroker) Source #

Instance details

Defined in Async.Worker.Broker.Redis

Methods

toJSON :: MessageId RedisBroker -> Value #

toEncoding :: MessageId RedisBroker -> Encoding #

toJSONList :: [MessageId RedisBroker] -> Value #

toEncodingList :: [MessageId RedisBroker] -> Encoding #

omitField :: MessageId RedisBroker -> Bool #

Show (MessageId RedisBroker) Source #

Instance details

Defined in Async.Worker.Broker.Redis

Methods

showsPrec :: Int -> MessageId RedisBroker -> ShowS #

show :: MessageId RedisBroker -> String #

showList :: [MessageId RedisBroker] -> ShowS #

Eq (MessageId RedisBroker) Source #

Instance details

Defined in Async.Worker.Broker.Redis

Methods

(==) :: MessageId RedisBroker -> MessageId RedisBroker -> Bool #

(/=) :: MessageId RedisBroker -> MessageId RedisBroker -> Bool #

Ord (MessageId RedisBroker) Source #

Instance details

Defined in Async.Worker.Broker.Redis

Methods

compare :: MessageId RedisBroker -> MessageId RedisBroker -> Ordering #

(<) :: MessageId RedisBroker -> MessageId RedisBroker -> Bool #

(<=) :: MessageId RedisBroker -> MessageId RedisBroker -> Bool #

(>) :: MessageId RedisBroker -> MessageId RedisBroker -> Bool #

(>=) :: MessageId RedisBroker -> MessageId RedisBroker -> Bool #

max :: MessageId RedisBroker -> MessageId RedisBroker -> MessageId RedisBroker #

min :: MessageId RedisBroker -> MessageId RedisBroker -> MessageId RedisBroker #

Show a => Show (BrokerMessage RedisBroker a) Source #

Instance details

Defined in Async.Worker.Broker.Redis

Methods

showsPrec :: Int -> BrokerMessage RedisBroker a -> ShowS #

show :: BrokerMessage RedisBroker a -> String #

showList :: [BrokerMessage RedisBroker a] -> ShowS #

data Broker RedisBroker a Source #

Instance details

Defined in Async.Worker.Broker.Redis

data Broker RedisBroker a = RedisBroker' {

conn :: Connection

}

data BrokerInitParams RedisBroker a Source #

Instance details

Defined in Async.Worker.Broker.Redis

data BrokerInitParams RedisBroker a = RedisBrokerInitParams ConnectInfo

data BrokerMessage RedisBroker a Source #

Instance details

Defined in Async.Worker.Broker.Redis

data BrokerMessage RedisBroker a = RedisBM (RedisWithMsgId a)

data Message RedisBroker a Source #

Instance details

Defined in Async.Worker.Broker.Redis

data Message RedisBroker a = RedisM a

data MessageId RedisBroker Source #

Instance details

Defined in Async.Worker.Broker.Redis

data MessageId RedisBroker = RedisMid Int

data family BrokerInitParams b a #

All the parameters needed for broker intialization

Instances

Instances details

data BrokerInitParams RedisBroker a Source #
Instance details Defined in Async.Worker.Broker.Redis data BrokerInitParams RedisBroker a = RedisBrokerInitParams ConnectInfo

data RedisWithMsgId a Source #

Helper datatype to store message with a unique id. We fetch the id by using INCR https://redis.io/docs/latest/commands/incr/

Constructors

RedisWithMsgId
Fields rmida :: a rmidId :: Int

Instances

Instances details

FromJSON a => FromJSON (RedisWithMsgId a) Source #
Instance details Defined in Async.Worker.Broker.Redis Methods parseJSON :: Value -> Parser (RedisWithMsgId a) # parseJSONList :: Value -> Parser [RedisWithMsgId a] # omittedField :: Maybe (RedisWithMsgId a) #
ToJSON a => ToJSON (RedisWithMsgId a) Source #
Instance details Defined in Async.Worker.Broker.Redis Methods toJSON :: RedisWithMsgId a -> Value # toEncoding :: RedisWithMsgId a -> Encoding # toJSONList :: [RedisWithMsgId a] -> Value # toEncodingList :: [RedisWithMsgId a] -> Encoding # omitField :: RedisWithMsgId a -> Bool #
Show a => Show (RedisWithMsgId a) Source #
Instance details Defined in Async.Worker.Broker.Redis Methods showsPrec :: Int -> RedisWithMsgId a -> ShowS # show :: RedisWithMsgId a -> String # showList :: [RedisWithMsgId a] -> ShowS #
Eq a => Eq (RedisWithMsgId a) Source #
Instance details Defined in Async.Worker.Broker.Redis Methods (==) :: RedisWithMsgId a -> RedisWithMsgId a -> Bool # (/=) :: RedisWithMsgId a -> RedisWithMsgId a -> Bool #