fix(iroh-gossip): clarify docs and semantics of gossip joined event #2597
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
Frando
changed the title
Frando
force-pushed
the
fix-docs-gossip-joined
branch
from
3a00d1c
to
d5b3cce
Compare
|
Documentation for this PR has been generated and is available at: https://n0-computer.github.io/iroh/pr/2597/docs/iroh/ Last updated: 2024-08-12T10:47:40Z |
Frando
force-pushed
the
fix-docs-gossip-joined
branch
from
d5b3cce
to
5f6618e
Compare
| .await? | ||
| .context("Gossip receiver closed before Joined event was received.")? | ||
| { | ||
| Event::Gossip(GossipEvent::Joined(_)) => {} |
There was a problem hiding this comment.
why are you throwing the initial neighbours here away?
There was a problem hiding this comment.
They are added to self.neighbors in poll_next already.
dignifiedquire
approved these changes
Aug 12, 2024
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
Improves documentation around the
GossipEvent::Joinedevent: It is only emitted once at the beginning of the stream, and the event will not be emitted when awaitingGossipReceiver::joined.Also makes sure that the event is actually only emitted once per intent (it potentially could have been emitted multiple times before if the neighbor count first got down to 0 and then up again for
GossipTopicssubscribing inbetween).Breaking Changes
Notes & open questions
Inspired by the discussion in deltachat/deltachat-core-rust#5860
Change checklist