diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/protocol.md | 16 |
1 files changed, 13 insertions, 3 deletions
diff --git a/doc/protocol.md b/doc/protocol.md index 74bdbd2..29391c6 100644 --- a/doc/protocol.md +++ b/doc/protocol.md @@ -4,12 +4,16 @@ Messages init ---- -All fields except version are optional. The values in this message are treated as +All fields except "version" are optional. The values in this message are treated as defaults which will be used if the corresponding value is missing in subsequent update messages. { "version": 1, + "SourceHubUuid": "f7df89b4-171e-4b2f-a8a4-e58ac99e5dc5", + "SourceHubDataUpdateId": 23, + "ForwardHubUuid": "b041315e-5039-4c75-81e8-9fd42250b011", + "ForwardHubDataUpdateId": 42, "hostname": "myhostname", "streamer-id": { "content-id": "av-orig", "format": "flash", "quality": "medium" }, "tags": [ "elevate", "2014", "discourse" ] @@ -22,11 +26,17 @@ data-update All values which have been defined by the init message are optional. In any case the values from data updates override values from init. Stateless interfaces will not use init messages and therefore all values must be defined here. -If an interface (i.e. REST) has other means to detect protocol versions the version -field may be omitted entirely. +"SourceHubUuid", "SourceHubDataUpdateId", "ForwardHubUuid", "ForwardHubDataUpdateId", +"user-agent", "bytes-received", "tags" and "clients" might be omitted and are treated +as an empty string, 0 or empty array respectively. +The start-time will be processesd and stored with millisecond precision. { "version": 1, + "SourceHubUuid": "f7df89b4-171e-4b2f-a8a4-e58ac99e5dc5", + "SourceHubDataUpdateId": 23, + "ForwardHubUuid": "b041315e-5039-4c75-81e8-9fd42250b011", + "ForwardHubDataUpdateId": 42, "hostname": "myhostname", "streamer-id": { "content-id": "av-orig", "format": "flash", "quality": "medium" }, "tags": [ "elevate", "2014", "discourse" ] |