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

Instances

Instances details

Eq RcvQueue Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods (==) :: RcvQueue -> RcvQueue -> Bool # (/=) :: RcvQueue -> RcvQueue -> Bool #
Show RcvQueue Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods showsPrec :: Int -> RcvQueue -> ShowS # show :: RcvQueue -> String # showList :: [RcvQueue] -> ShowS #

data SndQueue Source #

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

Instances details

Eq SndQueue Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods (==) :: SndQueue -> SndQueue -> Bool # (/=) :: SndQueue -> SndQueue -> Bool #
Show SndQueue Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods showsPrec :: Int -> SndQueue -> ShowS # show :: SndQueue -> String # showList :: [SndQueue] -> ShowS #

Connection types

data ConnType Source #

Type of a connection.

Constructors

CRcv
CSnd
CDuplex

Instances

Instances details

Eq ConnType Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods (==) :: ConnType -> ConnType -> Bool # (/=) :: ConnType -> ConnType -> Bool #
Show ConnType Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods showsPrec :: Int -> ConnType -> ShowS # show :: ConnType -> String # showList :: [ConnType] -> ShowS #
TestEquality SConnType Source #
Instance details 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 Source #

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

Instances details

Eq (Connection d) Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods (==) :: Connection d -> Connection d -> Bool # (/=) :: Connection d -> Connection d -> Bool #
Show (Connection d) Source #
Instance details 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 Source #

Constructors

SCRcv :: SConnType CRcv
SCSnd :: SConnType CSnd
SCDuplex :: SConnType CDuplex

Instances

Instances details

TestEquality SConnType Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods testEquality :: forall (a :: k) (b :: k). SConnType a -> SConnType b -> Maybe (a :~: b) #
Eq (SConnType d) Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods (==) :: SConnType d -> SConnType d -> Bool # (/=) :: SConnType d -> SConnType d -> Bool #
Show (SConnType d) Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods showsPrec :: Int -> SConnType d -> ShowS # show :: SConnType d -> String # showList :: [SConnType d] -> ShowS #

connType :: SConnType c -> ConnType Source #

data SomeConn Source #

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

Instances details

Eq SomeConn Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods (==) :: SomeConn -> SomeConn -> Bool # (/=) :: SomeConn -> SomeConn -> Bool #
Show SomeConn Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods showsPrec :: Int -> SomeConn -> ShowS # show :: SomeConn -> String # showList :: [SomeConn] -> ShowS #

Message integrity validation types

type MsgHash = ByteString Source #

type PrevExternalSndId = Int64 Source #

Corresponds to last_external_snd_msg_id in connections table

type PrevRcvMsgHash = MsgHash Source #

Corresponds to last_rcv_msg_hash in connections table

type PrevSndMsgHash = MsgHash Source #

Corresponds to last_snd_msg_hash in connections table

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

data RcvMsgData Source #

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 Source #

Constructors

SndMsgData
Fields internalId :: InternalId internalSndId :: InternalSndId internalTs :: InternalTs msgBody :: MsgBody internalHash :: MsgHash

Message types

data Msg Source #

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

Constructors

MRcv RcvMsg
MSnd SndMsg

Instances

Instances details

Eq Msg Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods (==) :: Msg -> Msg -> Bool # (/=) :: Msg -> Msg -> Bool #
Show Msg Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods showsPrec :: Int -> Msg -> ShowS # show :: Msg -> String # showList :: [Msg] -> ShowS #

data RcvMsg Source #

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

Instances details

Eq RcvMsg Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods (==) :: RcvMsg -> RcvMsg -> Bool # (/=) :: RcvMsg -> RcvMsg -> Bool #
Show RcvMsg Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods showsPrec :: Int -> RcvMsg -> ShowS # show :: RcvMsg -> String # showList :: [RcvMsg] -> ShowS #

newtype InternalRcvId Source #

Constructors

InternalRcvId
Fields unRcvId :: Int64

Instances

Instances details

Eq InternalRcvId Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods (==) :: InternalRcvId -> InternalRcvId -> Bool # (/=) :: InternalRcvId -> InternalRcvId -> Bool #
Show InternalRcvId Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods showsPrec :: Int -> InternalRcvId -> ShowS # show :: InternalRcvId -> String # showList :: [InternalRcvId] -> ShowS #
FromField InternalRcvId Source #
Instance details Defined in Simplex.Messaging.Agent.Store.SQLite Methods fromField :: FieldParser InternalRcvId #
ToField InternalRcvId Source #
Instance details Defined in Simplex.Messaging.Agent.Store.SQLite Methods toField :: InternalRcvId -> SQLData #

type ExternalSndId = Int64 Source #

type ExternalSndTs = UTCTime Source #

type BrokerId = MsgId Source #

type BrokerTs = UTCTime Source #

data RcvMsgStatus Source #

Constructors

Received
AcknowledgedToBroker
AcknowledgedToSender

Instances

Instances details

Eq RcvMsgStatus Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods (==) :: RcvMsgStatus -> RcvMsgStatus -> Bool # (/=) :: RcvMsgStatus -> RcvMsgStatus -> Bool #
Show RcvMsgStatus Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods showsPrec :: Int -> RcvMsgStatus -> ShowS # show :: RcvMsgStatus -> String # showList :: [RcvMsgStatus] -> ShowS #
ToField RcvMsgStatus Source #
Instance details Defined in Simplex.Messaging.Agent.Store.SQLite Methods toField :: RcvMsgStatus -> SQLData #

type AckBrokerTs = UTCTime Source #

type AckSenderTs = UTCTime Source #

data SndMsg Source #

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

Instances details

Eq SndMsg Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods (==) :: SndMsg -> SndMsg -> Bool # (/=) :: SndMsg -> SndMsg -> Bool #
Show SndMsg Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods showsPrec :: Int -> SndMsg -> ShowS # show :: SndMsg -> String # showList :: [SndMsg] -> ShowS #

newtype InternalSndId Source #

Constructors

InternalSndId
Fields unSndId :: Int64

Instances

Instances details

Eq InternalSndId Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods (==) :: InternalSndId -> InternalSndId -> Bool # (/=) :: InternalSndId -> InternalSndId -> Bool #
Show InternalSndId Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods showsPrec :: Int -> InternalSndId -> ShowS # show :: InternalSndId -> String # showList :: [InternalSndId] -> ShowS #
FromField InternalSndId Source #
Instance details Defined in Simplex.Messaging.Agent.Store.SQLite Methods fromField :: FieldParser InternalSndId #
ToField InternalSndId Source #
Instance details Defined in Simplex.Messaging.Agent.Store.SQLite Methods toField :: InternalSndId -> SQLData #

data SndMsgStatus Source #

Constructors

Created
Sent
Delivered

Instances

Instances details

Eq SndMsgStatus Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods (==) :: SndMsgStatus -> SndMsgStatus -> Bool # (/=) :: SndMsgStatus -> SndMsgStatus -> Bool #
Show SndMsgStatus Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods showsPrec :: Int -> SndMsgStatus -> ShowS # show :: SndMsgStatus -> String # showList :: [SndMsgStatus] -> ShowS #
ToField SndMsgStatus Source #
Instance details Defined in Simplex.Messaging.Agent.Store.SQLite Methods toField :: SndMsgStatus -> SQLData #

type SentTs = UTCTime Source #

type DeliveredTs = UTCTime Source #

data MsgBase Source #

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

Instances details

Eq MsgBase Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods (==) :: MsgBase -> MsgBase -> Bool # (/=) :: MsgBase -> MsgBase -> Bool #
Show MsgBase Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods showsPrec :: Int -> MsgBase -> ShowS # show :: MsgBase -> String # showList :: [MsgBase] -> ShowS #

newtype InternalId Source #

Constructors

InternalId
Fields unId :: Int64

Instances

Instances details

Eq InternalId Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods (==) :: InternalId -> InternalId -> Bool # (/=) :: InternalId -> InternalId -> Bool #
Show InternalId Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods showsPrec :: Int -> InternalId -> ShowS # show :: InternalId -> String # showList :: [InternalId] -> ShowS #
FromField InternalId Source #
Instance details Defined in Simplex.Messaging.Agent.Store.SQLite Methods fromField :: FieldParser InternalId #
ToField InternalId Source #
Instance details Defined in Simplex.Messaging.Agent.Store.SQLite Methods toField :: InternalId -> SQLData #

type InternalTs = UTCTime Source #

Store errors

data StoreError Source #

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

Instances details

Eq StoreError Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods (==) :: StoreError -> StoreError -> Bool # (/=) :: StoreError -> StoreError -> Bool #
Show StoreError Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods showsPrec :: Int -> StoreError -> ShowS # show :: StoreError -> String # showList :: [StoreError] -> ShowS #
Exception StoreError Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods toException :: StoreError -> SomeException # fromException :: SomeException -> Maybe StoreError # displayException :: StoreError -> String #