diff options
| author | Joey Hess <joeyh@joeyh.name> | 2017-05-01 12:21:22 -0400 |
|---|---|---|
| committer | Joey Hess <joeyh@joeyh.name> | 2017-05-01 12:21:22 -0400 |
| commit | f9db8204bb65983aac5612be7927628538c91f3b (patch) | |
| tree | efa3e16ed807f2be186d044df7f213e9907e3751 | |
| parent | b0addcb5a3e253ea2c94576e399d8494ac540d86 (diff) | |
| download | debug-me-f9db8204bb65983aac5612be7927628538c91f3b.tar.gz | |
links to sources
| -rw-r--r-- | doc/protocol.mdwn | 20 |
1 files changed, 12 insertions, 8 deletions
diff --git a/doc/protocol.mdwn b/doc/protocol.mdwn index d290be7..5a0e679 100644 --- a/doc/protocol.mdwn +++ b/doc/protocol.mdwn @@ -3,10 +3,13 @@ the two participants, known as the user and the developer. The messages are serialized as JSON in debug-me log files, and protocol buffers are used when sending the messages over the wire. We won't go into -the full details here. See Types.hs for the data types that JSON -serialization instances are derived from, and ProocolBuffers.hs for the -protocol buffers format. There is also a simple framing protocol used for -communicating over websockets; see WebSockets.hs. +the full details here. See +[Types.hs](http://source.debug-me.branchable.com/?p=source.git;a=blob;f=Types.hs;hb=HEAD) +for the data types that JSON serialization instances are derived from, and +[ProocolBuffers.hs](http://source.debug-me.branchable.com/?p=source.git;a=blob;f=ProtocolBuffers.hs;hb=HEAD) +for the protocol buffers format. There is also a simple framing protocol +used for communicating over websockets; see +[WebSockets.hs](http://source.debug-me.branchable.com/?p=source.git;a=blob;f=WebSockets.hs;hb=HEAD). The Activity type is the main message type. The user sends Activity Seen messages, and the developer responds with Activity Entered. @@ -21,10 +24,11 @@ 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 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.) +(The exact details about how objects are hashed is not described here; see +[Hash.hs](http://source.debug-me.branchable.com/?p=source.git;a=blob;f=Hash.hs;hb=HEAD) +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.) The user and developer have different points of view. For example, the developer could send an Activity Entered at the same time the user |