besterprotocol/besterd
1
0
Fork 0
mirror of https://github.com/besterprotocol/besterd synced 2023-12-13 21:00:32 +01:00
Code Issues Releases Wiki Activity

Added server->client response spec

Browse source
This commit is contained in:
Tristan B. Kildaire 2020-04-18 21:15:08 +02:00
parent e2074191f0
commit 95f07517fc
1 changed files with 27 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
spec2.md
View file

@ -71,5 +71,30 @@ be a JSON object and *MUST* contain two fields, `type` and `data`, where
#### `Client <- Server`
*TODO*: But basically anything can go here as it is all in order so you will get your
reply.
If a server wants to reply to a client (that just sent a message to it) then
the following bytes must be sent to the client:
````
[ 4 bytes (size - little endian)][JSON message]
````
The `[JSON message]` contains information that the client will
use to gain the following information:
* *Status*: Did the command sent prior to this response
run successfully?
* *Payload*: The data to be processed by the _client_.
The structure of the `[JSON message]` is as follows:
````
{
"header" : {
"status" : "status"
},
"payload" : {
"data" : ...
}
}
````