Skip to content

Enhance documentation in scheduled_pool.hpp to clarify task storage a… #44

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.

Sign up for GitHub

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

Merged
Katze719 merged 1 commit into from
Mar 31, 2026
Merged

Enhance documentation in scheduled_pool.hpp to clarify task storage a… #44

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions include/threadschedule/scheduled_pool.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,9 @@ class ScheduledTaskHandle
* schedule_periodic returned a handle) is guaranteed to eventually
* execute, unless it is cancelled or shutdown() is called before it
* becomes due.
* - Tasks are stored in a std::multimap keyed by time point. When
* multiple tasks share the same due time, they are dispatched in
* insertion order (guaranteed by std::multimap since C++11).
* - Tasks that are already due and submitted to the underlying pool
* before shutdown() will still execute (the pool drains its queue).
* - Tasks that are not yet due at the time of shutdown() will NOT
Expand Down
Loading