Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCS(dev): Clean up network protocol docs #6714

Merged
merged 3 commits into from
Jan 27, 2025
Merged

DOCS(dev): Clean up network protocol docs #6714

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d1fc033
DOCS(dev): Replace nbsp with normal spaces
Kissaki Jan 26, 2025
2aaae8c
DOCS(dev): Fix UTP to TCP ref
Kissaki Jan 26, 2025
5992aa3
DOCS(dev): Drop broken, unnecessary fig ref
Kissaki Jan 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 25 additions & 25 deletions docs/dev/network-protocol/establishing_connection.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,26 +35,26 @@ information using the Version message. The message structure is described below.
+--------------------------------------+
| Version |
+===========================+==========+
| version   | uint32 |
| version | uint32 |
+---------------------------+----------+
| release | string |
| release | string |
+---------------------------+----------+
| os | string |
+---------------------------+----------+
| os_version | string |
| os_version | string |
+---------------------------+----------+

The version field is a combination of major, minor and patch version numbers (e.g. 1.2.0)
so that major number takes two bytes and minor and patch numbers take one byte each.
The structure is shown in figure \ref{fig:versionEncoding}. The release, os and os\_version
The release, os and os\_version
fields are common strings containing additional information.

.. table:: Version field encoding (uint32)

+---------------------------+----------+----------+
| Major | Minor | Patch |
+===========================+==========+==========+
| 2 bytes | 1 byte | 1 byte |
| 2 bytes | 1 byte | 1 byte |
+---------------------------+----------+----------+

The version information may be used as part of the *SuggestConfig* checks, which usually
Expand All @@ -71,9 +71,9 @@ any way at the moment.
+---------------+-------------------------------------------+
| 1.2.2 | CELT 0.7.1 codec support |
+---------------+-------------------------------------------+
| 1.2.3 | CELT 0.11.0 codec |
| 1.2.3 | CELT 0.11.0 codec |
+---------------+-------------------------------------------+
| 1.2.4 | Opus codec support, SuggestConfig message |
| 1.2.4 | Opus codec support, SuggestConfig message |
+---------------+-------------------------------------------+

Authenticate
Expand All @@ -89,9 +89,9 @@ message.
+-----------------------------------------------+
| Authenticate |
+===========================+===================+
| username   | string |
| username | string |
+---------------------------+-------------------+
| password | string |
| password | string |
+---------------------------+-------------------+
| tokens | string |
+---------------------------+-------------------+
Expand Down Expand Up @@ -123,9 +123,9 @@ below. The encryption itself is described in a later section.
+-----------------------------------------------+
| CryptSetup |
+===========================+===================+
| key   | bytes |
| key | bytes |
+---------------------------+-------------------+
| client_nonce | bytes |
| client_nonce | bytes |
+---------------------------+-------------------+
| server_nonce | bytes |
+---------------------------+-------------------+
Expand All @@ -147,7 +147,7 @@ these. The full structure of these ChannelState messages is shown below:
+===========================+===================+
| channel_id | uint32 |
+---------------------------+-------------------+
| parent | uint32 |
| parent | uint32 |
+---------------------------+-------------------+
| name | string |
+---------------------------+-------------------+
Expand All @@ -157,7 +157,7 @@ these. The full structure of these ChannelState messages is shown below:
+---------------------------+-------------------+
| links_add | repeated uint32 |
+---------------------------+-------------------+
| links_remove | repeated uint32 |
| links_remove | repeated uint32 |
+---------------------------+-------------------+
| temporary | optional bool |
+---------------------------+-------------------+
Expand All @@ -181,39 +181,39 @@ currently on the server, including the user that is currently connecting.
+===========================+===================+
| session | uint32 |
+---------------------------+-------------------+
| actor | uint32 |
| actor | uint32 |
+---------------------------+-------------------+
| name | string |
+---------------------------+-------------------+
| user_id | uint32 |
+---------------------------+-------------------+
| channel_id | uint32 |
+---------------------------+-------------------+
| mute | bool |
| mute | bool |
+---------------------------+-------------------+
| deaf | bool |
| deaf | bool |
+---------------------------+-------------------+
| suppress | bool |
| suppress | bool |
+---------------------------+-------------------+
| self_mute | bool |
+---------------------------+-------------------+
| self_deaf | bool |
| self_deaf | bool |
+---------------------------+-------------------+
| texture | bytes |
| texture | bytes |
+---------------------------+-------------------+
| plugin_context | bytes |
| plugin_context | bytes |
+---------------------------+-------------------+
| plugin_identity | string |
| plugin_identity | string |
+---------------------------+-------------------+
| comment | string |
+---------------------------+-------------------+
| hash | string |
| hash | string |
+---------------------------+-------------------+
| comment_hash | bytes |
| comment_hash | bytes |
+---------------------------+-------------------+
 | texture_hash | bytes |
| texture_hash | bytes |
+---------------------------+-------------------+
| priority_speaker | bool |
| priority_speaker | bool |
+---------------------------+-------------------+
| recording | bool |
+---------------------------+-------------------+
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/network-protocol/voice_data.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@ Tunneling audio over TCP

If the UDP channel isn't available the voice packets can be transmitted through
the TCP transport used for the control channel. These messages use the normal
TCP prefixing, as shown in figure :ref:`mumble-packet`: 16-bit message type
TCP prefixing, as shown in `Protocol Stack TCP <protocol_stack_tcp.rst>`_: 16-bit message type
followed by 32-bit message length. However unlike other TCP messages, the audio
packets are not encoded as protocol buffer messages but instead the raw audio
packet described in `Packet format`_ should be written to the TCP socket
Expand Down
Loading