diff options
| author |   Linus Nordberg <linus@nordberg.se> | 2019-05-06 17:47:50 +0200 |
|---|---|---|
| committer | Linus Nordberg <linus@nordberg.se> | 2019-05-06 17:47:50 +0200 |
| commit | 27c56741114d8c11328420a6e620dfdee3d1a2d3 (patch) | |
| tree | ba43666bd923b0bddc147a0c7e29424620e937f8 | |
| parent | Change error codes returned to client (diff) | |
| download | wg-dynamic-27c56741114d8c11328420a6e620dfdee3d1a2d3.tar.xz wg-dynamic-27c56741114d8c11328420a6e620dfdee3d1a2d3.zip | |
Clarify the generic protocol specification
| -rw-r--r-- | docs/protocol.md | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/docs/protocol.md b/docs/protocol.md index 765840e..4ff9bd9 100644 --- a/docs/protocol.md +++ b/docs/protocol.md @@ -1,13 +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. -The protocol consists of ASCII messages with key=value pairs separated -by newline characters. A message ends with two consecutive newline -characters. +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 are arguments to the command. +pairs following the first pair are command attributes. The command in +a response matches the command of the request it's a response to. |