Skip to content

Ticker class description update - small interval warning #5045

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

Merged
merged 1 commit into from
Sep 28, 2017
Merged
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions drivers/Ticker.h
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,11 @@ class Ticker : public TimerEvent, private NonCopyable<Ticker> {
*
* @param func pointer to the function to be called
* @param t the time between calls in micro-seconds
*
* @note setting @a t to a value shorter that it takes to process the ticker callback
* will cause the system to hang. Ticker callback will be called constantly with no time
* for threads scheduling.
*
*/
void attach_us(Callback<void()> func, us_timestamp_t t) {
_function = func;
Expand Down