Simplex.Messaging.Agent.Store

Store management

class Monad m => MonadAgentStore s m where

Store class type. Defines store access methods for implementations.

Methods

createRcvConn :: s -> RcvQueue -> m ()

createSndConn :: s -> SndQueue -> m ()

getConn :: s -> ConnAlias -> m SomeConn

getAllConnAliases :: s -> m [ConnAlias]

getRcvConn :: s -> SMPServer -> RecipientId -> m SomeConn

deleteConn :: s -> ConnAlias -> m ()

upgradeRcvConnToDuplex :: s -> ConnAlias -> SndQueue -> m ()

upgradeSndConnToDuplex :: s -> ConnAlias -> RcvQueue -> m ()

setRcvQueueStatus :: s -> RcvQueue -> QueueStatus -> m ()

setRcvQueueActive :: s -> RcvQueue -> VerificationKey -> m ()

setSndQueueStatus :: s -> SndQueue -> QueueStatus -> m ()

updateRcvIds :: s -> RcvQueue -> m (InternalId, InternalRcvId, PrevExternalSndId, PrevRcvMsgHash)

createRcvMsg :: s -> RcvQueue -> RcvMsgData -> m ()

updateSndIds :: s -> SndQueue -> m (InternalId, InternalSndId, PrevSndMsgHash)

createSndMsg :: s -> SndQueue -> SndMsgData -> m ()

getMsg :: s -> ConnAlias -> InternalId -> m Msg

Instances

(MonadUnliftIO m, MonadError StoreError m) => MonadAgentStore SQLiteStore m

Defined in Simplex.Messaging.Agent.Store.SQLite

Methods

createRcvConn :: SQLiteStore -> RcvQueue -> m ()

createSndConn :: SQLiteStore -> SndQueue -> m ()

getConn :: SQLiteStore -> ConnAlias -> m SomeConn

getAllConnAliases :: SQLiteStore -> m [ConnAlias]

getRcvConn :: SQLiteStore -> SMPServer -> RecipientId -> m SomeConn

deleteConn :: SQLiteStore -> ConnAlias -> m ()

upgradeRcvConnToDuplex :: SQLiteStore -> ConnAlias -> SndQueue -> m ()

upgradeSndConnToDuplex :: SQLiteStore -> ConnAlias -> RcvQueue -> m ()

setRcvQueueStatus :: SQLiteStore -> RcvQueue -> QueueStatus -> m ()

setRcvQueueActive :: SQLiteStore -> RcvQueue -> VerificationKey -> m ()

setSndQueueStatus :: SQLiteStore -> SndQueue -> QueueStatus -> m ()

updateRcvIds :: SQLiteStore -> RcvQueue -> m (InternalId, InternalRcvId, PrevExternalSndId, PrevRcvMsgHash)

createRcvMsg :: SQLiteStore -> RcvQueue -> RcvMsgData -> m ()

updateSndIds :: SQLiteStore -> SndQueue -> m (InternalId, InternalSndId, PrevSndMsgHash)

createSndMsg :: SQLiteStore -> SndQueue -> SndMsgData -> m ()

getMsg :: SQLiteStore -> ConnAlias -> InternalId -> m Msg

Queue types

data RcvQueue

A receive queue. SMP queue through which the agent receives messages from a sender.

Constructors

RcvQueue

Fields

• server :: SMPServer
• rcvId :: RecipientId
• connAlias :: ConnAlias
• rcvPrivateKey :: RecipientPrivateKey
• sndId :: Maybe SenderId
• sndKey :: Maybe SenderPublicKey
• decryptKey :: DecryptionKey
• verifyKey :: Maybe VerificationKey
• status :: QueueStatus

Instances

Eq RcvQueue

Defined in Simplex.Messaging.Agent.Store

Methods

(==) :: RcvQueue -> RcvQueue -> Bool

(/=) :: RcvQueue -> RcvQueue -> Bool

Show RcvQueue

Defined in Simplex.Messaging.Agent.Store

Methods

showsPrec :: Int -> RcvQueue -> ShowS

show :: RcvQueue -> String

showList :: [RcvQueue] -> ShowS

data SndQueue

A send queue. SMP queue through which the agent sends messages to a recipient.

Constructors

SndQueue

Fields

• server :: SMPServer
• sndId :: SenderId
• connAlias :: ConnAlias
• sndPrivateKey :: SenderPrivateKey
• encryptKey :: EncryptionKey
• signKey :: SignatureKey
• status :: QueueStatus

Instances

Eq SndQueue

Defined in Simplex.Messaging.Agent.Store

Methods

(==) :: SndQueue -> SndQueue -> Bool

(/=) :: SndQueue -> SndQueue -> Bool

Show SndQueue

Defined in Simplex.Messaging.Agent.Store

Methods

showsPrec :: Int -> SndQueue -> ShowS

show :: SndQueue -> String

showList :: [SndQueue] -> ShowS

Connection types

data ConnType

Type of a connection.

Constructors

CRcv

CSnd

CDuplex

Instances

Eq ConnType

Defined in Simplex.Messaging.Agent.Store

Methods

(==) :: ConnType -> ConnType -> Bool

(/=) :: ConnType -> ConnType -> Bool

Show ConnType

Defined in Simplex.Messaging.Agent.Store

Methods

showsPrec :: Int -> ConnType -> ShowS

show :: ConnType -> String

showList :: [ConnType] -> ShowS

TestEquality SConnType

Defined in Simplex.Messaging.Agent.Store

Methods

testEquality :: forall (a :: k) (b :: k). SConnType a -> SConnType b -> Maybe (a :~: b)

data Connection (d :: ConnType) where

Connection of a specific type.

• RcvConnection is a connection that only has a receive queue set up, typically created by a recipient initiating a duplex connection.
• SndConnection is a connection that only has a send queue set up, typically created by a sender joining a duplex connection through a recipient's invitation.
• DuplexConnection is a connection that has both receive and send queues set up, typically created by upgrading a receive or a send connection with a missing queue.

Constructors

RcvConnection :: ConnAlias -> RcvQueue -> Connection CRcv

SndConnection :: ConnAlias -> SndQueue -> Connection CSnd

DuplexConnection :: ConnAlias -> RcvQueue -> SndQueue -> Connection CDuplex

Instances

Eq (Connection d)

Defined in Simplex.Messaging.Agent.Store

Methods

(==) :: Connection d -> Connection d -> Bool

(/=) :: Connection d -> Connection d -> Bool

Show (Connection d)

Defined in Simplex.Messaging.Agent.Store

Methods

showsPrec :: Int -> Connection d -> ShowS

show :: Connection d -> String

showList :: [Connection d] -> ShowS

data SConnType :: ConnType -> Type where

Constructors

SCRcv :: SConnType CRcv

SCSnd :: SConnType CSnd

SCDuplex :: SConnType CDuplex

Instances

TestEquality SConnType

Defined in Simplex.Messaging.Agent.Store

Methods

testEquality :: forall (a :: k) (b :: k). SConnType a -> SConnType b -> Maybe (a :~: b)

Eq (SConnType d)

Defined in Simplex.Messaging.Agent.Store

Methods

(==) :: SConnType d -> SConnType d -> Bool

(/=) :: SConnType d -> SConnType d -> Bool

Show (SConnType d)

Defined in Simplex.Messaging.Agent.Store

Methods

showsPrec :: Int -> SConnType d -> ShowS

show :: SConnType d -> String

showList :: [SConnType d] -> ShowS

connType :: SConnType c -> ConnType

data SomeConn

Connection of an unknown type. Used to refer to an arbitrary connection when retrieving from store.

Constructors

forall d. SomeConn (SConnType d) (Connection d)

Instances

Eq SomeConn

Defined in Simplex.Messaging.Agent.Store

Methods

(==) :: SomeConn -> SomeConn -> Bool

(/=) :: SomeConn -> SomeConn -> Bool

Show SomeConn

Defined in Simplex.Messaging.Agent.Store

Methods

showsPrec :: Int -> SomeConn -> ShowS

show :: SomeConn -> String

showList :: [SomeConn] -> ShowS

Message integrity validation types

type MsgHash = ByteString

type PrevExternalSndId = Int64

Corresponds to last_external_snd_msg_id in connections table

type PrevRcvMsgHash = MsgHash

Corresponds to last_rcv_msg_hash in connections table

type PrevSndMsgHash = MsgHash

Corresponds to last_snd_msg_hash in connections table

Message data containers - used on Msg creation to reduce number of parameters

data RcvMsgData

Constructors

RcvMsgData

Fields

• internalId :: InternalId
• internalRcvId :: InternalRcvId
• internalTs :: InternalTs
• senderMeta :: (ExternalSndId, ExternalSndTs)
• brokerMeta :: (BrokerId, BrokerTs)
• msgBody :: MsgBody
• internalHash :: MsgHash
• externalPrevSndHash :: MsgHash
• msgIntegrity :: MsgIntegrity

data SndMsgData

Constructors

SndMsgData

Fields

• internalId :: InternalId
• internalSndId :: InternalSndId
• internalTs :: InternalTs
• msgBody :: MsgBody
• internalHash :: MsgHash

Message types

data Msg

A message in either direction that is stored by the agent.

Constructors

MRcv RcvMsg

MSnd SndMsg

Instances

Eq Msg

Defined in Simplex.Messaging.Agent.Store

Methods

(==) :: Msg -> Msg -> Bool

(/=) :: Msg -> Msg -> Bool

Show Msg

Defined in Simplex.Messaging.Agent.Store

Methods

showsPrec :: Int -> Msg -> ShowS

show :: Msg -> String

showList :: [Msg] -> ShowS

data RcvMsg

A message received by the agent from a sender.

Constructors

RcvMsg

Fields

• msgBase :: MsgBase
• internalRcvId :: InternalRcvId
• externalSndId :: ExternalSndId

  Id of the message at sender, corresponds to $sel:internalSndId:SndMsgData from the sender's side. Sender Id is made sequential for detection of missing messages. For redundant / parallel queues, it also allows to keep track of duplicates and restore the original order before delivery to the client.

• externalSndTs :: ExternalSndTs
• brokerId :: BrokerId

  Id of the message at broker, although it is not sequential (to avoid metadata leakage for potential observer), it is needed to track repeated deliveries in case of connection loss - this logic is not implemented yet.

• brokerTs :: BrokerTs
• rcvMsgStatus :: RcvMsgStatus
• ackBrokerTs :: AckBrokerTs

  Timestamp of acknowledgement to broker, corresponds to AcknowledgedToBroker status. Do not mix up with $sel:brokerTs:RcvMsg - timestamp created at broker after it receives the message from sender.

• ackSenderTs :: AckSenderTs

  Timestamp of acknowledgement to sender, corresponds to AcknowledgedToSender status. Do not mix up with $sel:externalSndTs:RcvMsg - timestamp created at sender before sending, which in its turn corresponds to $sel:internalTs:RcvMsgData in sending agent.

• externalPrevSndHash :: MsgHash

  Hash of previous message as received from sender - stored for integrity forensics.

• msgIntegrity :: MsgIntegrity

Instances

Eq RcvMsg

Defined in Simplex.Messaging.Agent.Store

Methods

(==) :: RcvMsg -> RcvMsg -> Bool

(/=) :: RcvMsg -> RcvMsg -> Bool

Show RcvMsg

Defined in Simplex.Messaging.Agent.Store

Methods

showsPrec :: Int -> RcvMsg -> ShowS

show :: RcvMsg -> String

showList :: [RcvMsg] -> ShowS

newtype InternalRcvId

Constructors

InternalRcvId

Fields

• unRcvId :: Int64

Instances

Eq InternalRcvId

Defined in Simplex.Messaging.Agent.Store

Methods

(==) :: InternalRcvId -> InternalRcvId -> Bool

(/=) :: InternalRcvId -> InternalRcvId -> Bool

Show InternalRcvId

Defined in Simplex.Messaging.Agent.Store

Methods

showsPrec :: Int -> InternalRcvId -> ShowS

show :: InternalRcvId -> String

showList :: [InternalRcvId] -> ShowS

FromField InternalRcvId

Defined in Simplex.Messaging.Agent.Store.SQLite

Methods

fromField :: FieldParser InternalRcvId

ToField InternalRcvId

Defined in Simplex.Messaging.Agent.Store.SQLite

Methods

toField :: InternalRcvId -> SQLData

type ExternalSndId = Int64

type ExternalSndTs = UTCTime

type BrokerId = MsgId

type BrokerTs = UTCTime

data RcvMsgStatus

Constructors

Received

AcknowledgedToBroker

AcknowledgedToSender

Instances

Eq RcvMsgStatus

Defined in Simplex.Messaging.Agent.Store

Methods

(==) :: RcvMsgStatus -> RcvMsgStatus -> Bool

(/=) :: RcvMsgStatus -> RcvMsgStatus -> Bool

Show RcvMsgStatus

Defined in Simplex.Messaging.Agent.Store

Methods

showsPrec :: Int -> RcvMsgStatus -> ShowS

show :: RcvMsgStatus -> String

showList :: [RcvMsgStatus] -> ShowS

ToField RcvMsgStatus

Defined in Simplex.Messaging.Agent.Store.SQLite

Methods

toField :: RcvMsgStatus -> SQLData

type AckBrokerTs = UTCTime

type AckSenderTs = UTCTime

data SndMsg

A message sent by the agent to a recipient.

Constructors

SndMsg

Fields

• msgBase :: MsgBase
• internalSndId :: InternalSndId

  Id of the message sent / to be sent, as in its number in order of sending.

• sndMsgStatus :: SndMsgStatus
• sentTs :: SentTs

  Timestamp of the message received by broker, corresponds to Sent status.

• deliveredTs :: DeliveredTs

  Timestamp of the message received by recipient, corresponds to Delivered status.

Instances

Eq SndMsg

Defined in Simplex.Messaging.Agent.Store

Methods

(==) :: SndMsg -> SndMsg -> Bool

(/=) :: SndMsg -> SndMsg -> Bool

Show SndMsg

Defined in Simplex.Messaging.Agent.Store

Methods

showsPrec :: Int -> SndMsg -> ShowS

show :: SndMsg -> String

showList :: [SndMsg] -> ShowS

newtype InternalSndId

Constructors

InternalSndId

Fields

• unSndId :: Int64

Instances

Eq InternalSndId

Defined in Simplex.Messaging.Agent.Store

Methods

(==) :: InternalSndId -> InternalSndId -> Bool

(/=) :: InternalSndId -> InternalSndId -> Bool

Show InternalSndId

Defined in Simplex.Messaging.Agent.Store

Methods

showsPrec :: Int -> InternalSndId -> ShowS

show :: InternalSndId -> String

showList :: [InternalSndId] -> ShowS

FromField InternalSndId

Defined in Simplex.Messaging.Agent.Store.SQLite

Methods

fromField :: FieldParser InternalSndId

ToField InternalSndId

Defined in Simplex.Messaging.Agent.Store.SQLite

Methods

toField :: InternalSndId -> SQLData

data SndMsgStatus

Constructors

Created

Sent

Delivered

Instances

Eq SndMsgStatus

Defined in Simplex.Messaging.Agent.Store

Methods

(==) :: SndMsgStatus -> SndMsgStatus -> Bool

(/=) :: SndMsgStatus -> SndMsgStatus -> Bool

Show SndMsgStatus

Defined in Simplex.Messaging.Agent.Store

Methods

showsPrec :: Int -> SndMsgStatus -> ShowS

show :: SndMsgStatus -> String

showList :: [SndMsgStatus] -> ShowS

ToField SndMsgStatus

Defined in Simplex.Messaging.Agent.Store.SQLite

Methods

toField :: SndMsgStatus -> SQLData

type SentTs = UTCTime

type DeliveredTs = UTCTime

data MsgBase

Base message data independent of direction.

Constructors

MsgBase

Fields

• connAlias :: ConnAlias
• internalId :: InternalId

  Monotonically increasing id of a message per connection, internal to the agent. Internal Id preserves ordering between both received and sent messages, and is needed to track the order of the conversation (which can be different for the sender / receiver) and address messages in commands. External [sender] Id cannot be used for this purpose due to a possibility of implementation errors in different agents.

• internalTs :: InternalTs
• msgBody :: MsgBody
• internalHash :: MsgHash

  Hash of the message as computed by agent.

Instances

Eq MsgBase

Defined in Simplex.Messaging.Agent.Store

Methods

(==) :: MsgBase -> MsgBase -> Bool

(/=) :: MsgBase -> MsgBase -> Bool

Show MsgBase

Defined in Simplex.Messaging.Agent.Store

Methods

showsPrec :: Int -> MsgBase -> ShowS

show :: MsgBase -> String

showList :: [MsgBase] -> ShowS

newtype InternalId

Constructors

InternalId

Fields

• unId :: Int64

Instances

Eq InternalId

Defined in Simplex.Messaging.Agent.Store

Methods

(==) :: InternalId -> InternalId -> Bool

(/=) :: InternalId -> InternalId -> Bool

Show InternalId

Defined in Simplex.Messaging.Agent.Store

Methods

showsPrec :: Int -> InternalId -> ShowS

show :: InternalId -> String

showList :: [InternalId] -> ShowS

FromField InternalId

Defined in Simplex.Messaging.Agent.Store.SQLite

Methods

fromField :: FieldParser InternalId

ToField InternalId

Defined in Simplex.Messaging.Agent.Store.SQLite

Methods

toField :: InternalId -> SQLData

type InternalTs = UTCTime

Store errors

data StoreError

Agent store error.

Constructors

SEInternal ByteString

IO exceptions in store actions.

SEConnNotFound

Connection alias not found (or both queues absent).

SEConnDuplicate

Connection alias already used.

SEBadConnType ConnType

Wrong connection type, e.g. "send" connection when "receive" or "duplex" is expected, or vice versa. upgradeRcvConnToDuplex and upgradeSndConnToDuplex do not allow duplex connections - they would also return this error.

SEBadQueueStatus

Currently not used. The intention was to pass current expected queue status in methods, as we always know what it should be at any stage of the protocol, and in case it does not match use this error.

SENotImplemented

Used in getMsg that is not implemented/used. TODO remove.

Instances

Eq StoreError

Defined in Simplex.Messaging.Agent.Store

Methods

(==) :: StoreError -> StoreError -> Bool

(/=) :: StoreError -> StoreError -> Bool

Show StoreError

Defined in Simplex.Messaging.Agent.Store

Methods

showsPrec :: Int -> StoreError -> ShowS

show :: StoreError -> String

showList :: [StoreError] -> ShowS

Exception StoreError

Defined in Simplex.Messaging.Agent.Store

Methods

toException :: StoreError -> SomeException

fromException :: SomeException -> Maybe StoreError

displayException :: StoreError -> String