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

Carify usage and behaviour of stream resets #466

Open
thomaseizinger opened this issue Oct 11, 2022 · 3 comments · May be fixed by #469
Open

Carify usage and behaviour of stream resets #466

thomaseizinger opened this issue Oct 11, 2022 · 3 comments · May be fixed by #469

Comments

@thomaseizinger
Copy link
Contributor

Inspired by this discussion: #412 (comment)

Currently, several specifications (mplex, yamux and WebRTC) talk about the capability of a "stream reset".

mplex properly documents, what a reset actually is and how clients are meant to behave when receiving a reset.

yamux also has a section on "Closing a stream" with similar semantics.

I'd like to suggest to introduce a "Resetting a stream" section perhaps under "Definitions" which documents how any libp2p substream should behave in regards to resets.

This will give us a canonical place to link to and clarify, what a stream reset actually is. The current state is confusing because the draft WebRTC spec for example talks about only terminating the sending part. See #412 (comment) for details.

cc @mxinden @marten-seemann

@mxinden
Copy link
Member

mxinden commented Oct 13, 2022

I'd like to suggest to introduce a "Resetting a stream" section perhaps under "Definitions" which documents how any libp2p substream should behave in regards to resets.

Sounds good to me. @thomaseizinger would you mind proposing a paragraph?

@thomaseizinger
Copy link
Contributor Author

I'd like to suggest to introduce a "Resetting a stream" section perhaps under "Definitions" which documents how any libp2p substream should behave in regards to resets.

Sounds good to me. @thomaseizinger would you mind proposing a paragraph?

Happy to make the changes yeah, just wanted to get a feeling for what people think before I waste time writing something up :)

@thomaseizinger thomaseizinger linked a pull request Oct 14, 2022 that will close this issue
@thomaseizinger
Copy link
Contributor Author

Started here: #469

Feedback welcome!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Triage
Development

Successfully merging a pull request may close this issue.

2 participants