Simplex.Messaging.Agent.Protocol

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

SMP agent protocol types

type ConnInfo = ByteString

data ACommand (p :: AParty) where

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

Eq (ACommand p)

Defined in Simplex.Messaging.Agent.Protocol

Methods

(==) :: ACommand p -> ACommand p -> Bool

(/=) :: ACommand p -> ACommand p -> Bool

Show (ACommand p)

Defined in Simplex.Messaging.Agent.Protocol

Methods

showsPrec :: Int -> ACommand p -> ShowS

show :: ACommand p -> String

showList :: [ACommand p] -> ShowS

data AParty

SMP agent protocol participants.

Constructors

Agent

Client

Instances

Eq AParty

Defined in Simplex.Messaging.Agent.Protocol

Methods

(==) :: AParty -> AParty -> Bool

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

Show AParty

Defined in Simplex.Messaging.Agent.Protocol

Methods

showsPrec :: Int -> AParty -> ShowS

show :: AParty -> String

showList :: [AParty] -> ShowS

TestEquality SAParty

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

Singleton types for SMP agent protocol participants.

Constructors

SAgent :: SAParty Agent

SClient :: SAParty Client

Instances

TestEquality SAParty

Defined in Simplex.Messaging.Agent.Protocol

Methods

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

Eq (SAParty p)

Defined in Simplex.Messaging.Agent.Protocol

Methods

(==) :: SAParty p -> SAParty p -> Bool

(/=) :: SAParty p -> SAParty p -> Bool

Show (SAParty p)

Defined in Simplex.Messaging.Agent.Protocol

Methods

showsPrec :: Int -> SAParty p -> ShowS

show :: SAParty p -> String

showList :: [SAParty p] -> ShowS

type MsgHash = ByteString

data MsgMeta

Agent message metadata sent to the client

Constructors

MsgMeta

Fields

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

Instances

Eq MsgMeta

Defined in Simplex.Messaging.Agent.Protocol

Methods

(==) :: MsgMeta -> MsgMeta -> Bool

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

Show MsgMeta

Defined in Simplex.Messaging.Agent.Protocol

Methods

showsPrec :: Int -> MsgMeta -> ShowS

show :: MsgMeta -> String

showList :: [MsgMeta] -> ShowS

data SMPMessage

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

Show SMPMessage

Defined in Simplex.Messaging.Agent.Protocol

Methods

showsPrec :: Int -> SMPMessage -> ShowS

show :: SMPMessage -> String

showList :: [SMPMessage] -> ShowS

data AMessage where

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

Show AMessage

Defined in Simplex.Messaging.Agent.Protocol

Methods

showsPrec :: Int -> AMessage -> ShowS

show :: AMessage -> String

showList :: [AMessage] -> ShowS

data SMPServer

SMP server location and transport key digest (hash).

Constructors

SMPServer

Fields

• host :: HostName
• port :: Maybe ServiceName
• keyHash :: Maybe KeyHash

Instances

Eq SMPServer

Defined in Simplex.Messaging.Agent.Protocol

Methods

(==) :: SMPServer -> SMPServer -> Bool

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

Ord SMPServer

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

Defined in Simplex.Messaging.Agent.Protocol

Methods

showsPrec :: Int -> SMPServer -> ShowS

show :: SMPServer -> String

showList :: [SMPServer] -> ShowS

IsString SMPServer

Defined in Simplex.Messaging.Agent.Protocol

Methods

fromString :: String -> SMPServer

data SMPQueueUri

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

Eq SMPQueueUri

Defined in Simplex.Messaging.Agent.Protocol

Methods

(==) :: SMPQueueUri -> SMPQueueUri -> Bool

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

Show SMPQueueUri

Defined in Simplex.Messaging.Agent.Protocol

Methods

showsPrec :: Int -> SMPQueueUri -> ShowS

show :: SMPQueueUri -> String

showList :: [SMPQueueUri] -> ShowS

FromField SMPQueueUri

Defined in Simplex.Messaging.Agent.Store.SQLite

Methods

fromField :: FieldParser SMPQueueUri

ToField SMPQueueUri

Defined in Simplex.Messaging.Agent.Store.SQLite

Methods

toField :: SMPQueueUri -> SQLData

data ConnectionMode

Constructors

CMInvitation

CMContact

Instances

Eq ConnectionMode

Defined in Simplex.Messaging.Agent.Protocol

Methods

(==) :: ConnectionMode -> ConnectionMode -> Bool

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

Show ConnectionMode

Defined in Simplex.Messaging.Agent.Protocol

Methods

showsPrec :: Int -> ConnectionMode -> ShowS

show :: ConnectionMode -> String

showList :: [ConnectionMode] -> ShowS

FromField ConnectionMode

Defined in Simplex.Messaging.Agent.Store.SQLite

Methods

fromField :: FieldParser ConnectionMode

ToField ConnectionMode

Defined in Simplex.Messaging.Agent.Store.SQLite

Methods

toField :: ConnectionMode -> SQLData

TestEquality SConnectionMode

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

Constructors

SCMInvitation :: SConnectionMode CMInvitation

SCMContact :: SConnectionMode CMContact

Instances

TestEquality SConnectionMode

Defined in Simplex.Messaging.Agent.Protocol

Methods

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

Eq (SConnectionMode m)

Defined in Simplex.Messaging.Agent.Protocol

Methods

(==) :: SConnectionMode m -> SConnectionMode m -> Bool

(/=) :: SConnectionMode m -> SConnectionMode m -> Bool

Show (SConnectionMode m)

Defined in Simplex.Messaging.Agent.Protocol

Methods

showsPrec :: Int -> SConnectionMode m -> ShowS

show :: SConnectionMode m -> String

showList :: [SConnectionMode m] -> ShowS

ToField (SConnectionMode c)

Defined in Simplex.Messaging.Agent.Store.SQLite

Methods

toField :: SConnectionMode c -> SQLData

data AConnectionMode

Constructors

forall m. ACM (SConnectionMode m)

Instances

Eq AConnectionMode

Defined in Simplex.Messaging.Agent.Protocol

Methods

(==) :: AConnectionMode -> AConnectionMode -> Bool

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

Show AConnectionMode

Defined in Simplex.Messaging.Agent.Protocol

Methods

showsPrec :: Int -> AConnectionMode -> ShowS

show :: AConnectionMode -> String

showList :: [AConnectionMode] -> ShowS

FromField AConnectionMode

Defined in Simplex.Messaging.Agent.Store.SQLite

Methods

fromField :: FieldParser AConnectionMode

cmInvitation :: AConnectionMode

cmContact :: AConnectionMode

class ConnectionModeI (m :: ConnectionMode) where

Methods

sConnectionMode :: SConnectionMode m

Instances

ConnectionModeI 'CMInvitation

Defined in Simplex.Messaging.Agent.Protocol

Methods

sConnectionMode :: SConnectionMode 'CMInvitation

ConnectionModeI 'CMContact

Defined in Simplex.Messaging.Agent.Protocol

Methods

sConnectionMode :: SConnectionMode 'CMContact

data ConnectionRequest (m :: ConnectionMode) where

Constructors

CRInvitation :: ConnReqData -> ConnectionRequest CMInvitation

CRContact :: ConnReqData -> ConnectionRequest CMContact

Instances

Eq (ConnectionRequest m)

Defined in Simplex.Messaging.Agent.Protocol

Methods

(==) :: ConnectionRequest m -> ConnectionRequest m -> Bool

(/=) :: ConnectionRequest m -> ConnectionRequest m -> Bool

Show (ConnectionRequest m)

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)

Defined in Simplex.Messaging.Agent.Store.SQLite

Methods

fromField :: FieldParser (ConnectionRequest c)

ToField (ConnectionRequest c)

Defined in Simplex.Messaging.Agent.Store.SQLite

Methods

toField :: ConnectionRequest c -> SQLData

data AConnectionRequest

Constructors

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

Instances

Eq AConnectionRequest

Defined in Simplex.Messaging.Agent.Protocol

Methods

(==) :: AConnectionRequest -> AConnectionRequest -> Bool

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

Show AConnectionRequest

Defined in Simplex.Messaging.Agent.Protocol

Methods

showsPrec :: Int -> AConnectionRequest -> ShowS

show :: AConnectionRequest -> String

showList :: [AConnectionRequest] -> ShowS

FromField AConnectionRequest

Defined in Simplex.Messaging.Agent.Store.SQLite

Methods

fromField :: FieldParser AConnectionRequest

ToField AConnectionRequest

Defined in Simplex.Messaging.Agent.Store.SQLite

Methods

toField :: AConnectionRequest -> SQLData

data ConnReqData

Constructors

ConnReqData

Fields

• crScheme :: ConnReqScheme
• crSmpQueues :: NonEmpty SMPQueueUri
• crEncryptKey :: EncryptionKey

Instances

Eq ConnReqData

Defined in Simplex.Messaging.Agent.Protocol

Methods

(==) :: ConnReqData -> ConnReqData -> Bool

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

Show ConnReqData

Defined in Simplex.Messaging.Agent.Protocol

Methods

showsPrec :: Int -> ConnReqData -> ShowS

show :: ConnReqData -> String

showList :: [ConnReqData] -> ShowS

data ConnReqScheme

Constructors

CRSSimplex

CRSAppServer HostName (Maybe ServiceName)

Instances

Eq ConnReqScheme

Defined in Simplex.Messaging.Agent.Protocol

Methods

(==) :: ConnReqScheme -> ConnReqScheme -> Bool

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

Show ConnReqScheme

Defined in Simplex.Messaging.Agent.Protocol

Methods

showsPrec :: Int -> ConnReqScheme -> ShowS

show :: ConnReqScheme -> String

showList :: [ConnReqScheme] -> ShowS

simplexChat :: ConnReqScheme

data AgentErrorType

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

Eq AgentErrorType

Defined in Simplex.Messaging.Agent.Protocol

Methods

(==) :: AgentErrorType -> AgentErrorType -> Bool

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

Read AgentErrorType

Defined in Simplex.Messaging.Agent.Protocol

Methods

readsPrec :: Int -> ReadS AgentErrorType

readList :: ReadS [AgentErrorType]

readPrec :: ReadPrec AgentErrorType

readListPrec :: ReadPrec [AgentErrorType]

Show AgentErrorType

Defined in Simplex.Messaging.Agent.Protocol

Methods

showsPrec :: Int -> AgentErrorType -> ShowS

show :: AgentErrorType -> String

showList :: [AgentErrorType] -> ShowS

Generic AgentErrorType

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

Defined in Simplex.Messaging.Agent.Protocol

Methods

arbitrary :: Gen AgentErrorType

shrink :: AgentErrorType -> [AgentErrorType]

Exception AgentErrorType

Defined in Simplex.Messaging.Agent.Protocol

Methods

toException :: AgentErrorType -> SomeException

fromException :: SomeException -> Maybe AgentErrorType

displayException :: AgentErrorType -> String

type Rep AgentErrorType

Defined in Simplex.Messaging.Agent.Protocol

type Rep AgentErrorType = D1 ('MetaData "AgentErrorType" "Simplex.Messaging.Agent.Protocol" "simplexmq-0.5.0-BymDexQZfBPGSfRvALu9eI" '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

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

Eq CommandErrorType

Defined in Simplex.Messaging.Agent.Protocol

Methods

(==) :: CommandErrorType -> CommandErrorType -> Bool

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

Read CommandErrorType

Defined in Simplex.Messaging.Agent.Protocol

Methods

readsPrec :: Int -> ReadS CommandErrorType

readList :: ReadS [CommandErrorType]

readPrec :: ReadPrec CommandErrorType

readListPrec :: ReadPrec [CommandErrorType]

Show CommandErrorType

Defined in Simplex.Messaging.Agent.Protocol

Methods

showsPrec :: Int -> CommandErrorType -> ShowS

show :: CommandErrorType -> String

showList :: [CommandErrorType] -> ShowS

Generic CommandErrorType

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

Defined in Simplex.Messaging.Agent.Protocol

Methods

arbitrary :: Gen CommandErrorType

shrink :: CommandErrorType -> [CommandErrorType]

Exception CommandErrorType

Defined in Simplex.Messaging.Agent.Protocol

Methods

toException :: CommandErrorType -> SomeException

fromException :: SomeException -> Maybe CommandErrorType

displayException :: CommandErrorType -> String

type Rep CommandErrorType

Defined in Simplex.Messaging.Agent.Protocol

type Rep CommandErrorType = D1 ('MetaData "CommandErrorType" "Simplex.Messaging.Agent.Protocol" "simplexmq-0.5.0-BymDexQZfBPGSfRvALu9eI" '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

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

Eq ConnectionErrorType

Defined in Simplex.Messaging.Agent.Protocol

Methods

(==) :: ConnectionErrorType -> ConnectionErrorType -> Bool

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

Read ConnectionErrorType

Defined in Simplex.Messaging.Agent.Protocol

Methods

readsPrec :: Int -> ReadS ConnectionErrorType

readList :: ReadS [ConnectionErrorType]

readPrec :: ReadPrec ConnectionErrorType

readListPrec :: ReadPrec [ConnectionErrorType]

Show ConnectionErrorType

Defined in Simplex.Messaging.Agent.Protocol

Methods

showsPrec :: Int -> ConnectionErrorType -> ShowS

show :: ConnectionErrorType -> String

showList :: [ConnectionErrorType] -> ShowS

Generic ConnectionErrorType

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

Defined in Simplex.Messaging.Agent.Protocol

Methods

arbitrary :: Gen ConnectionErrorType

shrink :: ConnectionErrorType -> [ConnectionErrorType]

Exception ConnectionErrorType

Defined in Simplex.Messaging.Agent.Protocol

Methods

toException :: ConnectionErrorType -> SomeException

fromException :: SomeException -> Maybe ConnectionErrorType

displayException :: ConnectionErrorType -> String

type Rep ConnectionErrorType

Defined in Simplex.Messaging.Agent.Protocol

type Rep ConnectionErrorType = D1 ('MetaData "ConnectionErrorType" "Simplex.Messaging.Agent.Protocol" "simplexmq-0.5.0-BymDexQZfBPGSfRvALu9eI" '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

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

Eq BrokerErrorType

Defined in Simplex.Messaging.Agent.Protocol

Methods

(==) :: BrokerErrorType -> BrokerErrorType -> Bool

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

Read BrokerErrorType

Defined in Simplex.Messaging.Agent.Protocol

Methods

readsPrec :: Int -> ReadS BrokerErrorType

readList :: ReadS [BrokerErrorType]

readPrec :: ReadPrec BrokerErrorType

readListPrec :: ReadPrec [BrokerErrorType]

Show BrokerErrorType

Defined in Simplex.Messaging.Agent.Protocol

Methods

showsPrec :: Int -> BrokerErrorType -> ShowS

show :: BrokerErrorType -> String

showList :: [BrokerErrorType] -> ShowS

Generic BrokerErrorType

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

Defined in Simplex.Messaging.Agent.Protocol

Methods

arbitrary :: Gen BrokerErrorType

shrink :: BrokerErrorType -> [BrokerErrorType]

Exception BrokerErrorType

Defined in Simplex.Messaging.Agent.Protocol

Methods

toException :: BrokerErrorType -> SomeException

fromException :: SomeException -> Maybe BrokerErrorType

displayException :: BrokerErrorType -> String

type Rep BrokerErrorType

Defined in Simplex.Messaging.Agent.Protocol

type Rep BrokerErrorType = D1 ('MetaData "BrokerErrorType" "Simplex.Messaging.Agent.Protocol" "simplexmq-0.5.0-BymDexQZfBPGSfRvALu9eI" '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

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

Eq SMPAgentError

Defined in Simplex.Messaging.Agent.Protocol

Methods

(==) :: SMPAgentError -> SMPAgentError -> Bool

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

Read SMPAgentError

Defined in Simplex.Messaging.Agent.Protocol

Methods

readsPrec :: Int -> ReadS SMPAgentError

readList :: ReadS [SMPAgentError]

readPrec :: ReadPrec SMPAgentError

readListPrec :: ReadPrec [SMPAgentError]

Show SMPAgentError

Defined in Simplex.Messaging.Agent.Protocol

Methods

showsPrec :: Int -> SMPAgentError -> ShowS

show :: SMPAgentError -> String

showList :: [SMPAgentError] -> ShowS

Generic SMPAgentError

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

Defined in Simplex.Messaging.Agent.Protocol

Methods

arbitrary :: Gen SMPAgentError

shrink :: SMPAgentError -> [SMPAgentError]

Exception SMPAgentError

Defined in Simplex.Messaging.Agent.Protocol

Methods

toException :: SMPAgentError -> SomeException

fromException :: SomeException -> Maybe SMPAgentError

displayException :: SMPAgentError -> String

type Rep SMPAgentError

Defined in Simplex.Messaging.Agent.Protocol

type Rep SMPAgentError = D1 ('MetaData "SMPAgentError" "Simplex.Messaging.Agent.Protocol" "simplexmq-0.5.0-BymDexQZfBPGSfRvALu9eI" '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)

Parsed SMP agent protocol transmission.

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

SMP agent protocol transmission or transmission error.

type ARawTransmission = (ByteString, ByteString, ByteString)

Raw (unparsed) SMP agent protocol transmission.

type ConnId = ByteString

SMP agent connection alias.

type ConfirmationId = ByteString

type InvitationId = ByteString

newtype AckMode

Message acknowledgement mode of the connection.

Constructors

AckMode OnOff

Instances

Eq AckMode

Defined in Simplex.Messaging.Agent.Protocol

Methods

(==) :: AckMode -> AckMode -> Bool

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

Show AckMode

Defined in Simplex.Messaging.Agent.Protocol

Methods

showsPrec :: Int -> AckMode -> ShowS

show :: AckMode -> String

showList :: [AckMode] -> ShowS

data OnOff

Connection modes.

Constructors

On

Off

Instances

Eq OnOff

Defined in Simplex.Messaging.Agent.Protocol

Methods

(==) :: OnOff -> OnOff -> Bool

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

Read OnOff

Defined in Simplex.Messaging.Agent.Protocol

Methods

readsPrec :: Int -> ReadS OnOff

readList :: ReadS [OnOff]

readPrec :: ReadPrec OnOff

readListPrec :: ReadPrec [OnOff]

Show OnOff

Defined in Simplex.Messaging.Agent.Protocol

Methods

showsPrec :: Int -> OnOff -> ShowS

show :: OnOff -> String

showList :: [OnOff] -> ShowS

data MsgIntegrity

Result of received message integrity validation.

Constructors

MsgOk

MsgError MsgErrorType

Instances

Eq MsgIntegrity

Defined in Simplex.Messaging.Agent.Protocol

Methods

(==) :: MsgIntegrity -> MsgIntegrity -> Bool

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

Show MsgIntegrity

Defined in Simplex.Messaging.Agent.Protocol

Methods

showsPrec :: Int -> MsgIntegrity -> ShowS

show :: MsgIntegrity -> String

showList :: [MsgIntegrity] -> ShowS

FromField MsgIntegrity

Defined in Simplex.Messaging.Agent.Store.SQLite

Methods

fromField :: FieldParser MsgIntegrity

ToField MsgIntegrity

Defined in Simplex.Messaging.Agent.Store.SQLite

Methods

toField :: MsgIntegrity -> SQLData

data MsgErrorType

Error of message integrity validation.

Constructors

MsgSkipped AgentMsgId AgentMsgId

MsgBadId AgentMsgId

MsgBadHash

MsgDuplicate

Instances

Eq MsgErrorType

Defined in Simplex.Messaging.Agent.Protocol

Methods

(==) :: MsgErrorType -> MsgErrorType -> Bool

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

Show MsgErrorType

Defined in Simplex.Messaging.Agent.Protocol

Methods

showsPrec :: Int -> MsgErrorType -> ShowS

show :: MsgErrorType -> String

showList :: [MsgErrorType] -> ShowS

data QueueStatus

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

Eq QueueStatus

Defined in Simplex.Messaging.Agent.Protocol

Methods

(==) :: QueueStatus -> QueueStatus -> Bool

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

Read QueueStatus

Defined in Simplex.Messaging.Agent.Protocol

Methods

readsPrec :: Int -> ReadS QueueStatus

readList :: ReadS [QueueStatus]

readPrec :: ReadPrec QueueStatus

readListPrec :: ReadPrec [QueueStatus]

Show QueueStatus

Defined in Simplex.Messaging.Agent.Protocol

Methods

showsPrec :: Int -> QueueStatus -> ShowS

show :: QueueStatus -> String

showList :: [QueueStatus] -> ShowS

FromField QueueStatus

Defined in Simplex.Messaging.Agent.Store.SQLite

Methods

fromField :: FieldParser QueueStatus

ToField QueueStatus

Defined in Simplex.Messaging.Agent.Store.SQLite

Methods

toField :: QueueStatus -> SQLData

type SignatureKey = APrivateKey

Private key used to sign SMP commands

type VerificationKey = PublicKey

Public key used by SMP server to authorize (verify) SMP commands.

type EncryptionKey = PublicKey

Public key used to E2E encrypt SMP messages.

type DecryptionKey = SafePrivateKey

Private key used to E2E decrypt SMP messages.

type ACorrId = ByteString

type AgentMsgId = Int64

Parse and serialize

serializeCommand :: ACommand p -> ByteString

Serialize SMP agent command.

serializeSMPMessage :: SMPMessage -> ByteString

Serialize SMP message.

serializeMsgIntegrity :: MsgIntegrity -> ByteString

Serialize message integrity validation result.

serializeServer :: SMPServer -> ByteString

Serialize SMP server location.

serializeSMPQueueUri :: SMPQueueUri -> ByteString

Serialize SMP queue information that is sent out-of-band.

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

Serialize SMP agent protocol error.

commandP :: Parser ACmd

SMP agent command and response parser

parseSMPMessage :: ByteString -> Either AgentErrorType SMPMessage

Parse SMP message.

smpServerP :: Parser SMPServer

SMP server location parser.

smpQueueUriP :: Parser SMPQueueUri

SMP queue information parser.

connModeT :: Text -> Maybe ConnectionMode

connReqP :: Parser AConnectionRequest

connReqP' :: forall m. ConnectionModeI m => Parser (ConnectionRequest m)

msgIntegrityP :: Parser MsgIntegrity

Message integrity validation result parser.

agentErrorTypeP :: Parser AgentErrorType

SMP agent protocol error parser.

agentMessageP :: Parser AMessage

TCP transport functions

tPut :: (Transport c, MonadIO m) => c -> ATransmission p -> m ()

Send SMP agent protocol command (or response) to TCP connection.

tGet :: forall c m p. (Transport c, MonadIO m) => SAParty p -> c -> m (ATransmissionOrError p)

Receive client and agent transmissions from TCP connection.

tPutRaw :: Transport c => c -> ARawTransmission -> IO ()

Send raw (unparsed) SMP agent protocol transmission to TCP connection.

tGetRaw :: Transport c => c -> IO ARawTransmission

Receive raw (unparsed) SMP agent protocol transmission from TCP connection.