Skip to content

Update websocket-protocols documentation to reflect implementation #1508

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 1 commit into from
Apr 14, 2025
Merged

Update websocket-protocols documentation to reflect implementation #1508

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 4 additions & 1 deletion docs/source/developers/websocket-protocols.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,14 @@ The Jupyter Server must support the default protocol, in which a kernel message
* - 0
- 4
- 8
- 12
- ...
- offset_0
- offset_1
- offset_2
- ...
* - offset_0
* - offset_number
- offset_0
- offset_1
- offset_2
- ...
Expand All @@ -69,6 +71,7 @@ The Jupyter Server must support the default protocol, in which a kernel message

Where:

* ``offset_number`` is the number of the following offsets (is equal to the number of binary buffers plus one).
* ``offset_0`` is the position of the kernel message (``msg``) from the beginning of this message, in bytes.
* ``offset_1`` is the position of the first binary buffer (``buffer_0``) from the beginning of this message, in bytes (optional).
* ``offset_2`` is the position of the second binary buffer (``buffer_1``) from the beginning of this message, in bytes (optional).
Expand Down