bindings: mark Connection as Sync #4467
Merged
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
camshaft
approved these changes
Mar 22, 2024
maddeleine
reviewed
Mar 22, 2024
| /// Note: Although non-mutating methods like getters should be thread-safe by definition, | ||
| /// technically the only thread safety guarantee provided by the underlying C library | ||
| /// is that s2n_send and s2n_recv can be called concurrently. | ||
| /// |
There was a problem hiding this comment.
I feel like this PR is a good time to take a whack at #4413
There was a problem hiding this comment.
Added, but you may regret that ask because the PR is much larger now :)
Please make sure all my reasoning makes sense. I'm trying to walk a fine line between explaining what Send and Sync mean (NOT what our documentation should do-- there's a lot of Rust documentation specifically on that topic) and not being helpful at all.
There was a problem hiding this comment.
Actually, too much larger. I don't want discussion of the documentation changes to block the Sync fix. I've moved the documentation changes to another PR: #4471
This reverts commit 36734d0.
maddeleine
approved these changes
Mar 25, 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.
Resolved issues:
resolves #4461
Description of changes:
Add Sync to the Connection struct. My code comment should explain why that is correct.
Call-outs:
We have to add Sync to ConnectionFuture and ConfigResolver, which is a breaking change. I couldn't find any uses of ConnectionFuture in public github repos or other public sources, so hopefully that breaking change isn't too painful. Only s2n-quic seems to be using ConfigResolver, and only for examples.
Testing:
New test to match Send test for context
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.