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

Update Execution Docs #4640

Merged
merged 14 commits into from
Nov 5, 2024
Merged

Update Execution Docs #4640

merged 14 commits into from
Nov 5, 2024

Conversation

nibanks
Copy link
Member

@nibanks nibanks commented Oct 31, 2024

Description

This revamps our documentation on MsQuic's execution mode, including how we manage callbacks and threads.

Testing

N/A

Documentation

Updated

@nibanks nibanks requested a review from a team as a code owner October 31, 2024 12:36
Copy link

codecov bot commented Oct 31, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.78%. Comparing base (fd0adfd) to head (0bc9fb7).
Report is 1 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

docs/Execution.md Outdated Show resolved Hide resolved
docs/Execution.md Outdated Show resolved Hide resolved
docs/Execution.md Outdated Show resolved Hide resolved
docs/Execution.md Outdated Show resolved Hide resolved
docs/Execution.md Outdated Show resolved Hide resolved
docs/Execution.md Outdated Show resolved Hide resolved
docs/Execution.md Outdated Show resolved Hide resolved
```

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.
Copy link
Contributor

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.

Copy link
Member Author

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 musts that we don't do that for throughout the docs. Let's push that to a separate, follow up PR. Ok?

Copy link
Contributor

Choose a reason for hiding this comment

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

OK!

@nibanks nibanks enabled auto-merge (squash) November 5, 2024 09:30
@nibanks nibanks merged commit fd10e12 into main Nov 5, 2024
474 checks passed
@nibanks nibanks deleted the executions-docs branch November 5, 2024 09:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants