Conn rework #35
Merged
Conn rework #35
Conversation
This file contains hidden or 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
Problem: it is often necessary to wait for a connection to be running before taking action, or to examine a connection to find out the peer ID of the other end. Furthermore, driving connection futures returned by `Repo::connect` is awkward and easy to forget. Solution: Introduce a `Connection` abstraction which is immediately (synchronously) returned by `Repo::connect` and represents the ongoing state of the connection. This gives us a place to put APIs for connection related actions such as waiting for the handshake to complete. To achieve this we run the connection handling logic on the IO loop, which removes the need for the user to drive a future returned by `Repo::connect`.
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.
This PR changes the
Repo::connectAPI and adds some related features with two broad objectives:Repo::connectfutureThe main shape this change takes is that
Repo::connectnow synchronously returnsConnectionobject, which has methods on it for awaiting handshake completion. The connection handling task is now spawned on the runtime used at construction instead of requiring the user to run it. There are also new APIs onDocHandlefor monitoring connection states:DocHandle::peers, which returns the current state of connected peers for the given document andDocHandle::they_have_our_changesfor waiting for the given connection to say they have received everything we have.