docs/JAMULUS_PROTOCOL.md: message reference, directory flows, small fixes - #3794
Open
mcfnord wants to merge 2 commits into
Open
docs/JAMULUS_PROTOCOL.md: message reference, directory flows, small fixes#3794mcfnord wants to merge 2 commits into
mcfnord wants to merge 2 commits into
Conversation
ann0see
self-requested a review
July 17, 2026 22:08
pljones
reviewed
Jul 18, 2026
pljones
reviewed
Jul 18, 2026
pljones
reviewed
Jul 18, 2026
ann0see
requested changes
Jul 22, 2026
softins
reviewed
Jul 23, 2026
softins
left a comment
softins
left a comment
Member
There was a problem hiding this comment.
This looks good. Just a few comments and suggested changes.
Member
|
Please squash the commits here. |
…ixes - Explain how receivers classify datagrams (protocol frame vs audio) and specify the CRC and the acknowledge/retransmit mechanism - Add a complete message-ID reference for connection-based and connectionless messages - Add a section on directory registration, server lists and NAT hole punching (registration refresh/timeout intervals, CLM message flows) - Fix message names to match protocol.h (REQ_CHANNEL_INFOS, CHANNEL_INFOS, REQ_CONN_CLIENTS_LIST) - Apply style guide capitalisation (Client, Server, Directory, Channel, Jitter Buffer) per https://jamulus.io/contribute/Style-and-Tone - Move SPECIAL_SPLIT_MESSAGE (2001) out of the connection-based table into its own paragraph explaining it's a transport container, not a message type - Document the raw (uncompressed PCM) audio option alongside OPUS/OPUS64: how it's advertised (FS_RAW_AUDIO in CLM_SERVER_FEATURES), disabled (--noraw), and how the Server tells it apart from OPUS (packet-size comparison, no distinct message type) Co-Authored-By: Peter L Jones <pljones@users.noreply.github.com> Co-Authored-By: Tony Mountifield <tony@mountifield.org> Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
mcfnord
force-pushed
the
enhance-protocol-doc
branch
from
July 27, 2026 06:41
5d057a5 to
2386d21
Compare
pljones
reviewed
Jul 27, 2026
pljones
reviewed
Jul 27, 2026
pljones
reviewed
Jul 27, 2026
…, set the scene for connection-based vs connectionless, state the retransmit bound - "connectionless UDP packets" was doubly redundant: UDP is inherently both connectionless and packet-based. - The text used "connection-based" and "established audio connection" right after calling the transport connectionless, with no explanation. Added a sentence defining what counts as connected in Jamulus terms, so the two message-class names have something to refer to. - The retransmit sentence stopped at "until the acknowledgement arrives". There is in fact no retry counter: OnTimerSendMess() re-sends and SendMessage() restarts the timer while the queue is non-empty, so the loop is bounded only by an ACKN popping the queue or CProtocol::Reset() clearing it (disconnect, time-out, protocol disabled). Stated that, plus the concrete 400 ms value. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
pljones
reviewed
Jul 29, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
One file. Fills the main gaps in the protocol doc, verified against
src/protocol.cpp/src/socket.cpp/src/serverlist.cppon current main:CSocket::ProcessPacket()), the CRC parameters, and how acknowledge/retransmit actually works — previously the doc said only "must be acknowledged".protocol.h.CLM_SEND_EMPTY_MESSAGE/CLM_EMPTY_MESSAGENAT hole-punch flow — previously undocumented here despite being a third of the connectionless messages.protocol.h(REQ_CHANNEL_INFOS,CHANNEL_INFOS,REQ_CONN_CLIENTS_LIST).CHANGELOG: SKIP
🤖 Generated with Claude Code