diff options
Diffstat (limited to 'protocol.txt')
| -rw-r--r-- | protocol.txt | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/protocol.txt b/protocol.txt index 5bf0f7e..25f239d 100644 --- a/protocol.txt +++ b/protocol.txt @@ -1,12 +1,12 @@ -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 -Types.hs for the data types that JSON serialization instances are derived -from. Also, debug-me uses a binary format instead of sending JSON -over the wire. The wire format is currently implemented using the -Haskell cereal library, and is not specified. There is also a simple -framing protocol used for communicating over websockets; see WebSockets.hs) +The debug-me protocol is a series of messages, exchanged between +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 Activity type is the main message type. The user sends Activity Seen messages, and the developer responds with Activity Entered. |