Safe Haskell	None
Language	Haskell2010

Simplex.Chat.Remote.Types

Synopsis

data RemoteHostClient = RemoteHostClient {
- hostEncoding :: PlatformEncoding
- hostDeviceName :: Text
- httpClient :: HTTP2Client
- encryption :: RemoteCrypto
- encryptHostFiles :: Bool
- storePath :: FilePath
}
data RemoteCrypto = RemoteCrypto {
- sessionCode :: ByteString
- sndCounter :: TVar Word32
- rcvCounter :: TVar Word32
- chainKeys :: TSbChainKeys
- skippedKeys :: TMap Word32 (SbKeyNonce, SbKeyNonce)
- signatures :: RemoteSignatures
}
getRemoteSndKeys :: RemoteCrypto -> STM (Word32, SbKeyNonce, SbKeyNonce)
getRemoteRcvKeys :: RemoteCrypto -> Word32 -> STM (Either RemoteProtocolError (SbKeyNonce, SbKeyNonce))
data RemoteSignatures
- = RSSign {
  - idPrivKey :: PrivateKeyEd25519
  - sessPrivKey :: PrivateKeyEd25519
  }
- | RSVerify {
  - idPubKey :: PublicKeyEd25519
  - sessPubKey :: PublicKeyEd25519
  }
type SessionSeq = Int
data RHPendingSession = RHPendingSession {
- rhKey :: RHKey
- rchClient :: RCHostClient
- rhsWaitSession :: Async ()
- remoteHost_ :: Maybe RemoteHostInfo
}
data RemoteHostSession
- = RHSessionStarting
- | RHSessionConnecting {
  - invitation :: Text
  - rhPendingSession :: RHPendingSession
  }
- | RHSessionPendingConfirmation {
  - sessionCode :: Text
  - tls :: TLS 'TServer
  - rhPendingSession :: RHPendingSession
  }
- | RHSessionConfirmed {
  - tls :: TLS 'TServer
  - rhPendingSession :: RHPendingSession
  }
- | RHSessionConnected {
  - rchClient :: RCHostClient
  - tls :: TLS 'TServer
  - rhClient :: RemoteHostClient
  - pollAction :: Async ()
  - storePath :: FilePath
  }
data RemoteHostSessionState
- = RHSStarting
- | RHSConnecting {
  - invitation :: Text
  }
- | RHSPendingConfirmation {
  - sessionCode :: Text
  }
- | RHSConfirmed {
  - sessionCode :: Text
  }
- | RHSConnected {
  - sessionCode :: Text
  }
rhsSessionState :: RemoteHostSession -> RemoteHostSessionState
tlsSessionCode :: forall (p :: TransportPeer). TLS p -> Text
data RemoteProtocolError
- = RPEInvalidSize
- | RPEInvalidJSON {
  - invalidJSON :: String
  }
- | RPEInvalidBody {
  - invalidBody :: String
  }
- | PRESessionCode
- | RPEIncompatibleEncoding
- | RPEUnexpectedFile
- | RPENoFile
- | RPEFileSize
- | RPEFileDigest
- | RPEManySkippedIds Word32
- | PREEarlierId Word32
- | PREDuplicateId
- | RPEUnexpectedResponse {
  - response :: Text
  }
- | RPEStoredFileExists
- | PRERemoteControl {
  - rcError :: RCErrorType
  }
- | RPEHTTP2 {
  - http2Error :: Text
  }
- | RPEException {
  - someException :: Text
  }
type RemoteHostId = Int64
data RHKey
- = RHNew
- | RHId {
  - remoteHostId :: RemoteHostId
  }
data RemoteHost = RemoteHost {
- remoteHostId :: RemoteHostId
- hostDeviceName :: Text
- storePath :: FilePath
- bindAddress_ :: Maybe RCCtrlAddress
- bindPort_ :: Maybe Word16
- hostPairing :: RCHostPairing
}
data RemoteHostInfo = RemoteHostInfo {
- remoteHostId :: RemoteHostId
- hostDeviceName :: Text
- storePath :: FilePath
- bindAddress_ :: Maybe RCCtrlAddress
- bindPort_ :: Maybe Word16
- sessionState :: Maybe RemoteHostSessionState
}
type RemoteCtrlId = Int64
data RemoteCtrl = RemoteCtrl {
- remoteCtrlId :: RemoteCtrlId
- ctrlDeviceName :: Text
- ctrlPairing :: RCCtrlPairing
}
remoteCtrlId' :: RemoteCtrl -> RemoteCtrlId
data PlatformEncoding
- = PESwift
- | PEKotlin
localEncoding :: PlatformEncoding
data RemoteFile = RemoteFile {
- userId :: Int64
- fileId :: Int64
- sent :: Bool
- fileSource :: CryptoFile
}
data CtrlAppInfo = CtrlAppInfo {
- appVersionRange :: AppVersionRange
- deviceName :: Text
}
data HostAppInfo = HostAppInfo {
- appVersion :: AppVersion
- deviceName :: Text
- encoding :: PlatformEncoding
- encryptFiles :: Bool
}

Documentation

data RemoteHostClient Source #

Constructors

RemoteHostClient
Fields hostEncoding :: PlatformEncoding hostDeviceName :: Text httpClient :: HTTP2Client encryption :: RemoteCrypto encryptHostFiles :: Bool storePath :: FilePath

data RemoteCrypto Source #

Constructors

RemoteCrypto
Fields sessionCode :: ByteString sndCounter :: TVar Word32 rcvCounter :: TVar Word32 chainKeys :: TSbChainKeys skippedKeys :: TMap Word32 (SbKeyNonce, SbKeyNonce) signatures :: RemoteSignatures

getRemoteSndKeys :: RemoteCrypto -> STM (Word32, SbKeyNonce, SbKeyNonce) Source #

getRemoteRcvKeys :: RemoteCrypto -> Word32 -> STM (Either RemoteProtocolError (SbKeyNonce, SbKeyNonce)) Source #

data RemoteSignatures Source #

Constructors

RSSign
Fields idPrivKey :: PrivateKeyEd25519 sessPrivKey :: PrivateKeyEd25519
RSVerify
Fields idPubKey :: PublicKeyEd25519 sessPubKey :: PublicKeyEd25519

type SessionSeq = Int Source #

data RHPendingSession Source #

Constructors

RHPendingSession
Fields rhKey :: RHKey rchClient :: RCHostClient rhsWaitSession :: Async () remoteHost_ :: Maybe RemoteHostInfo

data RemoteHostSession Source #

Constructors

RHSessionStarting
RHSessionConnecting
Fields invitation :: Text rhPendingSession :: RHPendingSession
RHSessionPendingConfirmation
Fields sessionCode :: Text tls :: TLS 'TServer rhPendingSession :: RHPendingSession
RHSessionConfirmed
Fields tls :: TLS 'TServer rhPendingSession :: RHPendingSession
RHSessionConnected
Fields rchClient :: RCHostClient tls :: TLS 'TServer rhClient :: RemoteHostClient pollAction :: Async () storePath :: FilePath

data RemoteHostSessionState Source #

Constructors

RHSStarting
RHSConnecting
Fields invitation :: Text
RHSPendingConfirmation
Fields sessionCode :: Text
RHSConfirmed
Fields sessionCode :: Text
RHSConnected
Fields sessionCode :: Text

Instances

Instances details

FromJSON RemoteHostSessionState Source #
Instance details Defined in Simplex.Chat.Remote.Types Methods parseJSON :: Value -> Parser RemoteHostSessionState parseJSONList :: Value -> Parser [RemoteHostSessionState] omittedField :: Maybe RemoteHostSessionState
ToJSON RemoteHostSessionState Source #
Instance details Defined in Simplex.Chat.Remote.Types Methods toJSON :: RemoteHostSessionState -> Value toEncoding :: RemoteHostSessionState -> Encoding toJSONList :: [RemoteHostSessionState] -> Value toEncodingList :: [RemoteHostSessionState] -> Encoding omitField :: RemoteHostSessionState -> Bool
Show RemoteHostSessionState Source #
Instance details Defined in Simplex.Chat.Remote.Types Methods showsPrec :: Int -> RemoteHostSessionState -> ShowS show :: RemoteHostSessionState -> String showList :: [RemoteHostSessionState] -> ShowS

rhsSessionState :: RemoteHostSession -> RemoteHostSessionState Source #

tlsSessionCode :: forall (p :: TransportPeer). TLS p -> Text Source #

data RemoteProtocolError Source #

Constructors

RPEInvalidSize	size prefix is malformed
RPEInvalidJSON	failed to parse RemoteCommand or RemoteResponse
Fields invalidJSON :: String
RPEInvalidBody
Fields invalidBody :: String
PRESessionCode
RPEIncompatibleEncoding
RPEUnexpectedFile
RPENoFile
RPEFileSize
RPEFileDigest
RPEManySkippedIds Word32
PREEarlierId Word32
PREDuplicateId
RPEUnexpectedResponse	Wrong response received for the command sent
Fields response :: Text
RPEStoredFileExists	A file already exists in the destination position
PRERemoteControl
Fields rcError :: RCErrorType
RPEHTTP2
Fields http2Error :: Text
RPEException
Fields someException :: Text

Instances

Instances details

FromJSON RemoteProtocolError Source #
Instance details Defined in Simplex.Chat.Remote.Types Methods parseJSON :: Value -> Parser RemoteProtocolError parseJSONList :: Value -> Parser [RemoteProtocolError] omittedField :: Maybe RemoteProtocolError
ToJSON RemoteProtocolError Source #
Instance details Defined in Simplex.Chat.Remote.Types Methods toJSON :: RemoteProtocolError -> Value toEncoding :: RemoteProtocolError -> Encoding toJSONList :: [RemoteProtocolError] -> Value toEncodingList :: [RemoteProtocolError] -> Encoding omitField :: RemoteProtocolError -> Bool
Exception RemoteProtocolError Source #
Instance details Defined in Simplex.Chat.Remote.Types Methods toException :: RemoteProtocolError -> SomeException fromException :: SomeException -> Maybe RemoteProtocolError displayException :: RemoteProtocolError -> String
Show RemoteProtocolError Source #
Instance details Defined in Simplex.Chat.Remote.Types Methods showsPrec :: Int -> RemoteProtocolError -> ShowS show :: RemoteProtocolError -> String showList :: [RemoteProtocolError] -> ShowS
AnyError RemoteProtocolError Source #
Instance details Defined in Simplex.Chat.Remote.Types Methods fromSomeException :: SomeException -> RemoteProtocolError

type RemoteHostId = Int64 Source #

data RHKey Source #

Constructors

RHNew
RHId
Fields remoteHostId :: RemoteHostId

Instances

Instances details

FromJSON RHKey Source #
Instance details Defined in Simplex.Chat.Remote.Types Methods parseJSON :: Value -> Parser RHKey parseJSONList :: Value -> Parser [RHKey] omittedField :: Maybe RHKey
ToJSON RHKey Source #
Instance details Defined in Simplex.Chat.Remote.Types Methods toJSON :: RHKey -> Value toEncoding :: RHKey -> Encoding toJSONList :: [RHKey] -> Value toEncodingList :: [RHKey] -> Encoding omitField :: RHKey -> Bool
Show RHKey Source #
Instance details Defined in Simplex.Chat.Remote.Types Methods showsPrec :: Int -> RHKey -> ShowS show :: RHKey -> String showList :: [RHKey] -> ShowS
Eq RHKey Source #
Instance details Defined in Simplex.Chat.Remote.Types Methods (==) :: RHKey -> RHKey -> Bool (/=) :: RHKey -> RHKey -> Bool
Ord RHKey Source #
Instance details Defined in Simplex.Chat.Remote.Types Methods compare :: RHKey -> RHKey -> Ordering (<) :: RHKey -> RHKey -> Bool (<=) :: RHKey -> RHKey -> Bool (>) :: RHKey -> RHKey -> Bool (>=) :: RHKey -> RHKey -> Bool max :: RHKey -> RHKey -> RHKey min :: RHKey -> RHKey -> RHKey

data RemoteHost Source #

Storable/internal remote host data

Constructors

RemoteHost
Fields remoteHostId :: RemoteHostId hostDeviceName :: Text storePath :: FilePath bindAddress_ :: Maybe RCCtrlAddress bindPort_ :: Maybe Word16 hostPairing :: RCHostPairing

data RemoteHostInfo Source #

UI-accessible remote host information

Constructors

RemoteHostInfo
Fields remoteHostId :: RemoteHostId hostDeviceName :: Text storePath :: FilePath bindAddress_ :: Maybe RCCtrlAddress bindPort_ :: Maybe Word16 sessionState :: Maybe RemoteHostSessionState

Instances

Instances details

FromJSON RemoteHostInfo Source #
Instance details Defined in Simplex.Chat.Remote.Types Methods parseJSON :: Value -> Parser RemoteHostInfo parseJSONList :: Value -> Parser [RemoteHostInfo] omittedField :: Maybe RemoteHostInfo
ToJSON RemoteHostInfo Source #
Instance details Defined in Simplex.Chat.Remote.Types Methods toJSON :: RemoteHostInfo -> Value toEncoding :: RemoteHostInfo -> Encoding toJSONList :: [RemoteHostInfo] -> Value toEncodingList :: [RemoteHostInfo] -> Encoding omitField :: RemoteHostInfo -> Bool
Show RemoteHostInfo Source #
Instance details Defined in Simplex.Chat.Remote.Types Methods showsPrec :: Int -> RemoteHostInfo -> ShowS show :: RemoteHostInfo -> String showList :: [RemoteHostInfo] -> ShowS

type RemoteCtrlId = Int64 Source #

data RemoteCtrl Source #

Storable/internal remote controller data

Constructors

RemoteCtrl
Fields remoteCtrlId :: RemoteCtrlId ctrlDeviceName :: Text ctrlPairing :: RCCtrlPairing

remoteCtrlId' :: RemoteCtrl -> RemoteCtrlId Source #

data PlatformEncoding Source #

Constructors

PESwift
PEKotlin

Instances

Instances details

FromJSON PlatformEncoding Source #
Instance details Defined in Simplex.Chat.Remote.Types Methods parseJSON :: Value -> Parser PlatformEncoding parseJSONList :: Value -> Parser [PlatformEncoding] omittedField :: Maybe PlatformEncoding
ToJSON PlatformEncoding Source #
Instance details Defined in Simplex.Chat.Remote.Types Methods toJSON :: PlatformEncoding -> Value toEncoding :: PlatformEncoding -> Encoding toJSONList :: [PlatformEncoding] -> Value toEncodingList :: [PlatformEncoding] -> Encoding omitField :: PlatformEncoding -> Bool
Show PlatformEncoding Source #
Instance details Defined in Simplex.Chat.Remote.Types Methods showsPrec :: Int -> PlatformEncoding -> ShowS show :: PlatformEncoding -> String showList :: [PlatformEncoding] -> ShowS
Eq PlatformEncoding Source #
Instance details Defined in Simplex.Chat.Remote.Types Methods (==) :: PlatformEncoding -> PlatformEncoding -> Bool (/=) :: PlatformEncoding -> PlatformEncoding -> Bool

localEncoding :: PlatformEncoding Source #

data RemoteFile Source #

Constructors

RemoteFile
Fields userId :: Int64 fileId :: Int64 sent :: Bool fileSource :: CryptoFile

Instances

Instances details

FromJSON RemoteFile Source #
Instance details Defined in Simplex.Chat.Remote.Types Methods parseJSON :: Value -> Parser RemoteFile parseJSONList :: Value -> Parser [RemoteFile] omittedField :: Maybe RemoteFile
ToJSON RemoteFile Source #
Instance details Defined in Simplex.Chat.Remote.Types Methods toJSON :: RemoteFile -> Value toEncoding :: RemoteFile -> Encoding toJSONList :: [RemoteFile] -> Value toEncodingList :: [RemoteFile] -> Encoding omitField :: RemoteFile -> Bool
Show RemoteFile Source #
Instance details Defined in Simplex.Chat.Remote.Types Methods showsPrec :: Int -> RemoteFile -> ShowS show :: RemoteFile -> String showList :: [RemoteFile] -> ShowS

data CtrlAppInfo Source #

Constructors

CtrlAppInfo
Fields appVersionRange :: AppVersionRange deviceName :: Text

Instances

Instances details

FromJSON CtrlAppInfo Source #
Instance details Defined in Simplex.Chat.Remote.Types Methods parseJSON :: Value -> Parser CtrlAppInfo parseJSONList :: Value -> Parser [CtrlAppInfo] omittedField :: Maybe CtrlAppInfo
ToJSON CtrlAppInfo Source #
Instance details Defined in Simplex.Chat.Remote.Types Methods toJSON :: CtrlAppInfo -> Value toEncoding :: CtrlAppInfo -> Encoding toJSONList :: [CtrlAppInfo] -> Value toEncodingList :: [CtrlAppInfo] -> Encoding omitField :: CtrlAppInfo -> Bool
Show CtrlAppInfo Source #
Instance details Defined in Simplex.Chat.Remote.Types Methods showsPrec :: Int -> CtrlAppInfo -> ShowS show :: CtrlAppInfo -> String showList :: [CtrlAppInfo] -> ShowS

data HostAppInfo Source #

Constructors

HostAppInfo
Fields appVersion :: AppVersion deviceName :: Text encoding :: PlatformEncoding encryptFiles :: Bool

Instances

Instances details

FromJSON HostAppInfo Source #
Instance details Defined in Simplex.Chat.Remote.Types Methods parseJSON :: Value -> Parser HostAppInfo parseJSONList :: Value -> Parser [HostAppInfo] omittedField :: Maybe HostAppInfo
ToJSON HostAppInfo Source #
Instance details Defined in Simplex.Chat.Remote.Types Methods toJSON :: HostAppInfo -> Value toEncoding :: HostAppInfo -> Encoding toJSONList :: [HostAppInfo] -> Value toEncodingList :: [HostAppInfo] -> Encoding omitField :: HostAppInfo -> Bool