...
In order to consistently define messages the Extended Backus–Naur form grammar will be used.
Usage | Notation |
---|---|
definition | = |
alterationalternation | | |
optional | [ ... ] |
repetition | { ... } |
Groupinggrouping | ( ... ) |
Generic Message definition
Every message will message (except for connection initializing handshakes, which are necessarily insulated from future changes to the message structure) will adhere to the following generic message definition. A Message will comprise of a MessageHeader and either a Request or Response component.
...
Response = APIResponse | Description | |
---|---|---|
APIResponse | type = variable | The Api specific Reponse message. Here are some examples of Response messages PutResponse | GetResponse | PutAllResponse | GetAllResponse | ServerConfigResposneServerConfigResponse | ClientConfigResponse | AuthResponse | ErrorResponse |
...