Timer support, Documentation improvements #59
Merged
Conversation
This file contains hidden or 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
Co-authored-by: Lucas Müller <muller.lucas@hotmail.com>
Co-authored-by: Lucas Müller <muller.lucas@hotmail.com>
Co-authored-by: Lucas Müller <muller.lucas@hotmail.com>
Co-authored-by: Lucas Müller <muller.lucas@hotmail.com>
Add Timer Support
…ociated with timers
…OLL and BREAK_ON_FAIL
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What?
2.1. Document systems supported by Concord (4b96f66)
2.2. Document special compilation flags that override the default behavior (e76d44d)
2.3. (WIP) Manual pages (9d006ff)
Why?
Concord employs a mono-thread and asynchronous event-loop. As such using
sleep()for performing timed operations would lead to the blocking of the event-loop, resulting in an unresponsive bot. TheTimerAPI designed by @Anotra offers a simple solution for performing timed operations without blocking the loop.How?
By storing the future timestamps matched to their execution context in a min-heap. On each event-loop iteration the head timestamp is checked against the current timestamp, and then its matched context is performed if the total wait time has been met.
Testing?
See
timeout.candtimers.c.Anything Else? (optional)
In the future we want to rewrite our ratelimiting handling with the Timer API introduced by this PR.