Skip to content
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

Better docs for threading guarantees of futures #197

Merged
merged 1 commit into from
Mar 20, 2018

Conversation

Lukasa
Copy link
Contributor

@Lukasa Lukasa commented Mar 20, 2018

It occurred to me that we probably needed better narrative docs for the threading guarantees of EventLoopFuture, so I whipped these up over the weekend. Take a look, let me know what you think.

@Lukasa Lukasa added the 🔨 semver/patch No public API change. label Mar 20, 2018
@Lukasa Lukasa requested review from normanmaurer and weissi March 20, 2018 10:34
///
/// One of the major performance advantages of NIO over something like Node.js or Python’s asyncio is that NIO will
/// by default run multiple event loops at once, on different threads. As most network protocols do not require
/// blocking operation, at least in their low level implementations, this provides enormous speed ups on machines
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not a native speaker but I think it should be either speed-ups or speedups.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

addressed

Copy link
Member

@normanmaurer normanmaurer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great! Thanks for it. Just one nit that may be wrong as I am not a native speaker ...

@Lukasa Lukasa force-pushed the cb-future-threading-doc branch from a49abe4 to f4e731c Compare March 20, 2018 12:40
@normanmaurer
Copy link
Member

LGTM... let us wait for @weissi

Copy link
Member

@weissi weissi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks, that's great!

@normanmaurer normanmaurer merged commit 28014b0 into apple:master Mar 20, 2018
@normanmaurer
Copy link
Member

Thanks... merged

@normanmaurer normanmaurer added this to the 1.3.0 milestone Mar 20, 2018
@Lukasa Lukasa deleted the cb-future-threading-doc branch March 20, 2018 14:33
weissi pushed a commit to weissi/swift-nio that referenced this pull request Jun 13, 2020
Motivation:

Sometimes it's useful to be able to print out objects and see their
internal state. Somehow, HTTP2Handler can't do this.

Modifications:

Add a conformance to HTTP2Handler.

Result:

Awesome debugging output.
weissi pushed a commit to weissi/swift-nio that referenced this pull request Feb 3, 2024
Motivation

Per SwiftNIO's formal version policy, we are ready to drop support for
Swift 5.5.

Modifications

This patch removes the support for 5.5 and all supporting
infrastructure. This includes the test generation functionality, which
is no longer required, as well as the files generated by that
functionality. It updates the dockerfile for 5.8, and it removes all
conditional compilation checks that are now definitionally true.

Result

A nice, clean, 5.6+ codebase
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🔨 semver/patch No public API change.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants