-
Notifications
You must be signed in to change notification settings - Fork 545
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
Update Execution Docs #4640
Update Execution Docs #4640
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #4640 +/- ##
==========================================
- Coverage 87.27% 86.78% -0.49%
==========================================
Files 56 56
Lines 17354 17354
==========================================
- Hits 15145 15061 -84
- Misses 2209 2293 +84 ☔ View full report in Codecov by Sentry. |
``` | ||
|
||
Above is an example of a callback delivered to the listener interface. | ||
The application must register a per-object callback handler to manage all events MsQuic may indicate for that object, returning a status to show if it was successfully handled or not. |
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.
How about emphasizing "must" like MUST used in RFC? MUST MAY REQUIRD etc.
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.
I just checked and we have a LOT of must
s that we don't do that for throughout the docs. Let's push that to a separate, follow up PR. Ok?
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.
OK!
Description
This revamps our documentation on MsQuic's execution mode, including how we manage callbacks and threads.
Testing
N/A
Documentation
Updated