Copyright	(c) simplex.chat
License	AGPL-3
Maintainer	chat@simplex.chat
Stability	experimental
Portability	non-portable
Safe Haskell	None
Language	Haskell2010

Simplex.Messaging.Agent.Protocol

Contents

SMP agent protocol types
Parse and serialize
TCP transport functions

Description

Types, parsers, serializers and functions to send and receive SMP agent protocol commands and responses.

See https://github.com/simplex-chat/simplexmq/blob/master/protocol/agent-protocol.md

Synopsis

type ConnInfo = ByteString
data ACommand (p :: AParty) where
- NEW :: AConnectionMode -> ACommand Client
- INV :: AConnectionRequest -> ACommand Agent
- JOIN :: AConnectionRequest -> ConnInfo -> ACommand Client
- CONF :: ConfirmationId -> ConnInfo -> ACommand Agent
- LET :: ConfirmationId -> ConnInfo -> ACommand Client
- REQ :: InvitationId -> ConnInfo -> ACommand Agent
- ACPT :: InvitationId -> ConnInfo -> ACommand Client
- RJCT :: InvitationId -> ACommand Client
- INFO :: ConnInfo -> ACommand Agent
- CON :: ACommand Agent
- SUB :: ACommand Client
- END :: ACommand Agent
- DOWN :: ACommand Agent
- UP :: ACommand Agent
- SEND :: MsgBody -> ACommand Client
- MID :: AgentMsgId -> ACommand Agent
- SENT :: AgentMsgId -> ACommand Agent
- MERR :: AgentMsgId -> AgentErrorType -> ACommand Agent
- MSG :: MsgMeta -> MsgBody -> ACommand Agent
- ACK :: AgentMsgId -> ACommand Client
- OFF :: ACommand Client
- DEL :: ACommand Client
- OK :: ACommand Agent
- ERR :: AgentErrorType -> ACommand Agent
data AParty
- = Agent
- | Client
data SAParty :: AParty -> Type where
- SAgent :: SAParty Agent
- SClient :: SAParty Client
type MsgHash = ByteString
data MsgMeta = MsgMeta {
- integrity :: MsgIntegrity
- recipient :: (AgentMsgId, UTCTime)
- broker :: (MsgId, UTCTime)
- sender :: (AgentMsgId, UTCTime)
}
data SMPMessage
- = SMPConfirmation {
  - senderKey :: SenderPublicKey
  - connInfo :: ConnInfo
  }
- | SMPMessage {
  - senderMsgId :: AgentMsgId
  - senderTimestamp :: SenderTimestamp
  - previousMsgHash :: MsgHash
  - agentMessage :: AMessage
  }
data AMessage where
- HELLO :: VerificationKey -> AckMode -> AMessage
- REPLY :: ConnectionRequest CMInvitation -> AMessage
- A_MSG :: MsgBody -> AMessage
- A_INV :: ConnectionRequest CMInvitation -> ConnInfo -> AMessage
data SMPServer = SMPServer {
- host :: HostName
- port :: Maybe ServiceName
- keyHash :: Maybe KeyHash
}
data SMPQueueUri = SMPQueueUri {
- smpServer :: SMPServer
- senderId :: SenderId
- serverVerifyKey :: VerificationKey
}
data ConnectionMode
- = CMInvitation
- | CMContact
data SConnectionMode (m :: ConnectionMode) where
- SCMInvitation :: SConnectionMode CMInvitation
- SCMContact :: SConnectionMode CMContact
data AConnectionMode = forall m. ACM (SConnectionMode m)
cmInvitation :: AConnectionMode
cmContact :: AConnectionMode
class ConnectionModeI (m :: ConnectionMode) where
- sConnectionMode :: SConnectionMode m
data ConnectionRequest (m :: ConnectionMode) where
- CRInvitation :: ConnReqData -> ConnectionRequest CMInvitation
- CRContact :: ConnReqData -> ConnectionRequest CMContact
data AConnectionRequest = forall m. ACR (SConnectionMode m) (ConnectionRequest m)
data ConnReqData = ConnReqData {
- crScheme :: ConnReqScheme
- crSmpQueues :: NonEmpty SMPQueueUri
- crEncryptKey :: EncryptionKey
}
data ConnReqScheme
- = CRSSimplex
- | CRSAppServer HostName (Maybe ServiceName)
simplexChat :: ConnReqScheme
data AgentErrorType
- = CMD CommandErrorType
- | CONN ConnectionErrorType
- | SMP ErrorType
- | BROKER BrokerErrorType
- | AGENT SMPAgentError
- | INTERNAL String
data CommandErrorType
- = PROHIBITED
- | SYNTAX
- | NO_CONN
- | SIZE
- | LARGE
data ConnectionErrorType
- = NOT_FOUND
- | DUPLICATE
- | SIMPLEX
data BrokerErrorType
- = RESPONSE ErrorType
- | UNEXPECTED
- | NETWORK
- | TRANSPORT TransportError
- | TIMEOUT
data SMPAgentError
- = A_MESSAGE
- | A_PROHIBITED
- | A_ENCRYPTION
- | A_SIGNATURE
type ATransmission p = (ACorrId, ConnId, ACommand p)
type ATransmissionOrError p = (ACorrId, ConnId, Either AgentErrorType (ACommand p))
type ARawTransmission = (ByteString, ByteString, ByteString)
type ConnId = ByteString
type ConfirmationId = ByteString
type InvitationId = ByteString
newtype AckMode = AckMode OnOff
data OnOff
- = On
- | Off
data MsgIntegrity
- = MsgOk
- | MsgError MsgErrorType
data MsgErrorType
- = MsgSkipped AgentMsgId AgentMsgId
- | MsgBadId AgentMsgId
- | MsgBadHash
- | MsgDuplicate
data QueueStatus
- = New
- | Confirmed
- | Secured
- | Active
- | Disabled
type SignatureKey = APrivateKey
type VerificationKey = PublicKey
type EncryptionKey = PublicKey
type DecryptionKey = SafePrivateKey
type ACorrId = ByteString
type AgentMsgId = Int64
serializeCommand :: ACommand p -> ByteString
serializeSMPMessage :: SMPMessage -> ByteString
serializeMsgIntegrity :: MsgIntegrity -> ByteString
serializeServer :: SMPServer -> ByteString
serializeSMPQueueUri :: SMPQueueUri -> ByteString
reservedServerKey :: PublicKey
serializeConnMode :: AConnectionMode -> ByteString
serializeConnMode' :: ConnectionMode -> ByteString
connMode :: SConnectionMode m -> ConnectionMode
connMode' :: ConnectionMode -> AConnectionMode
serializeConnReq :: AConnectionRequest -> ByteString
serializeConnReq' :: ConnectionRequest m -> ByteString
serializeAgentError :: AgentErrorType -> ByteString
commandP :: Parser ACmd
parseSMPMessage :: ByteString -> Either AgentErrorType SMPMessage
smpServerP :: Parser SMPServer
smpQueueUriP :: Parser SMPQueueUri
connModeT :: Text -> Maybe ConnectionMode
connReqP :: Parser AConnectionRequest
connReqP' :: forall m. ConnectionModeI m => Parser (ConnectionRequest m)
msgIntegrityP :: Parser MsgIntegrity
agentErrorTypeP :: Parser AgentErrorType
agentMessageP :: Parser AMessage
tPut :: (Transport c, MonadIO m) => c -> ATransmission p -> m ()
tGet :: forall c m p. (Transport c, MonadIO m) => SAParty p -> c -> m (ATransmissionOrError p)
tPutRaw :: Transport c => c -> ARawTransmission -> IO ()
tGetRaw :: Transport c => c -> IO ARawTransmission

SMP agent protocol types

type ConnInfo = ByteString Source #

data ACommand (p :: AParty) where Source #

Parameterized type for SMP agent protocol commands and responses from all participants.

Constructors

NEW :: AConnectionMode -> ACommand Client
INV :: AConnectionRequest -> ACommand Agent
JOIN :: AConnectionRequest -> ConnInfo -> ACommand Client
CONF :: ConfirmationId -> ConnInfo -> ACommand Agent
LET :: ConfirmationId -> ConnInfo -> ACommand Client
REQ :: InvitationId -> ConnInfo -> ACommand Agent
ACPT :: InvitationId -> ConnInfo -> ACommand Client
RJCT :: InvitationId -> ACommand Client
INFO :: ConnInfo -> ACommand Agent
CON :: ACommand Agent
SUB :: ACommand Client
END :: ACommand Agent
DOWN :: ACommand Agent
UP :: ACommand Agent
SEND :: MsgBody -> ACommand Client
MID :: AgentMsgId -> ACommand Agent
SENT :: AgentMsgId -> ACommand Agent
MERR :: AgentMsgId -> AgentErrorType -> ACommand Agent
MSG :: MsgMeta -> MsgBody -> ACommand Agent
ACK :: AgentMsgId -> ACommand Client
OFF :: ACommand Client
DEL :: ACommand Client
OK :: ACommand Agent
ERR :: AgentErrorType -> ACommand Agent

Instances

Instances details

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

data AParty Source #

SMP agent protocol participants.

Constructors

Agent
Client

Instances

Instances details

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

data SAParty :: AParty -> Type where Source #

Singleton types for SMP agent protocol participants.

Constructors

SAgent :: SAParty Agent
SClient :: SAParty Client

Instances

Instances details

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

type MsgHash = ByteString Source #

data MsgMeta Source #

Agent message metadata sent to the client

Constructors

MsgMeta
Fields integrity :: MsgIntegrity recipient :: (AgentMsgId, UTCTime) broker :: (MsgId, UTCTime) sender :: (AgentMsgId, UTCTime)

Instances

Instances details

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

data SMPMessage Source #

SMP message formats.

Constructors

SMPConfirmation	SMP confirmation (see SMP protocol)
Fields senderKey :: SenderPublicKey sender's public key to use for authentication of sender's commands at the recepient's server connInfo :: ConnInfo sender's information to be associated with the connection, e.g. sender's profile information
SMPMessage	Agent message header and envelope for client messages (see SMP agent protocol)
Fields senderMsgId :: AgentMsgId sequential ID assigned by the sending agent senderTimestamp :: SenderTimestamp timestamp from the sending agent previousMsgHash :: MsgHash digest of the previous message agentMessage :: AMessage messages sent between agents once queue is secured

Instances

Instances details

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

data AMessage where Source #

Messages sent between SMP agents once SMP queue is secured.

https://github.com/simplex-chat/simplexmq/blob/master/protocol/agent-protocol.md#messages-between-smp-agents

Constructors

HELLO :: VerificationKey -> AckMode -> AMessage	the first message in the queue to validate it is secured
REPLY :: ConnectionRequest CMInvitation -> AMessage	reply queue information
A_MSG :: MsgBody -> AMessage	agent envelope for the client message
A_INV :: ConnectionRequest CMInvitation -> ConnInfo -> AMessage	connection request with the invitation to connect

Instances

Instances details

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

data SMPServer Source #

SMP server location and transport key digest (hash).

Constructors

SMPServer
Fields host :: HostName port :: Maybe ServiceName keyHash :: Maybe KeyHash

Instances

Instances details

Eq SMPServer Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods (==) :: SMPServer -> SMPServer -> Bool # (/=) :: SMPServer -> SMPServer -> Bool #
Ord SMPServer Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods compare :: SMPServer -> SMPServer -> Ordering # (<) :: SMPServer -> SMPServer -> Bool # (<=) :: SMPServer -> SMPServer -> Bool # (>) :: SMPServer -> SMPServer -> Bool # (>=) :: SMPServer -> SMPServer -> Bool # max :: SMPServer -> SMPServer -> SMPServer # min :: SMPServer -> SMPServer -> SMPServer #
Show SMPServer Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods showsPrec :: Int -> SMPServer -> ShowS # show :: SMPServer -> String # showList :: [SMPServer] -> ShowS #
IsString SMPServer Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods fromString :: String -> SMPServer #

data SMPQueueUri Source #

SMP queue information sent out-of-band.

https://github.com/simplex-chat/simplexmq/blob/master/protocol/simplex-messaging.md#out-of-band-messages

Constructors

SMPQueueUri
Fields smpServer :: SMPServer senderId :: SenderId serverVerifyKey :: VerificationKey

Instances

Instances details

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

data ConnectionMode Source #

Constructors

CMInvitation
CMContact

Instances

Instances details

Eq ConnectionMode Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods (==) :: ConnectionMode -> ConnectionMode -> Bool # (/=) :: ConnectionMode -> ConnectionMode -> Bool #
Show ConnectionMode Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods showsPrec :: Int -> ConnectionMode -> ShowS # show :: ConnectionMode -> String # showList :: [ConnectionMode] -> ShowS #
FromField ConnectionMode Source #
Instance details Defined in Simplex.Messaging.Agent.Store.SQLite Methods fromField :: FieldParser ConnectionMode #
ToField ConnectionMode Source #
Instance details Defined in Simplex.Messaging.Agent.Store.SQLite Methods toField :: ConnectionMode -> SQLData #
TestEquality SConnectionMode Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods testEquality :: forall (a :: k) (b :: k). SConnectionMode a -> SConnectionMode b -> Maybe (a :~: b) #

data SConnectionMode (m :: ConnectionMode) where Source #

Constructors

SCMInvitation :: SConnectionMode CMInvitation
SCMContact :: SConnectionMode CMContact

Instances

Instances details

TestEquality SConnectionMode Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods testEquality :: forall (a :: k) (b :: k). SConnectionMode a -> SConnectionMode b -> Maybe (a :~: b) #
Eq (SConnectionMode m) Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods (==) :: SConnectionMode m -> SConnectionMode m -> Bool # (/=) :: SConnectionMode m -> SConnectionMode m -> Bool #
Show (SConnectionMode m) Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods showsPrec :: Int -> SConnectionMode m -> ShowS # show :: SConnectionMode m -> String # showList :: [SConnectionMode m] -> ShowS #
ToField (SConnectionMode c) Source #
Instance details Defined in Simplex.Messaging.Agent.Store.SQLite Methods toField :: SConnectionMode c -> SQLData #

data AConnectionMode Source #

Constructors

forall m. ACM (SConnectionMode m)

Instances

Instances details

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

cmInvitation :: AConnectionMode Source #

cmContact :: AConnectionMode Source #

class ConnectionModeI (m :: ConnectionMode) where Source #

Methods

sConnectionMode :: SConnectionMode m Source #

Instances

Instances details

ConnectionModeI 'CMInvitation Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods sConnectionMode :: SConnectionMode 'CMInvitation Source #
ConnectionModeI 'CMContact Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods sConnectionMode :: SConnectionMode 'CMContact Source #

data ConnectionRequest (m :: ConnectionMode) where Source #

Constructors

CRInvitation :: ConnReqData -> ConnectionRequest CMInvitation
CRContact :: ConnReqData -> ConnectionRequest CMContact

Instances

Instances details

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

data AConnectionRequest Source #

Constructors

forall m. ACR (SConnectionMode m) (ConnectionRequest m)

Instances

Instances details

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

data ConnReqData Source #

Constructors

ConnReqData
Fields crScheme :: ConnReqScheme crSmpQueues :: NonEmpty SMPQueueUri crEncryptKey :: EncryptionKey

Instances

Instances details

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

data ConnReqScheme Source #

Constructors

CRSSimplex
CRSAppServer HostName (Maybe ServiceName)

Instances

Instances details

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

simplexChat :: ConnReqScheme Source #

data AgentErrorType Source #

Error type used in errors sent to agent clients.

Constructors

CMD CommandErrorType	command or response error
CONN ConnectionErrorType	connection errors
SMP ErrorType	SMP protocol errors forwarded to agent clients
BROKER BrokerErrorType	SMP server errors
AGENT SMPAgentError	errors of other agents
INTERNAL String	agent implementation or dependency errors

Instances

Instances details

Eq AgentErrorType Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods (==) :: AgentErrorType -> AgentErrorType -> Bool # (/=) :: AgentErrorType -> AgentErrorType -> Bool #
Read AgentErrorType Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods readsPrec :: Int -> ReadS AgentErrorType # readList :: ReadS [AgentErrorType] # readPrec :: ReadPrec AgentErrorType # readListPrec :: ReadPrec [AgentErrorType] #
Show AgentErrorType Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods showsPrec :: Int -> AgentErrorType -> ShowS # show :: AgentErrorType -> String # showList :: [AgentErrorType] -> ShowS #
Generic AgentErrorType Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Associated Types type Rep AgentErrorType :: Type -> Type # Methods from :: AgentErrorType -> Rep AgentErrorType x # to :: Rep AgentErrorType x -> AgentErrorType #
Arbitrary AgentErrorType Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods arbitrary :: Gen AgentErrorType # shrink :: AgentErrorType -> [AgentErrorType] #
Exception AgentErrorType Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods toException :: AgentErrorType -> SomeException # fromException :: SomeException -> Maybe AgentErrorType # displayException :: AgentErrorType -> String #
type Rep AgentErrorType Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol type Rep AgentErrorType = D1 ('MetaData "AgentErrorType" "Simplex.Messaging.Agent.Protocol" "simplexmq-0.5.2-7Hr1oNZfhPnIOy42ZNhVg7" 'False) ((C1 ('MetaCons "CMD" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CommandErrorType)) :+: (C1 ('MetaCons "CONN" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ConnectionErrorType)) :+: C1 ('MetaCons "SMP" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ErrorType)))) :+: (C1 ('MetaCons "BROKER" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BrokerErrorType)) :+: (C1 ('MetaCons "AGENT" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SMPAgentError)) :+: C1 ('MetaCons "INTERNAL" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)))))

data CommandErrorType Source #

SMP agent protocol command or response error.

Constructors

PROHIBITED	command is prohibited in this context
SYNTAX	command syntax is invalid
NO_CONN	entity ID is required with this command
SIZE	message size is not correct (no terminating space)
LARGE	message does not fit in SMP block

Instances

Instances details

Eq CommandErrorType Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods (==) :: CommandErrorType -> CommandErrorType -> Bool # (/=) :: CommandErrorType -> CommandErrorType -> Bool #
Read CommandErrorType Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods readsPrec :: Int -> ReadS CommandErrorType # readList :: ReadS [CommandErrorType] # readPrec :: ReadPrec CommandErrorType # readListPrec :: ReadPrec [CommandErrorType] #
Show CommandErrorType Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods showsPrec :: Int -> CommandErrorType -> ShowS # show :: CommandErrorType -> String # showList :: [CommandErrorType] -> ShowS #
Generic CommandErrorType Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Associated Types type Rep CommandErrorType :: Type -> Type # Methods from :: CommandErrorType -> Rep CommandErrorType x # to :: Rep CommandErrorType x -> CommandErrorType #
Arbitrary CommandErrorType Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods arbitrary :: Gen CommandErrorType # shrink :: CommandErrorType -> [CommandErrorType] #
Exception CommandErrorType Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods toException :: CommandErrorType -> SomeException # fromException :: SomeException -> Maybe CommandErrorType # displayException :: CommandErrorType -> String #
type Rep CommandErrorType Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol type Rep CommandErrorType = D1 ('MetaData "CommandErrorType" "Simplex.Messaging.Agent.Protocol" "simplexmq-0.5.2-7Hr1oNZfhPnIOy42ZNhVg7" 'False) ((C1 ('MetaCons "PROHIBITED" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SYNTAX" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "NO_CONN" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "SIZE" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "LARGE" 'PrefixI 'False) (U1 :: Type -> Type))))

data ConnectionErrorType Source #

Connection error.

Constructors

NOT_FOUND	connection alias is not in the database
DUPLICATE	connection alias already exists
SIMPLEX	connection is simplex, but operation requires another queue

Instances

Instances details

Eq ConnectionErrorType Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods (==) :: ConnectionErrorType -> ConnectionErrorType -> Bool # (/=) :: ConnectionErrorType -> ConnectionErrorType -> Bool #
Read ConnectionErrorType Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods readsPrec :: Int -> ReadS ConnectionErrorType # readList :: ReadS [ConnectionErrorType] # readPrec :: ReadPrec ConnectionErrorType # readListPrec :: ReadPrec [ConnectionErrorType] #
Show ConnectionErrorType Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods showsPrec :: Int -> ConnectionErrorType -> ShowS # show :: ConnectionErrorType -> String # showList :: [ConnectionErrorType] -> ShowS #
Generic ConnectionErrorType Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Associated Types type Rep ConnectionErrorType :: Type -> Type # Methods from :: ConnectionErrorType -> Rep ConnectionErrorType x # to :: Rep ConnectionErrorType x -> ConnectionErrorType #
Arbitrary ConnectionErrorType Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods arbitrary :: Gen ConnectionErrorType # shrink :: ConnectionErrorType -> [ConnectionErrorType] #
Exception ConnectionErrorType Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods toException :: ConnectionErrorType -> SomeException # fromException :: SomeException -> Maybe ConnectionErrorType # displayException :: ConnectionErrorType -> String #
type Rep ConnectionErrorType Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol type Rep ConnectionErrorType = D1 ('MetaData "ConnectionErrorType" "Simplex.Messaging.Agent.Protocol" "simplexmq-0.5.2-7Hr1oNZfhPnIOy42ZNhVg7" 'False) (C1 ('MetaCons "NOT_FOUND" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "DUPLICATE" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SIMPLEX" 'PrefixI 'False) (U1 :: Type -> Type)))

data BrokerErrorType Source #

SMP server errors.

Constructors

RESPONSE ErrorType	invalid server response (failed to parse)
UNEXPECTED	unexpected response
NETWORK	network error
TRANSPORT TransportError	handshake or other transport error
TIMEOUT	command response timeout

Instances

Instances details

Eq BrokerErrorType Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods (==) :: BrokerErrorType -> BrokerErrorType -> Bool # (/=) :: BrokerErrorType -> BrokerErrorType -> Bool #
Read BrokerErrorType Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods readsPrec :: Int -> ReadS BrokerErrorType # readList :: ReadS [BrokerErrorType] # readPrec :: ReadPrec BrokerErrorType # readListPrec :: ReadPrec [BrokerErrorType] #
Show BrokerErrorType Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods showsPrec :: Int -> BrokerErrorType -> ShowS # show :: BrokerErrorType -> String # showList :: [BrokerErrorType] -> ShowS #
Generic BrokerErrorType Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Associated Types type Rep BrokerErrorType :: Type -> Type # Methods from :: BrokerErrorType -> Rep BrokerErrorType x # to :: Rep BrokerErrorType x -> BrokerErrorType #
Arbitrary BrokerErrorType Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods arbitrary :: Gen BrokerErrorType # shrink :: BrokerErrorType -> [BrokerErrorType] #
Exception BrokerErrorType Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods toException :: BrokerErrorType -> SomeException # fromException :: SomeException -> Maybe BrokerErrorType # displayException :: BrokerErrorType -> String #
type Rep BrokerErrorType Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol type Rep BrokerErrorType = D1 ('MetaData "BrokerErrorType" "Simplex.Messaging.Agent.Protocol" "simplexmq-0.5.2-7Hr1oNZfhPnIOy42ZNhVg7" 'False) ((C1 ('MetaCons "RESPONSE" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ErrorType)) :+: C1 ('MetaCons "UNEXPECTED" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "NETWORK" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "TRANSPORT" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TransportError)) :+: C1 ('MetaCons "TIMEOUT" 'PrefixI 'False) (U1 :: Type -> Type))))

data SMPAgentError Source #

Errors of another SMP agent.

Constructors

A_MESSAGE	possibly should include bytestring that failed to parse
A_PROHIBITED	possibly should include the prohibited SMP/agent message
A_ENCRYPTION	cannot RSA/AES-decrypt or parse decrypted header
A_SIGNATURE	invalid RSA signature

Instances

Instances details

Eq SMPAgentError Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods (==) :: SMPAgentError -> SMPAgentError -> Bool # (/=) :: SMPAgentError -> SMPAgentError -> Bool #
Read SMPAgentError Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods readsPrec :: Int -> ReadS SMPAgentError # readList :: ReadS [SMPAgentError] # readPrec :: ReadPrec SMPAgentError # readListPrec :: ReadPrec [SMPAgentError] #
Show SMPAgentError Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods showsPrec :: Int -> SMPAgentError -> ShowS # show :: SMPAgentError -> String # showList :: [SMPAgentError] -> ShowS #
Generic SMPAgentError Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Associated Types type Rep SMPAgentError :: Type -> Type # Methods from :: SMPAgentError -> Rep SMPAgentError x # to :: Rep SMPAgentError x -> SMPAgentError #
Arbitrary SMPAgentError Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods arbitrary :: Gen SMPAgentError # shrink :: SMPAgentError -> [SMPAgentError] #
Exception SMPAgentError Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods toException :: SMPAgentError -> SomeException # fromException :: SomeException -> Maybe SMPAgentError # displayException :: SMPAgentError -> String #
type Rep SMPAgentError Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol type Rep SMPAgentError = D1 ('MetaData "SMPAgentError" "Simplex.Messaging.Agent.Protocol" "simplexmq-0.5.2-7Hr1oNZfhPnIOy42ZNhVg7" 'False) ((C1 ('MetaCons "A_MESSAGE" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "A_PROHIBITED" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "A_ENCRYPTION" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "A_SIGNATURE" 'PrefixI 'False) (U1 :: Type -> Type)))

type ATransmission p = (ACorrId, ConnId, ACommand p) Source #

Parsed SMP agent protocol transmission.

type ATransmissionOrError p = (ACorrId, ConnId, Either AgentErrorType (ACommand p)) Source #

SMP agent protocol transmission or transmission error.

type ARawTransmission = (ByteString, ByteString, ByteString) Source #

Raw (unparsed) SMP agent protocol transmission.

type ConnId = ByteString Source #

SMP agent connection alias.

type ConfirmationId = ByteString Source #

type InvitationId = ByteString Source #

newtype AckMode Source #

Message acknowledgement mode of the connection.

Constructors

AckMode OnOff

Instances

Instances details

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

data OnOff Source #

Connection modes.

Constructors

On
Off

Instances

Instances details

Eq OnOff Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods (==) :: OnOff -> OnOff -> Bool # (/=) :: OnOff -> OnOff -> Bool #
Read OnOff Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods readsPrec :: Int -> ReadS OnOff # readList :: ReadS [OnOff] # readPrec :: ReadPrec OnOff # readListPrec :: ReadPrec [OnOff] #
Show OnOff Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods showsPrec :: Int -> OnOff -> ShowS # show :: OnOff -> String # showList :: [OnOff] -> ShowS #

data MsgIntegrity Source #

Result of received message integrity validation.

Constructors

MsgOk
MsgError MsgErrorType

Instances

Instances details

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

data MsgErrorType Source #

Error of message integrity validation.

Constructors

MsgSkipped AgentMsgId AgentMsgId
MsgBadId AgentMsgId
MsgBadHash
MsgDuplicate

Instances

Instances details

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

data QueueStatus Source #

SMP queue status.

Constructors

New	queue is created
Confirmed	queue is confirmed by the sender
Secured	queue is secured with sender key (only used by the queue recipient)
Active	queue is active
Disabled	queue is disabled (only used by the queue recipient)

Instances

Instances details

Eq QueueStatus Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods (==) :: QueueStatus -> QueueStatus -> Bool # (/=) :: QueueStatus -> QueueStatus -> Bool #
Read QueueStatus Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods readsPrec :: Int -> ReadS QueueStatus # readList :: ReadS [QueueStatus] # readPrec :: ReadPrec QueueStatus # readListPrec :: ReadPrec [QueueStatus] #
Show QueueStatus Source #
Instance details Defined in Simplex.Messaging.Agent.Protocol Methods showsPrec :: Int -> QueueStatus -> ShowS # show :: QueueStatus -> String # showList :: [QueueStatus] -> ShowS #
FromField QueueStatus Source #
Instance details Defined in Simplex.Messaging.Agent.Store.SQLite Methods fromField :: FieldParser QueueStatus #
ToField QueueStatus Source #
Instance details Defined in Simplex.Messaging.Agent.Store.SQLite Methods toField :: QueueStatus -> SQLData #