Learn how easy it is to sync an existing GitHub or Google Code repo to a SourceForge project! See Demo

Close

#1054 Protocol docs: make the use of protobuf more clear.

unspecified
open
nobody
None
unspecified
5
2013-10-27
2013-10-27
Mikkel Krautz
No

Imisnew2 on IRC had a problem when trying to implement a Mumble client using the PDF protocol doc in the repo.

He receieved a Version message from the server and stared at the protobuf marshalled message's raw bytes trying to make sense of it. (It should be a uint32 signalling 1.2.4, but the protobuf encoding meant that he couldn't map it to anything that made sense.)

It seems the current protocol docs aren't clear enough about how protobuf is used in the protocol, and we should improve that:

17:06 < Imisnew2> mrkrautz: And marshall it as well ;) The documentation is VERY misleading about this, if you could pass it along. It says it uses protobuf, but it looked like it was saying that the protobuf part was only the header (6bytes). It even goes as far as how to break down the version portion (2bytes, 1byte, 1byte). I guess it's my fault for not googling protbuf after I saw it, heh.

Discussion