Safe Haskell	None
Language	Haskell2010

Simplex.Chat.Remote.Protocol

Contents

Client side / desktop
- Commands
Transport-level wrappers

Synopsis

data RemoteCommand
- = RCSend {
  - command :: Text
  - retryNumber :: Int
  }
- | RCRecv {
  - wait :: Int
  }
- | RCStoreFile {
  - fileName :: String
  - fileSize :: Word32
  - fileDigest :: FileDigest
  }
- | RCGetFile {
  - file :: RemoteFile
  }
data RemoteResponse
- = RRChatResponse {
  - chatResponse :: RRResult ChatResponse
  }
- | RRChatEvent {
  - chatEvent :: Maybe (RRResult ChatEvent)
  }
- | RRFileStored {
  - filePath :: String
  }
- | RRFile {
  - fileSize :: Word32
  - fileDigest :: FileDigest
  }
- | RRProtocolError {
  - remoteProcotolError :: RemoteProtocolError
  }
data RRResult r
- = RRResult {
  - result :: r
  }
- | RRError {
  - error :: ChatError
  }
resultToEither :: RRResult r -> Either ChatError r
eitherToResult :: Either ChatError r -> RRResult r
mkRemoteHostClient :: HTTP2Client -> HostSessKeys -> SessionCode -> FilePath -> HostAppInfo -> CM RemoteHostClient
mkCtrlRemoteCrypto :: CtrlSessKeys -> SessionCode -> CM RemoteCrypto
mkRemoteCrypto :: SessionCode -> TSbChainKeys -> RemoteSignatures -> IO RemoteCrypto
closeRemoteHostClient :: RemoteHostClient -> IO ()
remoteSend :: RemoteHostClient -> ByteString -> Int -> ExceptT RemoteProtocolError IO (Either ChatError ChatResponse)
remoteRecv :: RemoteHostClient -> Int -> ExceptT RemoteProtocolError IO (Maybe (Either ChatError ChatEvent))
remoteStoreFile :: RemoteHostClient -> FilePath -> FilePath -> ExceptT RemoteProtocolError IO FilePath
remoteGetFile :: RemoteHostClient -> FilePath -> RemoteFile -> ExceptT RemoteProtocolError IO ()
sendRemoteCommand' :: RemoteHostClient -> Maybe (Handle, Word32) -> RemoteCommand -> ExceptT RemoteProtocolError IO RemoteResponse
sendRemoteCommand :: RemoteHostClient -> Maybe (Handle, Word32) -> RemoteCommand -> ExceptT RemoteProtocolError IO (SbKeyNonce, Int -> IO ByteString, RemoteResponse)
badResponse :: RemoteResponse -> ExceptT RemoteProtocolError IO a
convertJSON :: PlatformEncoding -> PlatformEncoding -> Value -> Value
owsf2tagged :: Value -> Value
pattern OwsfTag :: (Key, Value)
encryptEncodeHTTP2Body :: Word32 -> SbKeyNonce -> RemoteCrypto -> LazyByteString -> ExceptT RemoteProtocolError IO Builder
parseDecryptHTTP2Body :: HTTP2BodyChunk a => RemoteCrypto -> a -> HTTP2Body -> ExceptT RemoteProtocolError IO (SbKeyNonce, LazyByteString, Int -> IO ByteString)

Documentation

data RemoteCommand Source #

Constructors

RCSend
Fields command :: Text retryNumber :: Int
RCRecv
Fields wait :: Int
RCStoreFile
Fields fileName :: String fileSize :: Word32 fileDigest :: FileDigest
RCGetFile
Fields file :: RemoteFile

Instances

Instances details

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

data RemoteResponse Source #

Constructors

RRChatResponse
Fields chatResponse :: RRResult ChatResponse
RRChatEvent
Fields chatEvent :: Maybe (RRResult ChatEvent)
RRFileStored
Fields filePath :: String
RRFile
Fields fileSize :: Word32 fileDigest :: FileDigest
RRProtocolError
Fields remoteProcotolError :: RemoteProtocolError

Instances

Instances details

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

data RRResult r Source #

Constructors

RRResult
Fields result :: r
RRError
Fields error :: ChatError

Instances

Instances details

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

resultToEither :: RRResult r -> Either ChatError r Source #

eitherToResult :: Either ChatError r -> RRResult r Source #

Client side / desktop

mkRemoteHostClient :: HTTP2Client -> HostSessKeys -> SessionCode -> FilePath -> HostAppInfo -> CM RemoteHostClient Source #

mkCtrlRemoteCrypto :: CtrlSessKeys -> SessionCode -> CM RemoteCrypto Source #

mkRemoteCrypto :: SessionCode -> TSbChainKeys -> RemoteSignatures -> IO RemoteCrypto Source #

closeRemoteHostClient :: RemoteHostClient -> IO () Source #

Commands

remoteSend :: RemoteHostClient -> ByteString -> Int -> ExceptT RemoteProtocolError IO (Either ChatError ChatResponse) Source #

remoteRecv :: RemoteHostClient -> Int -> ExceptT RemoteProtocolError IO (Maybe (Either ChatError ChatEvent)) Source #

remoteStoreFile :: RemoteHostClient -> FilePath -> FilePath -> ExceptT RemoteProtocolError IO FilePath Source #

remoteGetFile :: RemoteHostClient -> FilePath -> RemoteFile -> ExceptT RemoteProtocolError IO () Source #

sendRemoteCommand' :: RemoteHostClient -> Maybe (Handle, Word32) -> RemoteCommand -> ExceptT RemoteProtocolError IO RemoteResponse Source #

sendRemoteCommand :: RemoteHostClient -> Maybe (Handle, Word32) -> RemoteCommand -> ExceptT RemoteProtocolError IO (SbKeyNonce, Int -> IO ByteString, RemoteResponse) Source #

badResponse :: RemoteResponse -> ExceptT RemoteProtocolError IO a Source #

Transport-level wrappers

convertJSON :: PlatformEncoding -> PlatformEncoding -> Value -> Value Source #

owsf2tagged :: Value -> Value Source #

Convert swift single-field sum encoding into tagged/discriminator-field

pattern OwsfTag :: (Key, Value) Source #

encryptEncodeHTTP2Body :: Word32 -> SbKeyNonce -> RemoteCrypto -> LazyByteString -> ExceptT RemoteProtocolError IO Builder Source #

parseDecryptHTTP2Body :: HTTP2BodyChunk a => RemoteCrypto -> a -> HTTP2Body -> ExceptT RemoteProtocolError IO (SbKeyNonce, LazyByteString, Int -> IO ByteString) Source #

Parse and decrypt HTTP2 request/response