Safe Haskell	Safe-Inferred
Language	Haskell2010

Simplex.Messaging.Agent.Store

Synopsis

type RcvQueue = StoredRcvQueue 'DBStored
type NewRcvQueue = StoredRcvQueue 'DBNew
data StoredRcvQueue (q :: DBStored) = RcvQueue {
- userId :: UserId
- connId :: ConnId
- server :: SMPServer
- rcvId :: RecipientId
- rcvPrivateKey :: RcvPrivateAuthKey
- rcvDhSecret :: RcvDhSecret
- e2ePrivKey :: PrivateKeyX25519
- e2eDhSecret :: Maybe DhSecretX25519
- sndId :: SenderId
- queueMode :: Maybe QueueMode
- shortLink :: Maybe ShortLinkCreds
- clientService :: Maybe (StoredClientService q)
- status :: QueueStatus
- enableNtfs :: Bool
- clientNoticeId :: Maybe NoticeId
- dbQueueId :: DBEntityId' q
- primary :: Bool
- dbReplaceQueueId :: Maybe Int64
- rcvSwchStatus :: Maybe RcvSwitchStatus
- smpClientVersion :: VersionSMPC
- clientNtfCreds :: Maybe ClientNtfCreds
- deleteErrors :: Int
}
data RcvQueueSub = RcvQueueSub {
- userId :: UserId
- connId :: ConnId
- server :: SMPServer
- rcvId :: RecipientId
- rcvPrivateKey :: RcvPrivateAuthKey
- status :: QueueStatus
- enableNtfs :: Bool
- clientNoticeId :: Maybe NoticeId
- dbQueueId :: Int64
- primary :: Bool
- dbReplaceQueueId :: Maybe Int64
}
data ClientNtfCreds = ClientNtfCreds {
- ntfPublicKey :: NtfPublicAuthKey
- ntfPrivateKey :: NtfPrivateAuthKey
- notifierId :: NotifierId
- rcvNtfDhSecret :: RcvNtfDhSecret
}
data InvShortLink = InvShortLink {
- server :: SMPServer
- linkId :: LinkId
- linkKey :: LinkKey
- sndPrivateKey :: SndPrivateAuthKey
- sndId :: Maybe SenderId
}
type SndQueue = StoredSndQueue 'DBStored
type NewSndQueue = StoredSndQueue 'DBNew
data StoredSndQueue (q :: DBStored) = SndQueue {
- userId :: UserId
- connId :: ConnId
- server :: SMPServer
- sndId :: SenderId
- queueMode :: Maybe QueueMode
- sndPrivateKey :: SndPrivateAuthKey
- e2ePubKey :: Maybe PublicKeyX25519
- e2eDhSecret :: DhSecretX25519
- status :: QueueStatus
- dbQueueId :: DBEntityId' q
- primary :: Bool
- dbReplaceQueueId :: Maybe Int64
- sndSwchStatus :: Maybe SndSwitchStatus
- smpClientVersion :: VersionSMPC
}
class SMPQueue q => SMPQueueRec q where
- qUserId :: q -> UserId
- qConnId :: q -> ConnId
- dbQId :: q -> Int64
- qPrimary :: q -> Bool
- dbReplaceQId :: q -> Maybe Int64
class SMPQueueRec q => SomeRcvQueue q where
- rcvAuthKey :: q -> RcvPrivateAuthKey
data ConnType
- = CNew
- | CRcv
- | CSnd
- | CDuplex
- | CContact
data Connection' (d :: ConnType) rq sq where
- NewConnection :: ConnData -> Connection' CNew rq sq
- RcvConnection :: ConnData -> rq -> Connection' CRcv rq sq
- SndConnection :: ConnData -> sq -> Connection' CSnd rq sq
- DuplexConnection :: ConnData -> NonEmpty rq -> NonEmpty sq -> Connection' CDuplex rq sq
- ContactConnection :: ConnData -> rq -> Connection' CContact rq sq
type Connection d = Connection' d RcvQueue SndQueue
data SConnType :: ConnType -> Type where
- SCNew :: SConnType CNew
- SCRcv :: SConnType CRcv
- SCSnd :: SConnType CSnd
- SCDuplex :: SConnType CDuplex
- SCContact :: SConnType CContact
data SomeConn' rq sq = forall d. SomeConn (SConnType d) (Connection' d rq sq)
type SomeConn = SomeConn' RcvQueue SndQueue
type SomeConnSub = SomeConn' RcvQueueSub SndQueue
data ConnData = ConnData {
- connId :: ConnId
- userId :: UserId
- connAgentVersion :: VersionSMPA
- enableNtfs :: Bool
- lastExternalSndId :: PrevExternalSndId
- deleted :: Bool
- ratchetSyncState :: RatchetSyncState
- pqSupport :: PQSupport
}
type NoticeId = Int64
data PendingCommand = PendingCommand {
- cmdId :: AsyncCmdId
- corrId :: ACorrId
- userId :: UserId
- connId :: ConnId
- command :: AgentCommand
}
data AgentCmdType
- = ACClient
- | ACInternal
data AgentCommand
- = AClientCommand ACommand
- | AInternalCommand InternalCommand
data AgentCommandTag
- = AClientCommandTag ACommandTag
- | AInternalCommandTag InternalCommandTag
data InternalCommand
- = ICAck RecipientId MsgId
- | ICAckDel RecipientId MsgId InternalId
- | ICAllowSecure RecipientId (Maybe SndPublicAuthKey)
- | ICDuplexSecure RecipientId SndPublicAuthKey
- | ICDeleteConn
- | ICDeleteRcvQueue RecipientId
- | ICQSecure RecipientId SndPublicAuthKey
- | ICQDelete RecipientId
data InternalCommandTag
- = ICAck_
- | ICAckDel_
- | ICAllowSecure_
- | ICDuplexSecure_
- | ICDeleteConn_
- | ICDeleteRcvQueue_
- | ICQSecure_
- | ICQDelete_
data NewConfirmation = NewConfirmation {
- connId :: ConnId
- senderConf :: SMPConfirmation
- ratchetState :: RatchetX448
}
data AcceptedConfirmation = AcceptedConfirmation {
- confirmationId :: ConfirmationId
- connId :: ConnId
- senderConf :: SMPConfirmation
- ratchetState :: RatchetX448
- ownConnInfo :: ConnInfo
}
data NewInvitation = NewInvitation {
- contactConnId :: ConnId
- connReq :: ConnectionRequestUri 'CMInvitation
- recipientConnInfo :: ConnInfo
}
data Invitation = Invitation {
- invitationId :: InvitationId
- contactConnId_ :: Maybe ConnId
- connReq :: ConnectionRequestUri 'CMInvitation
- recipientConnInfo :: ConnInfo
- ownConnInfo :: Maybe ConnInfo
- accepted :: Bool
}
type PrevExternalSndId = Int64
type PrevRcvMsgHash = MsgHash
type PrevSndMsgHash = MsgHash
data RcvMsgData = RcvMsgData {
- msgMeta :: MsgMeta
- msgType :: AgentMessageType
- msgFlags :: MsgFlags
- msgBody :: MsgBody
- internalRcvId :: InternalRcvId
- internalHash :: MsgHash
- externalPrevSndHash :: MsgHash
- encryptedMsgHash :: MsgHash
}
data RcvMsg = RcvMsg {
- internalId :: InternalId
- msgMeta :: MsgMeta
- msgType :: AgentMessageType
- msgBody :: MsgBody
- internalHash :: MsgHash
- msgReceipt :: Maybe MsgReceipt
- userAck :: Bool
}
data SndMsgData = SndMsgData {
- internalId :: InternalId
- internalSndId :: InternalSndId
- internalTs :: InternalTs
- msgType :: AgentMessageType
- msgFlags :: MsgFlags
- msgBody :: MsgBody
- pqEncryption :: PQEncryption
- internalHash :: MsgHash
- prevMsgHash :: MsgHash
- sndMsgPrepData_ :: Maybe SndMsgPrepData
}
data SndMsgPrepData = SndMsgPrepData {
- encryptKey :: MsgEncryptKeyX448
- paddedLen :: Int
- sndMsgBodyId :: Int64
}
data SndMsg = SndMsg {
- internalId :: InternalId
- internalSndId :: InternalSndId
- msgType :: AgentMessageType
- internalHash :: MsgHash
- msgReceipt :: Maybe MsgReceipt
}
data PendingMsgData = PendingMsgData {
- msgId :: InternalId
- msgType :: AgentMessageType
- msgFlags :: MsgFlags
- msgBody :: MsgBody
- pqEncryption :: PQEncryption
- msgRetryState :: Maybe RI2State
- internalTs :: InternalTs
- internalSndId :: InternalSndId
- prevMsgHash :: PrevSndMsgHash
- pendingMsgPrepData_ :: Maybe PendingMsgPrepData
}
data PendingMsgPrepData = PendingMsgPrepData {
- encryptKey :: MsgEncryptKeyX448
- paddedLen :: Int
- sndMsgBody :: AMessage
}
newtype InternalRcvId = InternalRcvId {
- unRcvId :: Int64
}
type ExternalSndId = Int64
type ExternalSndTs = UTCTime
type BrokerId = MsgId
type BrokerTs = UTCTime
newtype InternalSndId = InternalSndId {
- unSndId :: Int64
}
data MsgBase = MsgBase {
- connId :: ConnId
- internalId :: InternalId
- internalTs :: InternalTs
- msgBody :: MsgBody
- internalHash :: MsgHash
}
newtype InternalId = InternalId {
- unId :: Int64
}
type InternalTs = UTCTime
type AsyncCmdId = Int64
data StoreError
- = SEInternal ByteString
- | SEDatabaseBusy ByteString
- | SEUniqueID
- | SEUserNotFound
- | SEConnNotFound
- | SEServerNotFound
- | SEConnDuplicate
- | SESndQueueExists
- | SEBadConnType String ConnType
- | SEConfirmationNotFound
- | SEInvitationNotFound String InvitationId
- | SEMsgNotFound String
- | SECmdNotFound
- | SEBadQueueStatus
- | SERatchetNotFound
- | SEX3dhKeysNotFound
- | SEAgentError AgentErrorType
- | SEXFTPServerNotFound
- | SEFileNotFound
- | SEDeletedSndChunkReplicaNotFound
- | SEWorkItemError {
  - errContext :: String
  }
- | SEServersStatsNotFound
class (Show e, AnyError e) => AnyStoreError e where
- isWorkItemError :: e -> Bool
- mkWorkItemError :: String -> e
createStore :: DBOpts -> MigrationConfig -> IO (Either MigrationError DBStore)
rcvQueueSub :: RcvQueue -> RcvQueueSub
clientServiceId :: RcvQueue -> Maybe ClientServiceId
rcvSMPQueueAddress :: RcvQueue -> SMPQueueAddress
canAbortRcvSwitch :: RcvQueue -> Bool
findQ :: SMPQueue q => (SMPServer, QueueId) -> NonEmpty q -> Maybe q
removeQ :: SMPQueue q => (SMPServer, QueueId) -> NonEmpty q -> Maybe (q, [q])
removeQP :: (q -> Bool) -> NonEmpty q -> Maybe (q, [q])
sndAddress :: RcvQueue -> (SMPServer, SenderId)
findRQ :: (SMPServer, SenderId) -> NonEmpty RcvQueue -> Maybe RcvQueue
switchingRQ :: NonEmpty RcvQueue -> Maybe RcvQueue
updatedQs :: SMPQueueRec q => q -> NonEmpty q -> NonEmpty q
toConnData :: Connection' d rq sq -> ConnData
updateConnection :: ConnData -> Connection' d rq sq -> Connection' d rq sq
connType :: SConnType c -> ConnType
ratchetSyncAllowed :: ConnData -> Bool
ratchetSyncSendProhibited :: ConnData -> Bool
agentCommandTag :: AgentCommand -> AgentCommandTag
internalCmdTag :: InternalCommand -> InternalCommandTag

Documentation

type RcvQueue = StoredRcvQueue 'DBStored Source #

type NewRcvQueue = StoredRcvQueue 'DBNew Source #

data StoredRcvQueue (q :: DBStored) Source #

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

Constructors

RcvQueue

Fields

userId :: UserId
connId :: ConnId
server :: SMPServer
rcvId :: RecipientId
recipient queue ID
rcvPrivateKey :: RcvPrivateAuthKey
key used by the recipient to authorize transmissions
rcvDhSecret :: RcvDhSecret
shared DH secret used to encrypt/decrypt message bodies from server to recipient
e2ePrivKey :: PrivateKeyX25519
private DH key related to public sent to sender out-of-band (to agree simple per-queue e2e)
e2eDhSecret :: Maybe DhSecretX25519
public sender's DH key and agreed shared DH secret for simple per-queue e2e
sndId :: SenderId
sender queue ID
queueMode :: Maybe QueueMode
sender can secure the queue
shortLink :: Maybe ShortLinkCreds
short link ID and credentials
clientService :: Maybe (StoredClientService q)
associated client service
status :: QueueStatus
queue status
enableNtfs :: Bool
to enable notifications for this queue - this field is duplicated from ConnData
clientNoticeId :: Maybe NoticeId
client notice
dbQueueId :: DBEntityId' q
database queue ID (within connection)
primary :: Bool
True for a primary or a next primary queue of the connection (next if dbReplaceQueueId is set)
dbReplaceQueueId :: Maybe Int64
database queue ID to replace, Nothing if this queue is not replacing another, `Just Nothing` is used for replacing old queues
rcvSwchStatus :: Maybe RcvSwitchStatus
smpClientVersion :: VersionSMPC
SMP client version
clientNtfCreds :: Maybe ClientNtfCreds
credentials used in context of notifications
deleteErrors :: Int

Instances

Instances details

SMPQueue NewRcvQueue Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods qServer :: NewRcvQueue -> SMPServer Source # queueId :: NewRcvQueue -> QueueId Source #
SMPQueue RcvQueue Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods qServer :: RcvQueue -> SMPServer Source # queueId :: RcvQueue -> QueueId Source #
SMPQueueRec RcvQueue Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods qUserId :: RcvQueue -> UserId Source # qConnId :: RcvQueue -> ConnId Source # dbQId :: RcvQueue -> Int64 Source # qPrimary :: RcvQueue -> Bool Source # dbReplaceQId :: RcvQueue -> Maybe Int64 Source #
SomeRcvQueue RcvQueue Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods rcvAuthKey :: RcvQueue -> RcvPrivateAuthKey Source #
Show (StoredRcvQueue q) Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods showsPrec :: Int -> StoredRcvQueue q -> ShowS show :: StoredRcvQueue q -> String showList :: [StoredRcvQueue q] -> ShowS

data RcvQueueSub Source #

Constructors

RcvQueueSub
Fields userId :: UserId connId :: ConnId server :: SMPServer rcvId :: RecipientId rcvPrivateKey :: RcvPrivateAuthKey status :: QueueStatus enableNtfs :: Bool clientNoticeId :: Maybe NoticeId dbQueueId :: Int64 primary :: Bool dbReplaceQueueId :: Maybe Int64

Instances

Instances details

Show RcvQueueSub Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods showsPrec :: Int -> RcvQueueSub -> ShowS show :: RcvQueueSub -> String showList :: [RcvQueueSub] -> ShowS
SMPQueue RcvQueueSub Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods qServer :: RcvQueueSub -> SMPServer Source # queueId :: RcvQueueSub -> QueueId Source #
SMPQueueRec RcvQueueSub Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods qUserId :: RcvQueueSub -> UserId Source # qConnId :: RcvQueueSub -> ConnId Source # dbQId :: RcvQueueSub -> Int64 Source # qPrimary :: RcvQueueSub -> Bool Source # dbReplaceQId :: RcvQueueSub -> Maybe Int64 Source #
SomeRcvQueue RcvQueueSub Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods rcvAuthKey :: RcvQueueSub -> RcvPrivateAuthKey Source #

data ClientNtfCreds Source #

Constructors

ClientNtfCreds
Fields ntfPublicKey :: NtfPublicAuthKey key pair to be used by the notification server to authorize transmissions ntfPrivateKey :: NtfPrivateAuthKey notifierId :: NotifierId queue ID to be used by the notification server for NSUB command rcvNtfDhSecret :: RcvNtfDhSecret shared DH secret used to encrypt/decrypt notification metadata (NMsgMeta) from server to recipient

Instances

Instances details

Show ClientNtfCreds Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods showsPrec :: Int -> ClientNtfCreds -> ShowS show :: ClientNtfCreds -> String showList :: [ClientNtfCreds] -> ShowS

data InvShortLink Source #

Constructors

InvShortLink
Fields server :: SMPServer linkId :: LinkId linkKey :: LinkKey sndPrivateKey :: SndPrivateAuthKey sndId :: Maybe SenderId

Instances

Instances details

Show InvShortLink Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods showsPrec :: Int -> InvShortLink -> ShowS show :: InvShortLink -> String showList :: [InvShortLink] -> ShowS

type SndQueue = StoredSndQueue 'DBStored Source #

type NewSndQueue = StoredSndQueue 'DBNew Source #

data StoredSndQueue (q :: DBStored) Source #

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

Constructors

SndQueue

Fields

userId :: UserId
connId :: ConnId
server :: SMPServer
sndId :: SenderId
sender queue ID
queueMode :: Maybe QueueMode
sender can secure the queue
sndPrivateKey :: SndPrivateAuthKey
sender key used to authorize transmissions
e2ePubKey :: Maybe PublicKeyX25519
DH public key used to negotiate per-queue e2e encryption
e2eDhSecret :: DhSecretX25519
shared DH secret agreed for simple per-queue e2e encryption
status :: QueueStatus
queue status
dbQueueId :: DBEntityId' q
database queue ID (within connection)
primary :: Bool
True for a primary or a next primary queue of the connection (next if dbReplaceQueueId is set)
dbReplaceQueueId :: Maybe Int64
ID of the queue this one is replacing
sndSwchStatus :: Maybe SndSwitchStatus
smpClientVersion :: VersionSMPC
SMP client version

Instances

Instances details

SMPQueue SndQueue Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods qServer :: SndQueue -> SMPServer Source # queueId :: SndQueue -> QueueId Source #
SMPQueueRec SndQueue Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods qUserId :: SndQueue -> UserId Source # qConnId :: SndQueue -> ConnId Source # dbQId :: SndQueue -> Int64 Source # qPrimary :: SndQueue -> Bool Source # dbReplaceQId :: SndQueue -> Maybe Int64 Source #
Show (StoredSndQueue q) Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods showsPrec :: Int -> StoredSndQueue q -> ShowS show :: StoredSndQueue q -> String showList :: [StoredSndQueue q] -> ShowS

class SMPQueue q => SMPQueueRec q where Source #

Methods

qUserId :: q -> UserId Source #

qConnId :: q -> ConnId Source #

dbQId :: q -> Int64 Source #

qPrimary :: q -> Bool Source #

dbReplaceQId :: q -> Maybe Int64 Source #

Instances

Instances details

SMPQueueRec RcvQueue Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods qUserId :: RcvQueue -> UserId Source # qConnId :: RcvQueue -> ConnId Source # dbQId :: RcvQueue -> Int64 Source # qPrimary :: RcvQueue -> Bool Source # dbReplaceQId :: RcvQueue -> Maybe Int64 Source #
SMPQueueRec RcvQueueSub Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods qUserId :: RcvQueueSub -> UserId Source # qConnId :: RcvQueueSub -> ConnId Source # dbQId :: RcvQueueSub -> Int64 Source # qPrimary :: RcvQueueSub -> Bool Source # dbReplaceQId :: RcvQueueSub -> Maybe Int64 Source #
SMPQueueRec SndQueue Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods qUserId :: SndQueue -> UserId Source # qConnId :: SndQueue -> ConnId Source # dbQId :: SndQueue -> Int64 Source # qPrimary :: SndQueue -> Bool Source # dbReplaceQId :: SndQueue -> Maybe Int64 Source #

class SMPQueueRec q => SomeRcvQueue q where Source #

Methods

rcvAuthKey :: q -> RcvPrivateAuthKey Source #

Instances

Instances details

SomeRcvQueue RcvQueue Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods rcvAuthKey :: RcvQueue -> RcvPrivateAuthKey Source #
SomeRcvQueue RcvQueueSub Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods rcvAuthKey :: RcvQueueSub -> RcvPrivateAuthKey Source #

data ConnType Source #

Type of a connection.

Constructors

CNew
CRcv
CSnd
CDuplex
CContact

Instances

Instances details

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

NewConnection :: ConnData -> Connection' CNew rq sq
RcvConnection :: ConnData -> rq -> Connection' CRcv rq sq
SndConnection :: ConnData -> sq -> Connection' CSnd rq sq
DuplexConnection :: ConnData -> NonEmpty rq -> NonEmpty sq -> Connection' CDuplex rq sq
ContactConnection :: ConnData -> rq -> Connection' CContact rq sq

Instances

Instances details

(Show rq, Show sq) => Show (Connection' d rq sq) Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods showsPrec :: Int -> Connection' d rq sq -> ShowS show :: Connection' d rq sq -> String showList :: [Connection' d rq sq] -> ShowS

type Connection d = Connection' d RcvQueue SndQueue Source #

data SConnType :: ConnType -> Type where Source #

Constructors

SCNew :: SConnType CNew
SCRcv :: SConnType CRcv
SCSnd :: SConnType CSnd
SCDuplex :: SConnType CDuplex
SCContact :: SConnType CContact

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

data SomeConn' rq sq 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 rq sq)

Instances

Instances details

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

type SomeConn = SomeConn' RcvQueue SndQueue Source #

type SomeConnSub = SomeConn' RcvQueueSub SndQueue Source #

data ConnData Source #

Constructors

ConnData
Fields connId :: ConnId userId :: UserId connAgentVersion :: VersionSMPA enableNtfs :: Bool lastExternalSndId :: PrevExternalSndId deleted :: Bool ratchetSyncState :: RatchetSyncState pqSupport :: PQSupport

Instances

Instances details

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

type NoticeId = Int64 Source #

data PendingCommand Source #

Constructors

PendingCommand
Fields cmdId :: AsyncCmdId corrId :: ACorrId userId :: UserId connId :: ConnId command :: AgentCommand

data AgentCmdType Source #

Constructors

ACClient
ACInternal

Instances

Instances details

StrEncoding AgentCmdType Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods strEncode :: AgentCmdType -> ByteString Source # strDecode :: ByteString -> Either String AgentCmdType Source # strP :: Parser AgentCmdType Source #

data AgentCommand Source #

Constructors

AClientCommand ACommand
AInternalCommand InternalCommand

Instances

Instances details

StrEncoding AgentCommand Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods strEncode :: AgentCommand -> ByteString Source # strDecode :: ByteString -> Either String AgentCommand Source # strP :: Parser AgentCommand Source #
FromField AgentCommand Source #
Instance details Defined in Simplex.Messaging.Agent.Store.AgentStore Methods fromField :: FieldParser AgentCommand #
ToField AgentCommand Source #
Instance details Defined in Simplex.Messaging.Agent.Store.AgentStore Methods toField :: AgentCommand -> SQLData #

data AgentCommandTag Source #

Constructors

AClientCommandTag ACommandTag
AInternalCommandTag InternalCommandTag

Instances

Instances details

Show AgentCommandTag Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods showsPrec :: Int -> AgentCommandTag -> ShowS show :: AgentCommandTag -> String showList :: [AgentCommandTag] -> ShowS
StrEncoding AgentCommandTag Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods strEncode :: AgentCommandTag -> ByteString Source # strDecode :: ByteString -> Either String AgentCommandTag Source # strP :: Parser AgentCommandTag Source #
FromField AgentCommandTag Source #
Instance details Defined in Simplex.Messaging.Agent.Store.AgentStore Methods fromField :: FieldParser AgentCommandTag #
ToField AgentCommandTag Source #
Instance details Defined in Simplex.Messaging.Agent.Store.AgentStore Methods toField :: AgentCommandTag -> SQLData #

data InternalCommand Source #

Instances

Instances details

StrEncoding InternalCommand Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods strEncode :: InternalCommand -> ByteString Source # strDecode :: ByteString -> Either String InternalCommand Source # strP :: Parser InternalCommand Source #

data InternalCommandTag Source #

Constructors

ICAck_
ICAckDel_
ICAllowSecure_
ICDuplexSecure_
ICDeleteConn_
ICDeleteRcvQueue_
ICQSecure_
ICQDelete_

Instances

Instances details

Show InternalCommandTag Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods showsPrec :: Int -> InternalCommandTag -> ShowS show :: InternalCommandTag -> String showList :: [InternalCommandTag] -> ShowS
StrEncoding InternalCommandTag Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods strEncode :: InternalCommandTag -> ByteString Source # strDecode :: ByteString -> Either String InternalCommandTag Source # strP :: Parser InternalCommandTag Source #

data NewConfirmation Source #

Constructors

NewConfirmation
Fields connId :: ConnId senderConf :: SMPConfirmation ratchetState :: RatchetX448

data AcceptedConfirmation Source #

Constructors

AcceptedConfirmation
Fields confirmationId :: ConfirmationId connId :: ConnId senderConf :: SMPConfirmation ratchetState :: RatchetX448 ownConnInfo :: ConnInfo

data NewInvitation Source #

Constructors

NewInvitation
Fields contactConnId :: ConnId connReq :: ConnectionRequestUri 'CMInvitation recipientConnInfo :: ConnInfo

data Invitation Source #

Constructors

Invitation
Fields invitationId :: InvitationId contactConnId_ :: Maybe ConnId connReq :: ConnectionRequestUri 'CMInvitation recipientConnInfo :: ConnInfo ownConnInfo :: Maybe ConnInfo accepted :: Bool

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

data RcvMsgData Source #

Constructors

RcvMsgData
Fields msgMeta :: MsgMeta msgType :: AgentMessageType msgFlags :: MsgFlags msgBody :: MsgBody internalRcvId :: InternalRcvId internalHash :: MsgHash externalPrevSndHash :: MsgHash encryptedMsgHash :: MsgHash

data RcvMsg Source #

Constructors

RcvMsg
Fields internalId :: InternalId msgMeta :: MsgMeta msgType :: AgentMessageType msgBody :: MsgBody internalHash :: MsgHash msgReceipt :: Maybe MsgReceipt userAck :: Bool

data SndMsgData Source #

Constructors

SndMsgData
Fields internalId :: InternalId internalSndId :: InternalSndId internalTs :: InternalTs msgType :: AgentMessageType msgFlags :: MsgFlags msgBody :: MsgBody pqEncryption :: PQEncryption internalHash :: MsgHash prevMsgHash :: MsgHash sndMsgPrepData_ :: Maybe SndMsgPrepData

data SndMsgPrepData Source #

Constructors

SndMsgPrepData
Fields encryptKey :: MsgEncryptKeyX448 paddedLen :: Int sndMsgBodyId :: Int64

Instances

Instances details

Show SndMsgPrepData Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods showsPrec :: Int -> SndMsgPrepData -> ShowS show :: SndMsgPrepData -> String showList :: [SndMsgPrepData] -> ShowS

data SndMsg Source #

Constructors

SndMsg
Fields internalId :: InternalId internalSndId :: InternalSndId msgType :: AgentMessageType internalHash :: MsgHash msgReceipt :: Maybe MsgReceipt

data PendingMsgData Source #

Constructors

PendingMsgData
Fields msgId :: InternalId msgType :: AgentMessageType msgFlags :: MsgFlags msgBody :: MsgBody pqEncryption :: PQEncryption msgRetryState :: Maybe RI2State internalTs :: InternalTs internalSndId :: InternalSndId prevMsgHash :: PrevSndMsgHash pendingMsgPrepData_ :: Maybe PendingMsgPrepData

Instances

Instances details

Show PendingMsgData Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods showsPrec :: Int -> PendingMsgData -> ShowS show :: PendingMsgData -> String showList :: [PendingMsgData] -> ShowS

data PendingMsgPrepData Source #

Constructors

PendingMsgPrepData
Fields encryptKey :: MsgEncryptKeyX448 paddedLen :: Int sndMsgBody :: AMessage

Instances

Instances details

Show PendingMsgPrepData Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods showsPrec :: Int -> PendingMsgPrepData -> ShowS show :: PendingMsgPrepData -> String showList :: [PendingMsgPrepData] -> ShowS

newtype InternalRcvId Source #

Constructors

InternalRcvId
Fields unRcvId :: Int64

Instances

Instances details

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

type ExternalSndId = Int64 Source #

type ExternalSndTs = UTCTime Source #

type BrokerId = MsgId Source #

type BrokerTs = UTCTime Source #

newtype InternalSndId Source #

Constructors

InternalSndId
Fields unSndId :: Int64

Instances

Instances details

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

data MsgBase Source #

Base message data independent of direction.

Constructors

MsgBase

Fields

connId :: ConnId
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

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

newtype InternalId Source #

Constructors

InternalId
Fields unId :: Int64

Instances

Instances details

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

type InternalTs = UTCTime Source #

type AsyncCmdId = Int64 Source #

data StoreError Source #

Agent store error.

Constructors

SEInternal ByteString	IO exceptions in store actions.
SEDatabaseBusy ByteString	Database busy
SEUniqueID	Failed to generate unique random ID
SEUserNotFound	User ID not found
SEConnNotFound	Connection not found (or both queues absent).
SEServerNotFound	Server not found.
SEConnDuplicate	Connection already used.
SESndQueueExists	Confirmed snd queue already exists.
SEBadConnType String 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.
SEConfirmationNotFound	Confirmation not found.
SEInvitationNotFound String InvitationId	Invitation not found
SEMsgNotFound String	Message not found
SECmdNotFound	Command not found
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.
SERatchetNotFound	connection does not have associated double-ratchet state
SEX3dhKeysNotFound	connection does not have associated x3dh keys
SEAgentError AgentErrorType	Used to wrap agent errors inside store operations to avoid race conditions
SEXFTPServerNotFound	XFTP Server not found.
SEFileNotFound	XFTP File not found.
SEDeletedSndChunkReplicaNotFound	XFTP Deleted snd chunk replica not found.
SEWorkItemError	Error when reading work item that suspends worker - do not use!
Fields errContext :: String
SEServersStatsNotFound	Servers stats not found.

Instances

Instances details

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

class (Show e, AnyError e) => AnyStoreError e where Source #

Methods

isWorkItemError :: e -> Bool Source #

mkWorkItemError :: String -> e Source #

Instances

Instances details

AnyStoreError StoreError Source #
Instance details Defined in Simplex.Messaging.Agent.Store Methods isWorkItemError :: StoreError -> Bool Source # mkWorkItemError :: String -> StoreError Source #

createStore :: DBOpts -> MigrationConfig -> IO (Either MigrationError DBStore) Source #

rcvQueueSub :: RcvQueue -> RcvQueueSub Source #

clientServiceId :: RcvQueue -> Maybe ClientServiceId Source #

rcvSMPQueueAddress :: RcvQueue -> SMPQueueAddress Source #

canAbortRcvSwitch :: RcvQueue -> Bool Source #

findQ :: SMPQueue q => (SMPServer, QueueId) -> NonEmpty q -> Maybe q Source #

removeQ :: SMPQueue q => (SMPServer, QueueId) -> NonEmpty q -> Maybe (q, [q]) Source #

removeQP :: (q -> Bool) -> NonEmpty q -> Maybe (q, [q]) Source #

sndAddress :: RcvQueue -> (SMPServer, SenderId) Source #

findRQ :: (SMPServer, SenderId) -> NonEmpty RcvQueue -> Maybe RcvQueue Source #

switchingRQ :: NonEmpty RcvQueue -> Maybe RcvQueue Source #

updatedQs :: SMPQueueRec q => q -> NonEmpty q -> NonEmpty q Source #

toConnData :: Connection' d rq sq -> ConnData Source #

updateConnection :: ConnData -> Connection' d rq sq -> Connection' d rq sq Source #

connType :: SConnType c -> ConnType Source #

ratchetSyncAllowed :: ConnData -> Bool Source #

ratchetSyncSendProhibited :: ConnData -> Bool Source #

agentCommandTag :: AgentCommand -> AgentCommandTag Source #

internalCmdTag :: InternalCommand -> InternalCommandTag Source #

ICAck RecipientId MsgId
ICAckDel RecipientId MsgId InternalId
ICAllowSecure RecipientId (Maybe SndPublicAuthKey)
ICDuplexSecure RecipientId SndPublicAuthKey
ICDeleteConn
ICDeleteRcvQueue RecipientId
ICQSecure RecipientId SndPublicAuthKey
ICQDelete RecipientId