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

Developer-facing documentation for our protocols #6281

Open
jleibs opened this issue May 9, 2024 · 0 comments
Open

Developer-facing documentation for our protocols #6281

jleibs opened this issue May 9, 2024 · 0 comments
Labels
📖 documentation Improvements or additions to documentation 👀 needs triage This issue needs to be triaged by the Rerun team

Comments

@jleibs
Copy link
Member

jleibs commented May 9, 2024

I'm struggling to understan what our actual wire protocol looks like for:

  • RRD streamed over http
  • Messages streamed over tcp

I don't currently understand what aspects of the framing are shared and/or how they diverged.

Example of the kind of questions I'd like to be able to answer:

  • Do we even need a tcp/client PROTOCOL_VERSION, or is it immediately followed by the RRD_HEADER / FileHeader by virtue of buffered_client using re_log_encoding::encoder::encode_to_bytes under the hood?
  • Does Surface SDK version info from channel into StoreInfo #6280 make sense, or do we need a third RRD-schema-version encoded in the StoreInfo instead?
@jleibs jleibs added 📖 documentation Improvements or additions to documentation 👀 needs triage This issue needs to be triaged by the Rerun team labels May 9, 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 👀 needs triage This issue needs to be triaged by the Rerun team
Projects
None yet
Development

No branches or pull requests

1 participant