diff options
| author |   Linus Nordberg <linus@nordberg.se> | 2019-09-29 22:25:44 +0200 |
|---|---|---|
| committer | Linus Nordberg <linus@nordberg.se> | 2019-10-01 16:22:35 +0200 |
| commit | f7f4c049e6f4320657ad9eef2fab35baf286c92b (patch) | |
| tree | ef3d4daa5534b4d2ded57dc14cc951c1752ccb0b /docs/protocol.md | |
| parent | Fix typo in the previous commits NULL check (diff) | |
| download | wg-dynamic-f7f4c049e6f4320657ad9eef2fab35baf286c92b.tar.xz wg-dynamic-f7f4c049e6f4320657ad9eef2fab35baf286c92b.zip | |
Add draft of protocol specification
Diffstat (limited to 'docs/protocol.md')
| -rw-r--r-- | docs/protocol.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/protocol.md b/docs/protocol.md new file mode 100644 index 0000000..4ff9bd9 --- /dev/null +++ b/docs/protocol.md @@ -0,0 +1,18 @@ +# wg-dynamic protocol + +This document describes version 1 of the wg-dynamic protocol. + +The wg-dynamic protocol runs over a reliable and ordered data stream +between a client and a server. Addressing is done on an upper layer, +typically IP. + +Clients send a request message to a server and the server responds +with a response message. + +Messages are ASCII text with key=value pairs separated by newline +characters. A message ends with two consecutive newline characters. + +The first key=value pair is treated as a command with the key being +the command and the value being the protocol version. The key=value +pairs following the first pair are command attributes. The command in +a response matches the command of the request it's a response to. |