-
Notifications
You must be signed in to change notification settings - Fork 643
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
docs: ClientBootstrap reuse is not important but permissible on the same thread/EL #2520
Open
weissi
wants to merge
7
commits into
main
Choose a base branch
from
jw-clientboot-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
49c787c
Update Bootstrap.swift
weissi d8606bf
Update Bootstrap.swift
weissi 82e4136
Update Sources/NIOPosix/Bootstrap.swift
weissi bee7ad9
Update Sources/NIOPosix/Bootstrap.swift
weissi becd298
Update Sources/NIOPosix/Bootstrap.swift
weissi d83cc39
Update Bootstrap.swift
weissi e5cef92
Merge branch 'main' into jw-clientboot-docs
weissi File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -700,8 +700,17 @@ private extension Channel { | |
|
||
/// A `ClientBootstrap` is an easy way to bootstrap a `SocketChannel` when creating network clients. | ||
/// | ||
/// Usually you re-use a `ClientBootstrap` once you set it up and called `connect` multiple times on it. | ||
/// This way you ensure that the same `EventLoop`s will be shared across all your connections. | ||
/// You may re-use a `ClientBootstrap` once you set it up and call `connect` multiple times on it. | ||
/// This ensures all connections you create share the same `EventLoop`. | ||
/// | ||
/// Keep in mind that `ClientBoostrap` is not `Sendable`, so you cannot share the same | ||
/// instance across multiple `EventLoop`s or multiple concurrency domains in general. | ||
/// Creating a `ClientBootstrap` is cheap. So instead of arranging synchronization allowing | ||
/// concurrent code to re-use a single `ClientBootstrap` instance across many tasks, it is often | ||
/// easier to create a dedicated instance for each task. | ||
/// multiple threads/`EventLoop`s. Creating a `ClientBootstrap` is cheap so instead of arranging | ||
/// synchronization to re-use a single `ClientBootstrap` instance across threads, it's advisable to | ||
/// create fresh instances. | ||
Comment on lines
+708
to
+713
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This here is somewhat duplicated |
||
/// | ||
/// Example: | ||
/// | ||
|
@@ -719,7 +728,7 @@ private extension Channel { | |
/// // resolves to both IPv4 and IPv6 addresses, cf. Happy Eyeballs). | ||
/// channel.pipeline.addHandler(MyChannelHandler()) | ||
/// } | ||
/// try! bootstrap.connect(host: "example.org", port: 12345).wait() | ||
/// try bootstrap.connect(host: "example.org", port: 12345).wait() | ||
/// /* the Channel is now connected */ | ||
/// ``` | ||
/// | ||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is not true. We are taking the next
EventLoop
from theEventLoopGroup
inconnect
.