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

[protocolv2] always expect init, input sometimes (docs only) #153

Merged
merged 1 commit into from
May 29, 2024

Conversation

masad-frost
Copy link
Member

@masad-frost masad-frost commented May 28, 2024

Why

Currently we expect:

  • 0 init messages for rpc and subscription, and 0-1 init messages for upload and stream
  • 1-n input messages for upload and stream, and 0 input for rpc and subscription

This works but if we did:

  • 1 init message for all
  • 0-n input messages (always 0 for rpc and subscription)

We'd have a shape of streams that is a little more consistent, making implementations simpler, although practically it's not much simpler since it's papered over in the libraries.

What changed

Updated documentation for init and input.

@masad-frost masad-frost requested a review from a team as a code owner May 28, 2024 23:18
@masad-frost masad-frost requested review from jackyzha0 and removed request for a team May 28, 2024 23:18
@masad-frost
Copy link
Member Author

In practice this doesn't affect the implementations since wire messages don't differentiate between init and input.

@masad-frost masad-frost merged commit e0d311b into protocolv2 May 29, 2024
3 checks passed
@masad-frost masad-frost deleted the fm-init-always branch May 29, 2024 17:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant