muxers/mplex: Implement AsyncRead and AsyncWrite for Substream
#2706
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This aligns the public API of the `libp2p-mplex` module with the one
from `libp2p-yamux`. This change has two benefits:
1. For standalone users of `libp2p-mplex`, the substreams itself are
now useful, similar to `libp2p-yamux` and don't necessarily need to
be polled via the `StreamMuxer`. The `StreamMuxer` only forwards to
the `Async{Read,Write}` implementations.
2. This will reduce the diff of #2648 because we can chunk the one
giant commit into smaller atomic ones.
This was referenced Jun 15, 2022
4 tasks
|
I've benchmarked this branch separately and cannot reliably find any regressions. The benchmarks do sometimes report changes in the 5% range but those are not stable so I think this change is harmless for performance. |
mxinden
approved these changes
Jun 19, 2022
Agreed. I like that this is making it more consistent with Thanks isolating this change! |
mxinden
reviewed
Jun 19, 2022
| @@ -3,7 +3,7 @@ name = "libp2p-mplex" | |||
| edition = "2021" | |||
| rust-version = "1.56.1" | |||
| description = "Mplex multiplexing protocol for libp2p" | |||
| version = "0.33.0" | |||
| version = "0.34.0" | |||
There was a problem hiding this comment.
Suggested change
| version = "0.34.0" | |
| version = "0.33.1" |
Is this a breaking change?
There was a problem hiding this comment.
Yes because Substream is a public type and has type parameter now!
Co-authored-by: Max Inden <[email protected]>
v0.46.0 is not yet released, thus no need to bump to v0.47.0.
mxinden
reviewed
Jun 20, 2022
24 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This aligns the public API of the
libp2p-mplexmodule with the onefrom
libp2p-yamux. This change has two benefits:For standalone users of
libp2p-mplex, the substreams itself arenow useful, similar to
libp2p-yamuxand don't necessarily need tobe polled via the
StreamMuxer. TheStreamMuxeronly forwards tothe
Async{Read,Write}implementations.This will reduce the diff of core/muxing: Redesign
StreamMuxertrait #2648 because we can chunk the onegiant commit into smaller atomic ones.
Whilst keeping master functional, the state of
StreamMuxeris nowa bit awkward until we merge #2648. However, given we are already
doing things this way for
libp2p-yamuxit shouldn't be an issue?Links to any relevant issues
Will reduce diff in #2648.
Open Questions
Change checklist
I have added tests that prove my fix is effective or that my feature works