Simplex.Messaging.Agent

This module defines SMP protocol agent with SQLite persistence.

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

SMP agent over TCP

runSMPAgent :: (MonadRandom m, MonadUnliftIO m) => ATransport -> AgentConfig -> m ()

Runs an SMP agent as a TCP service using passed configuration.

See a full agent executable here: https://github.com/simplex-chat/simplexmq/blob/master/apps/smp-agent/Main.hs

runSMPAgentBlocking :: (MonadRandom m, MonadUnliftIO m) => ATransport -> TMVar Bool -> AgentConfig -> m ()

Runs an SMP agent as a TCP service using passed configuration with signalling.

This function uses passed TMVar to signal when the server is ready to accept TCP requests (True) and when it is disconnected from the TCP socket once the server thread is killed (False).

queue-based SMP agent

getAgentClient :: (MonadUnliftIO m, MonadReader Env m) => m AgentClient

Creates an SMP agent client instance that receives commands and sends responses via TBQueues.

runAgentClient :: (MonadUnliftIO m, MonadReader Env m) => AgentClient -> m ()

Runs an SMP agent instance that receives commands and sends responses via TBQueues.

SMP agent functional API

data AgentClient

Constructors

AgentClient

Fields

• rcvQ :: TBQueue (ATransmission 'Client)
• subQ :: TBQueue (ATransmission 'Agent)
• msgQ :: TBQueue SMPServerTransmission
• smpClients :: TVar (Map SMPServer SMPClient)
• subscrSrvrs :: TVar (Map SMPServer (Map ConnId RcvQueue))
• subscrConns :: TVar (Map ConnId SMPServer)
• activations :: TVar (Map ConnId (Async ()))
• connMsgsQueued :: TVar (Map ConnId Bool)
• smpQueueMsgQueues :: TVar (Map (ConnId, SMPServer, SenderId) (TQueue InternalId))
• smpQueueMsgDeliveries :: TVar (Map (ConnId, SMPServer, SenderId) (Async ()))
• reconnections :: TVar [Async ()]
• clientId :: Int
• agentEnv :: Env
• smpSubscriber :: Async ()
• lock :: TMVar ()

type AgentMonad m = (MonadUnliftIO m, MonadReader Env m, MonadError AgentErrorType m)

Agent monad with MonadReader Env and MonadError AgentErrorType

type AgentErrorMonad m = (MonadUnliftIO m, MonadError AgentErrorType m)

getSMPAgentClient :: (MonadRandom m, MonadUnliftIO m) => AgentConfig -> m AgentClient

Creates an SMP agent client instance

disconnectAgentClient :: MonadUnliftIO m => AgentClient -> m ()

withAgentLock :: MonadUnliftIO m => AgentClient -> m a -> m a

createConnection :: AgentErrorMonad m => AgentClient -> SConnectionMode c -> m (ConnId, ConnectionRequest c)

Create SMP agent connection (NEW command)

joinConnection :: AgentErrorMonad m => AgentClient -> ConnectionRequest c -> ConnInfo -> m ConnId

Join SMP agent connection (JOIN command)

allowConnection :: AgentErrorMonad m => AgentClient -> ConnId -> ConfirmationId -> ConnInfo -> m ()

Allow connection to continue after CONF notification (LET command)

acceptContact :: AgentErrorMonad m => AgentClient -> ConfirmationId -> ConnInfo -> m ConnId

Accept contact after REQ notification (ACPT command)

rejectContact :: AgentErrorMonad m => AgentClient -> ConnId -> ConfirmationId -> m ()

Reject contact (RJCT command)

subscribeConnection :: AgentErrorMonad m => AgentClient -> ConnId -> m ()

Subscribe to receive connection messages (SUB command)

sendMessage :: AgentErrorMonad m => AgentClient -> ConnId -> MsgBody -> m AgentMsgId

Send message to the connection (SEND command)

ackMessage :: AgentErrorMonad m => AgentClient -> ConnId -> AgentMsgId -> m ()

suspendConnection :: AgentErrorMonad m => AgentClient -> ConnId -> m ()

Suspend SMP agent connection (OFF command)

deleteConnection :: AgentErrorMonad m => AgentClient -> ConnId -> m ()

Delete SMP agent connection (DEL command)