mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

types for async protocol extension

Browse source 
renamed AsyncMessage to ExceptionalMessage to make way for this new
extension.
This commit is contained in:
Joey Hess 2020-08-12 12:04:12 -04:00
parent 482422b9c5
commit 5f4228dc2b
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
3 changed files with 36 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

24
Remote/External/Types.hs vendored
View file

@ -25,7 +25,7 @@ module Remote.External.Types (
Response(..),
RemoteRequest(..),
RemoteResponse(..),
AsyncMessage(..),
ExceptionalMessage(..),
ErrorMsg,
Setting,
Description,
@ -88,9 +88,8 @@ type PID = Int
newtype ExtensionList = ExtensionList [String]
deriving (Show)
-- When adding a new RemoteRequest, also add it to the list here.
supportedExtensionList :: ExtensionList
supportedExtensionList = ExtensionList ["INFO"]
supportedExtensionList = ExtensionList ["INFO", "ASYNC"]
data PrepareStatus = Unprepared | Prepared | FailedPrepare ErrorMsg
@ -323,17 +322,29 @@ instance Proto.Sendable RemoteResponse where
formatMessage (CREDS login password) = [ "CREDS", Proto.serialize login, Proto.serialize password ]
-- Messages that can be sent at any time by either git-annex or the remote.
data AsyncMessage
data ExceptionalMessage
= ERROR ErrorMsg
deriving (Show)
instance Proto.Sendable AsyncMessage where
instance Proto.Sendable ExceptionalMessage where
formatMessage (ERROR err) = [ "ERROR", Proto.serialize err ]
instance Proto.Receivable AsyncMessage where
instance Proto.Receivable ExceptionalMessage where
parseCommand "ERROR" = Proto.parse1 ERROR
parseCommand _ = Proto.parseFail
-- Messages used by the async protocol extension.
data AsyncMessage
= START_ASYNC JobId
| END_ASYNC JobId
| UPDATE_ASYNC JobId
instance Proto.Receivable AsyncMessage where
parseCommand "START-ASYNC" = Proto.parse1 START_ASYNC
parseCommand "END-ASYNC" = Proto.parse1 END_ASYNC
parseCommand "UPDATE-ASYNC" = Proto.parse1 UPDATE_ASYNC
parseCommand _ = Proto.parseFail
-- Data types used for parameters when communicating with the remote.
-- All are serializable.
type ErrorMsg = String
@ -341,6 +352,7 @@ type Setting = String
type Description = String
type ProtocolVersion = Int
type Size = Maybe Integer
type JobId = String
supportedProtocolVersions :: [ProtocolVersion]
supportedProtocolVersions = [1]