Skip to content

Ticker with Delegate #6918

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

Jump to bottom
Open
wants to merge 55 commits into
base: master
Choose a base branch
from
Open

Ticker with Delegate #6918

wants to merge 55 commits into from

Conversation

dok-net
Copy link
Contributor

@dok-net dok-net commented Dec 17, 2019

Here's the Ticker (library) ported to Delegate, to complement the IRQ handling, Schedule etc.

@dok-net dok-net force-pushed the ticker_w_delegate branch 5 times, most recently from dab3bf2 to 55a2c31 Compare December 25, 2019 10:42
@dok-net dok-net force-pushed the ticker_w_delegate branch 3 times, most recently from 4c9fddd to db2b2b7 Compare January 22, 2020 08:26
@dok-net dok-net force-pushed the ticker_w_delegate branch 2 times, most recently from c92d17f to 1480a34 Compare February 5, 2020 07:15
@dok-net dok-net force-pushed the ticker_w_delegate branch 2 times, most recently from 88dcb47 to 0323c75 Compare February 13, 2020 21:39
@dok-net dok-net force-pushed the ticker_w_delegate branch 7 times, most recently from dace28a to eabe668 Compare March 1, 2020 16:56
@dok-net dok-net mentioned this pull request Mar 8, 2020
Open
@dok-net dok-net force-pushed the ticker_w_delegate branch from eabe668 to bcbca49 Compare March 10, 2020 18:09
@dok-net dok-net force-pushed the ticker_w_delegate branch 3 times, most recently from 692c039 to 03754d2 Compare March 27, 2020 13:41
@dok-net dok-net force-pushed the ticker_w_delegate branch 4 times, most recently from 09bdaa3 to b9487d7 Compare April 10, 2020 08:36
@dok-net dok-net force-pushed the ticker_w_delegate branch from b9487d7 to 5945a1f Compare May 1, 2020 23:17
@dok-net dok-net force-pushed the ticker_w_delegate branch from 5945a1f to a7cab9d Compare July 16, 2020 10:51
dok-net added 24 commits June 28, 2021 12:48
@dok-net
Refactor uses of unsigned for buffer sizes and item counts to size_t.
188c3f0
@dok-net
It was found that internal linkage suppresses the effect of the IRAM_…
07e52a1 
…ATTR attribute.

This affects the unnamed namespace or static non-member functions.
@dok-net
std::bind is IRAM cache save, lambda is not.
e78885c
@dok-net
Enhancements to MultiDelegate: event multiplexer mode no longer has a…
e3888ca 
…uto-remove. Invoke returns result of last Delegate call.

Caveat: breaks use of event multiplexer with auto-remove; WIP: add iterators.
@dok-net
Added forward iterator and begin() and end() functions to MultiDelegate.
680abe1 
WIP: remove() during iteration.
@dok-net
Change to make MultiDelegate invoke and erase work off iterators.
1f193ab
@dok-net
Constness fix for iterator dereference
57a87ca
@dok-net
constness on return type warning fix.
960c8f5
@dok-net
Conform to C++ 17 and later.
3cd6b91
@dok-net
Resolve g++ 9's c++17 deprecation warnings.
64b06ec
@dok-net
gcc 9.2 is very strict about template inheritance of ctor and assignm…
3b7f2c7 
…ent operators, needing a lot

of code duplication, this commit provides that.
@dok-net
Fix both ambiguous operator= and infinite ctor recursion.
6e17563
@dok-net
don't cast to rvalue ref if also move'ing
df02bac
@dok-net
Add assignment operators.
81ceebd
@dok-net
Example as performance test for Delegate vs. std::function
4fa0dbb
@dok-net
Revert "Add assignment operators."
6b6dbee 
This reverts commit 7c9c23e.
@dok-net
Re-apply std::forwards and minor identifier rename.
099fc86 
(cherry picked from commit 7c9c23e)
@dok-net
More hints for proper use of Delegate to optimize performance.
0fd063c
@dok-net
Apply astyle
66d1704
@dok-net
Added preprocessor define NODELEGATE. Use it for side-by-side compari…
6aa1102 
…son of Delegate<> vs. std::function<>
@dok-net
Field padding improved
9644606
@dok-net
Remove the now-deprecated ICACHE_RAM_ATTR.
8e75ef9
@dok-net
Ticker ported to Delegate
12c27a4
@dok-net
std::bind is IRAM cache safe, but lambdas are not.
c55ffe6
@dok-net dok-net force-pushed the ticker_w_delegate branch from 01ae8e3 to 7fea16a Compare June 28, 2021 10:51
@dok-net
Review has proven that Ticker callbacks are documented to occur in SY…
1878d6f 
…S context, they are

scheduled, not called in ISR.
@dok-net dok-net force-pushed the ticker_w_delegate branch from 7fea16a to 1878d6f Compare June 29, 2021 08:28
@mcspr mcspr mentioned this pull request Jul 2, 2022
Merged
mcspr added a commit that referenced this pull request Nov 1, 2022
@mcspr
Longer delays for Ticker and some internal updates (#8625)
27c0591 
Adds max duration check. In case it is over SDK limit, enable 'repeat'ing timer with a duration proportional to the original one and count until it executes N times, only then run the callback.
Code with durations less than that executes as usual. Original proposal was to not create anything or create some kind of error state... which seems counter-productive to not help out with this pretty solvable use-case.

Additional updates, while refactoring the class
- Stronger types for internal time management using `std::chrono::duration`. Works the same, `std::chrono::duration` handles seconds <-> milliseconds conversion, and we don't have to remember the time type in each method. (...and even allow `once()` and `attach` as overloads instead of the current `_ms`-suffix, in a future update)
- `::detach()` when timer finishes. Fixes (unintentional?) side-effect that we remain `::active()`. Plus, this destroys any lambda-bound variables that will persist with the Ticker object. And, since we can't re-arm with the existing function (`Ticker::attach_ms(uint32_t just_the_time)` and etc.)
- `std::variant` aka union for internal callback storage (kind-of similar to #6918). Instead of having two separate code paths, **always** attach our static function and dispatch using type info. Also helps with the issue described above, since it will call `std::function` dtor when ptr + arg is attached instead of doing nothing.
- smarter copy and move, detaching existing timer on assignment and detaching the moved-in timer object in both ctor and assignment. Copying or moving a running timer no longer blindly copies `_timer` pointer, allowing to disarm the original one. Since we are a simple wrapper around `os_timer_t`, just do the simpler thing (and not re-schedule the callback, try to store original times, etc. polledTimeout already does it and is copyable)
hasenradball pushed a commit to hasenradball/Arduino that referenced this pull request Nov 18, 2024
@mcspr @hasenradball
Longer delays for Ticker and some internal updates (esp8266#8625)
20ca226 
Adds max duration check. In case it is over SDK limit, enable 'repeat'ing timer with a duration proportional to the original one and count until it executes N times, only then run the callback.
Code with durations less than that executes as usual. Original proposal was to not create anything or create some kind of error state... which seems counter-productive to not help out with this pretty solvable use-case.

Additional updates, while refactoring the class
- Stronger types for internal time management using `std::chrono::duration`. Works the same, `std::chrono::duration` handles seconds <-> milliseconds conversion, and we don't have to remember the time type in each method. (...and even allow `once()` and `attach` as overloads instead of the current `_ms`-suffix, in a future update)
- `::detach()` when timer finishes. Fixes (unintentional?) side-effect that we remain `::active()`. Plus, this destroys any lambda-bound variables that will persist with the Ticker object. And, since we can't re-arm with the existing function (`Ticker::attach_ms(uint32_t just_the_time)` and etc.)
- `std::variant` aka union for internal callback storage (kind-of similar to esp8266#6918). Instead of having two separate code paths, **always** attach our static function and dispatch using type info. Also helps with the issue described above, since it will call `std::function` dtor when ptr + arg is attached instead of doing nothing.
- smarter copy and move, detaching existing timer on assignment and detaching the moved-in timer object in both ctor and assignment. Copying or moving a running timer no longer blindly copies `_timer` pointer, allowing to disarm the original one. Since we are a simple wrapper around `os_timer_t`, just do the simpler thing (and not re-schedule the callback, try to store original times, etc. polledTimeout already does it and is copyable)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@dok-net