Documentation

Fields

• transports :: [(ServiceName, ASrvTransport, AddHTTP)]
   
• smpHandshakeTimeout :: Int
   
• tbqSize :: Natural
   
• msgQueueQuota :: Int
   
• maxJournalMsgCount :: Int
   
• maxJournalStateLines :: Int
   
• queueIdBytes :: Int
   
• msgIdBytes :: Int
   
• serverStoreCfg :: ServerStoreCfg s
   
• storeNtfsFile :: Maybe FilePath
   
• allowNewQueues :: Bool

  set to False to prohibit creating new queues

• newQueueBasicAuth :: Maybe BasicAuth

  simple password that the clients need to pass in handshake to be able to create new queues

• controlPortUserAuth :: Maybe BasicAuth

  control port passwords,

• controlPortAdminAuth :: Maybe BasicAuth
   
• dailyBlockQueueQuota :: Int
   
• messageExpiration :: Maybe ExpirationConfig

  time after which the messages can be removed from the queues and check interval, seconds

• expireMessagesOnStart :: Bool
   
• expireMessagesOnSend :: Bool
   
• idleQueueInterval :: Int64

  interval of inactivity after which journal queue is closed

• notificationExpiration :: ExpirationConfig

  notification expiration interval (seconds)

• inactiveClientExpiration :: Maybe ExpirationConfig

  time after which the socket with inactive client can be disconnected (without any messages or commands, incl. PING), and check interval, seconds

• logStatsInterval :: Maybe Int64

  log SMP server usage statistics, only aggregates are logged, seconds

• logStatsStartTime :: Int64

  time of the day when the stats are logged first, to log at consistent times, irrespective of when the server is started (seconds from 00:00 UTC)

• serverStatsLogFile :: FilePath

  file to log stats

• serverStatsBackupFile :: Maybe FilePath

  file to save and restore stats

• prometheusInterval :: Maybe Int

  interval and file to save prometheus metrics

• prometheusMetricsFile :: FilePath
   
• ntfDeliveryInterval :: Int

  notification delivery interval

• pendingENDInterval :: Int

  interval between sending pending END events to unsubscribed clients, seconds

• smpCredentials :: ServerCredentials
   
• httpCredentials :: Maybe ServerCredentials
   
• smpServerVRange :: VersionRangeSMP

  SMP client-server protocol version range

• transportConfig :: TransportServerConfig

  TCP transport config

• controlPort :: Maybe ServiceName

  run listener on control port

• smpAgentCfg :: SMPClientAgentConfig

  SMP proxy config

• allowSMPProxy :: Bool
   
• serverClientConcurrency :: Int
   
• information :: Maybe ServerPublicInfo

  server public information

• startOptions :: StartOptions
   

Fields

• :: { storeLogFile :: FilePath
   
•    , storeMsgsPath :: FilePath
   
•    } -> ServerStoreCfg (JournalMsgStore 'QSMemory)
   

Fields

• :: { storeCfg :: PostgresStoreCfg
   
•    , storeMsgsPath' :: FilePath
   
•    } -> ServerStoreCfg (JournalMsgStore 'QSPostgres)
   

Fields

• storeLogFile :: FilePath
   
• storeMsgsFile :: Maybe FilePath
   

Fields

• maintenance :: Bool
   
• compactLog :: Bool
   
• logLevel :: LogLevel
   
• skipWarnings :: Bool
   
• confirmMigrations :: MigrationConfirmation
   

Fields

• config :: ServerConfig s
   
• serverActive :: TVar Bool
   
• serverInfo :: ServerInformation
   
• server :: Server s
   
• serverIdentity :: KeyHash
   
• msgStore_ :: MsgStore s
   
• ntfStore :: NtfStore
   
• random :: TVar ChaChaDRG
   
• tlsServerCreds :: Credential
   
• httpServerCreds :: Maybe Credential
   
• serverStats :: ServerStats
   
• sockets :: TVar [(ServiceName, SocketState)]
   
• clientSeq :: TVar ClientId
   
• proxyAgent :: ProxyAgent
   

Fields

• clients :: ServerClients s
   
• subscribers :: ServerSubscribers s
   
• ntfSubscribers :: ServerSubscribers s
   
• savingLock :: Lock
   

Fields

• subQ :: TQueue (ClientSub, ClientId)
   
• queueSubscribers :: SubscribedClients s
   
• serviceSubscribers :: SubscribedClients s
   
• totalServiceSubs :: TVar Int64
   
• subClients :: TVar IntSet
   
• pendingEvents :: TVar (IntMap (NonEmpty (EntityId, BrokerMsg)))
   

Fields

• smpAgent :: SMPClientAgent 'Sender
   

Fields

• clientId :: ClientId
   
• subscriptions :: TMap RecipientId Sub
   
• ntfSubscriptions :: TMap NotifierId ()
   
• serviceSubscribed :: TVar Bool
   
• ntfServiceSubscribed :: TVar Bool
   
• serviceSubsCount :: TVar Int64
   
• ntfServiceSubsCount :: TVar Int64
   
• rcvQ :: TBQueue (NonEmpty (VerifiedTransmission s))
   
• sndQ :: TBQueue (NonEmpty (Transmission BrokerMsg), [Transmission BrokerMsg])
   
• msgQ :: TBQueue (NonEmpty (Transmission BrokerMsg))
   
• procThreads :: TVar Int
   
• endThreads :: TVar (IntMap (Weak ThreadId))
   
• endThreadSeq :: TVar Int
   
• clientTHParams :: THandleParams SMPVersion 'TServer
   
• connected :: TVar Bool
   
• createdAt :: SystemTime
   
• rcvActiveAt :: TVar SystemTime
   
• sndActiveAt :: TVar SystemTime
   

Fields

• subThread :: ServerSub
   
• delivered :: TVar (Maybe (MsgId, SystemSeconds))