Documentation

Fields

• tcpPort :: Maybe ServiceName
   
• rcvAuthAlg :: AuthAlg
   
• sndAuthAlg :: AuthAlg
   
• connIdBytes :: Int
   
• tbqSize :: Natural
   
• smpCfg :: ProtocolClientConfig SMPVersion
   
• ntfCfg :: ProtocolClientConfig NTFVersion
   
• xftpCfg :: XFTPClientConfig
   
• reconnectInterval :: RetryInterval
   
• messageRetryInterval :: RetryInterval2
   
• userNetworkInterval :: Int
   
• userOfflineDelay :: NominalDiffTime
   
• messageTimeout :: NominalDiffTime
   
• connDeleteDeliveryTimeout :: NominalDiffTime
   
• helloTimeout :: NominalDiffTime
   
• quotaExceededTimeout :: NominalDiffTime
   
• persistErrorInterval :: NominalDiffTime
   
• initialCleanupDelay :: Int64
   
• cleanupInterval :: Int64
   
• cleanupBatchSize :: Int
   
• initialLogStatsDelay :: Int64
   
• logStatsInterval :: Int64
   
• cleanupStepInterval :: Int
   
• maxWorkerRestartsPerMin :: Int
   
• storedMsgDataTTL :: NominalDiffTime
   
• rcvFilesTTL :: NominalDiffTime
   
• sndFilesTTL :: NominalDiffTime
   
• xftpConsecutiveRetries :: Int
   
• xftpMaxRecipientsPerRequest :: Int
   
• deleteErrorCount :: Int
   
• ntfCron :: Word16
   
• ntfBatchSize :: Int
   
• ntfSubFirstCheckInterval :: NominalDiffTime
   
• ntfSubCheckInterval :: NominalDiffTime
   
• subsBatchSize :: Int
   
• caCertificateFile :: FilePath
   
• privateKeyFile :: FilePath
   
• certificateFile :: FilePath
   
• rcvExpireCount :: Int
   
• rcvExpireInterval :: NominalDiffTime
   
• e2eEncryptVRange :: VersionRangeE2E
   
• smpAgentVRange :: VersionRangeSMPA
   
• smpClientVRange :: VersionRangeSMPC
   

Fields

• smp :: Map UserId (NonEmpty (ServerCfg 'PSMP))
   
• ntf :: [NtfServer]
   
• xftp :: Map UserId (NonEmpty (ServerCfg 'PXFTP))
   
• netCfg :: NetworkConfig
   
• presetDomains :: [HostName]
   
• presetServers :: [SMPServer]
   

Fields

• server :: ProtoServerWithAuth p
   
• operator :: Maybe OperatorId
   
• enabled :: Bool
   
• roles :: ServerRoles
   

Fields

• storage :: Bool
   
• proxy :: Bool
   

Fields

• storageSrvs :: NonEmpty (Maybe OperatorId, ProtoServerWithAuth p)
   
• proxySrvs :: NonEmpty (Maybe OperatorId, ProtoServerWithAuth p)
   
• knownHosts :: Set TransportHost
   

Fields

• socksProxy :: Maybe SocksProxyWithAuth

  use SOCKS5 proxy

• socksMode :: SocksMode

  when to use SOCKS proxy

• hostMode :: HostMode

  determines critera which host is chosen from the list

• requiredHostMode :: Bool

  if above criteria is not met, if the below setting is True return error, otherwise use the first host

• sessionMode :: TransportSessionMode

  transport sessions are created per user or per entity

• smpProxyMode :: SMPProxyMode

  SMP proxy mode

• smpProxyFallback :: SMPProxyFallback

  Fallback to direct connection when destination SMP relay does not support SMP proxy protocol extensions

• smpWebPortServers :: SMPWebPortServers

  use web port 443 for SMP protocol

• tcpConnectTimeout :: NetworkTimeout

  timeout for the initial client TCP/TLS connection (microseconds)

• tcpTimeout :: NetworkTimeout

  timeout of protocol commands (microseconds)

• tcpTimeoutPerKb :: Int64

  additional timeout per kilobyte (1024 bytes) to be sent

• rcvConcurrency :: Int

  break response timeouts into groups, so later responses get later deadlines

• tcpKeepAlive :: Maybe KeepAliveOpts

  TCP keep-alive options, Nothing to skip enabling keep-alive

• smpPingInterval :: Int64

  period for SMP ping commands (microseconds, 0 to disable)

• smpPingCount :: Int

  the count of timeout errors after which SMP client terminates (and will be reconnected), 0 to disable

• logTLSErrors :: Bool
   

Fields

• config :: AgentConfig
   
• store :: DBStore
   
• random :: TVar ChaChaDRG
   
• randomServer :: TVar StdGen
   
• ntfSupervisor :: NtfSupervisor
   
• xftpAgent :: XFTPAgent
   
• multicastSubscribers :: TMVar Int
   

Fields

• ntfTkn :: TVar (Maybe NtfToken)
   
• ntfSubQ :: TBQueue (NtfSupervisorCommand, NonEmpty ConnId)
   
• ntfWorkers :: TMap NtfServer Worker
   
• ntfSMPWorkers :: TMap SMPServer Worker
   
• ntfTknDelWorkers :: TMap NtfServer Worker
   

Fields

• xftpWorkDir :: TVar (Maybe FilePath)
   
• xftpRcvWorkers :: TMap (Maybe XFTPServer) Worker
   
• xftpSndWorkers :: TMap (Maybe XFTPServer) Worker
   
• xftpDelWorkers :: TMap XFTPServer Worker
   

Fields

• workerId :: Int
   
• doWork :: TMVar ()
   
• action :: TMVar (Maybe (Weak ThreadId))
   
• restarts :: TVar RestartCount
   

Fields

• restartMinute :: Int64
   
• restartCount :: Int