docs/JAMULUS_PROTOCOL.md: message reference, directory flows, small fixes#3794
Open
mcfnord wants to merge 4 commits into
Open
docs/JAMULUS_PROTOCOL.md: message reference, directory flows, small fixes#3794mcfnord wants to merge 4 commits into
mcfnord wants to merge 4 commits into
Conversation
…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) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
ann0see
self-requested a review
July 17, 2026 22:08
pljones
reviewed
Jul 18, 2026
| | 34 | `REQ_SPLIT_MESS_SUPPORT` | Request split-message support | | ||
| | 35 | `SPLIT_MESS_SUPPORTED` | Split messages are supported | | ||
| | 36 | `RAWAUDIO_SUPPORTED` | Raw (uncompressed) audio is supported | | ||
| | 2001 | `SPECIAL_SPLIT_MESSAGE` | Container for split messages | |
Collaborator
There was a problem hiding this comment.
Without commentary, this looks peculiar.
2001 is a different type of message from the (other) connection-oriented messages. I'd not put it in the same table.
pljones
reviewed
Jul 18, 2026
|
|
||
| ## Directory Registration and Server Lists | ||
|
|
||
| A directory is a Jamulus server acting as a registry (implemented in `src/serverlist.cpp`, both roles). All directory traffic uses connectionless messages: |
Collaborator
There was a problem hiding this comment.
Can you check through and make sure the following adhere to the style guide:
- Client
- Server
- Directory
all always capitalised when referring to Jamulus "running as a...". The style guide covers a few other things.
Probably applies to the other docs as well.
pljones
reviewed
Jul 18, 2026
Co-authored-by: Peter L Jones <pljones@users.noreply.github.com>
Per review: Client, Server and Directory capitalised when referring to Jamulus in that role, per https://jamulus.io/contribute/Style-and-Tone. Also applies the guide's other defined terms present here (Channel, Jitter Buffer), sentence-case headings, and unit spacing (48 kHz). Code identifiers, message names and file paths unchanged. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
… unregister wording SPECIAL_SPLIT_MESSAGE (2001) moved out of the connection-based table into its own paragraph explaining it is a transport container, not a message type, though each fragment frame is acknowledged/retransmitted (per CProtocol::ParseMessageBody). Connectionless range stated as 1000-1999. Unregister line takes pljones's suggested wording. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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
2 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