Skip to content

Commit

Permalink
Protobuf realizations chpters added.
Browse files Browse the repository at this point in the history
Signed-off-by: Ulf Bjorkengren <[email protected]>
  • Loading branch information
UlfBj committed Sep 20, 2024
1 parent 8109e66 commit c459815
Showing 1 changed file with 31 additions and 1 deletion.
32 changes: 31 additions & 1 deletion spec/VISSv3.0_PayloadEncoding.html
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ <h2>Terminology</h2>
<h2>Transport Payload</h2>
<p>The payload primary format is JSON. This means that the payloads received by a client SHALL have the JSON format,
unless an implementation deliberately deviates from this.
See <a href='#json-def'></a> for the JSON payload format of the messages for the different transport protocols.
See the [[viss3-core]] document for the JSON payload format of the messages for the different transport protocols.
</p>
</section>

Expand Down Expand Up @@ -368,6 +368,36 @@ <h2>Protobuf Schema Definition</h2>
</p>
</section>

<section id="transport-protocol-realizations">
<h2>Transport Protocol Realizations</h2>

<section id="grpc-realization">
<h2>gRPC Realization</h2>
<p>
The "service" clause in the protobuf code in the previous chapter is used by the protoc compiler uses to create a gRPC based communication framework.
</p>
</section>

<section id="websocket-realization">
<h2>Websocket Realization</h2>
<p>
If a server supports protobuf payload encoding over the Websocket protocol then it shall be shown in the server capabilities data
which port number that the server uses to listen for clients that want to issue requests with protobuf encoded payloads.
The recommended port number is 6444.
</p>
</section>

<section id="mqtt-realization">
<h2>MQTT Realization</h2>
<p>
If a server supports protobuf payload encoding over the MQTT protocol then it shall be shown in the server capabilities data
which topic name that the server uses to listen for clients that want to issue requests with protobuf encoded payloads.
The recommended topic name is the topic name used for the unencoded payload channel appended with the string "/protobuf".
</p>
</section>

</section>

<section id="encoding-and-decoding-with-protobuf">
<h2>Encoding and Decoding with Protobuf</h2>
<p>
Expand Down

0 comments on commit c459815

Please sign in to comment.