Skip to content

fix(specs): fix relay formatting errors #970

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

Merged
merged 3 commits into from
Nov 1, 2025
Merged

fix(specs): fix relay formatting errors #970

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
39acad6
fix(specs): fix relay formatting errors
marbens-arch Oct 31, 2025
82e3102
fix: remove numerical prefix for response codes
marbens-arch Oct 31, 2025
2143d8a
wip
marbens-arch Oct 31, 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
16 changes: 9 additions & 7 deletions specs/relay-v1.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,8 +132,7 @@ messages:
2. ResponseAlreadyConnected - Session is full (both sides already connected)
3. ResponseSuccess - You have successfully joined the session
4. RelayFull - Relay limits are too strict for you to be able to join the session.

The relay immediately terminates the connection after sending this.
The relay immediately terminates the connection after sending this.

After the successful response, all the bytes written and received will be
relayed between the two devices in the session directly.
Expand Down Expand Up @@ -288,11 +287,14 @@ Response message (Type = 4)
Message associated with the code.

.. Protocol defined responses:
1. ResponseSuccess = Response{0, "success"}
2. ResponseNotFound = Response{1, "not found"}
3. ResponseAlreadyConnected = Response{2, "already connected"}
4. ResponseInternalError = Response{99, "internal error"}
5. ResponseUnexpectedMessage = Response{100, "unexpected message"}

::

ResponseSuccess = Response{0, "success"}
ResponseNotFound = Response{1, "not found"}
ResponseAlreadyConnected = Response{2, "already connected"}
ResponseInternalError = Response{99, "internal error"}
ResponseUnexpectedMessage = Response{100, "unexpected message"}

ConnectRequest message (Type = 5)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down