Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 1.12 KB

protobuf-protocol.md

File metadata and controls

40 lines (26 loc) · 1.12 KB

Protobuf Protocol

FFWD has with a protobuf-based protocol that supports most of the features available in the system.

This protocol is provided by the ffwd-protobuf plugin.

Message Framing

The protocol frames messages as UDP datagrams.

Each message is a frame prefixed with the version and the length of the entire frame.

| version | length | data |
| 4       | 4      | *    |

The version field designates which version of the protocol is in use. This determines the structure of the data field.

The length field designates how long the entire frame is supposed to be, since UDP can crop the message this is used for detecting buffer underruns.

Message Structure

Messages encaupsulated in the data field are serialized according to the protobuf standard.

The following lists the currently available versions and their protobuf definitions.

Client Implementations