diff options
Diffstat (limited to 'protocol.txt')
| -rw-r--r-- | protocol.txt | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/protocol.txt b/protocol.txt index 67317ab..c71a84f 100644 --- a/protocol.txt +++ b/protocol.txt @@ -1,9 +1,9 @@ The debug-me protocol is a series of JSON objects, exchanged between the two participants, known as the user and the developer. -The exact composition of the JSON objects is not described here; see +(The exact composition of the JSON objects is not described here; see Types.hs for the data types that JSON serialization instances are derived -from. +from.) The Activity type is the main message type. The user sends Activity Seen messages, and the developer responds with Activity Entered. @@ -18,10 +18,10 @@ Activity Seen and Activity Entered messages have a prevActivity, which points to the Hash of a previous Activity. (And is Nothing for the first Activity Seen.) So a chain of messages is built up. -The exact details about how these objects are hashed is not described here; +(The exact details about how these objects are hashed is not described here; see Hash.hs for the implementation. Note that the JSON strings are *not* directly hashed (to avoid tying hashing to JSON serialization details), -instead the values in the data types are hashed. +instead the values in the data types are hashed.) The user and developer have different points of view. For example, the developer could send an Activity Entered at the same time the user |