diff --git a/protocol.md b/protocol.md index d54f39d..80481e4 100644 --- a/protocol.md +++ b/protocol.md @@ -38,14 +38,35 @@ is mainly designed for sending files from a CPE or streaming data from the CPE, and request response handling will need to be handled via events instead of the simpler "Simple Request-Response" (msg_type = 3) message type. +The destination (dst) field of the Simple Event message must be in the following format: +```bnf +event:/ + + ::= + ::= +``` +- `application-id`: A unique application identifier. +- `stream-id`: The unique stream identifier. + The wrp message headers field should contain the following control headers: ```bnf - ::= - ::= "0" | [1-9][0-9]* + ::= [1-9][0-9]* ::= ::= [1-9][0-9]* +``` + +Any whitespace found is ignored as well as the case of the labels. + +- `stream-packet-number`: **Required** The 0-index based packet reassembly order. +- `stream-final-packet`: **Required** Marks the final packet in the stream and + end of stream reason. Only present in the final packet. +- `stream-estimated-total-length`: **Optional** Indicates the estimated total + length if the stream is a known size. The value is informative only. +### String Grammar +The following grammar is used for above fields defined as : +```bnf ::= | | * ::= "A" | "B" | "C" | "D" | "E" | "F" | "G" | "H" | "I" | "J" | "K" | "L" | "M" | "N" | "O" | "P" | "Q" | "R" | "S" | "T" | @@ -59,15 +80,6 @@ The wrp message headers field should contain the following control headers: "\" | "]" | "_" | | "~" ``` -Any whitespace found is ignored as well as the case of the labels. - -- `stream-id`: **Required** The unique stream identifier. -- `stream-packet-number`: **Required** The 0-index based packet reassembly order. -- `stream-final-packet`: **Required** Marks the final packet in the stream and - end of stream reason. Only present in the final packet. -- `stream-estimated-total-length`: **Optional** Indicates the estimated total - length if the stream is a known size. The value is informative only. - ## 3. Segmentation and Reassembly Data should be segmented into smaller blocks and placed in the `payload` field @@ -96,4 +108,4 @@ without modifications and thus has a few limitations. ### Lost Packets Packet loss MAY happen. It is outside the scope of the protocol to address how -to handle this. \ No newline at end of file +to handle this.