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.

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

Implement wire protocol for byte-level message transmission between devices and the kernel #6

Open
sz-po opened this issue Apr 26, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation feature New feature or request kernel This issue is related to kernel. sdk This issue is related to SDK.

Comments

@sz-po
Copy link
Owner

sz-po commented Apr 26, 2024

The goal of this task is to establish a simple protocol at the byte transmission level.

Firstly, we need to define a message format. JSON messages should be used, which must contain the message type (in string format) and its content as a sequence of bytes.

Secondly, we need to create a mechanism that allows us to connect to io.Reader and attach handlers to it that can respond to a specific type of message. This mechanism should assume that each message is separated by a newline character.

Thirdly, we need to create a mechanism to connect to io.Writer, which provides an abstraction for sending messages. Each message must be separated by a newline character. Since JSON cannot be formatted, any newlines must be correctly converted using escape sequences.

It is important to include a description of the wire format in the readme file.

@sz-po sz-po added documentation Improvements or additions to documentation feature New feature or request kernel This issue is related to kernel. sdk This issue is related to SDK. labels Apr 26, 2024
@sz-po sz-po added this to the v0.1.0 - Blackjack milestone Apr 26, 2024
@sz-po sz-po self-assigned this Apr 26, 2024
@sz-po sz-po changed the title Implement simple wire protocol. Implement simple wire protocol Apr 26, 2024
@sz-po sz-po changed the title Implement simple wire protocol Implement wire protocol for byte-level message transmission between devices and the kernel Apr 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation feature New feature or request kernel This issue is related to kernel. sdk This issue is related to SDK.
Projects
None yet
Development

No branches or pull requests

1 participant