Skip to content

Update protocol spec to align with implementation #113

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update protocol spec to align with implementation #113

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
7 changes: 5 additions & 2 deletions PROTOCOL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The needs that lead to this protocol are:

## Implementation Considerations

# Lumberjack Protocol v1
# Lumberjack Protocol v2

## Behavior

Expand Down Expand Up @@ -38,11 +38,13 @@ This entire protocol is built to be layered on top of TCP or TLS.
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+---------------+---------------+-------------------------------+
| version(1) | frame type | payload ... |
| version | frame type | payload ... |
+---------------------------------------------------------------+
| payload continued... |
+---------------------------------------------------------------+

Version is the protocol version in ASCII (0x32 for protocol version 2)

### 'data' frame type

* SENT FROM WRITER ONLY
Expand Down Expand Up @@ -94,6 +96,7 @@ mean you are acknowledging all data frames before and including '6'.

* SENT FROM WRITER ONLY
* frame type value: ASCII 'W' aka byte value 0x57
* Window frame must be set for each new window. So with a window frame of 1 the window frame must be set before each data frame.

Payload:

Expand Down