Skip to content

Commit 19ee9c1

Browse files
Ticker class description update - small interval warning
1 parent 22b183a commit 19ee9c1

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

drivers/Ticker.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,11 @@ class Ticker : public TimerEvent, private NonCopyable<Ticker> {
100100
*
101101
* @param func pointer to the function to be called
102102
* @param t the time between calls in micro-seconds
103+
*
104+
* @note setting @a t to a value shorter that it takes to process the ticker callback
105+
* will cause the system to hang. Ticker callback will be called constantly with no time
106+
* for threads scheduling.
107+
*
103108
*/
104109
void attach_us(Callback<void()> func, us_timestamp_t t) {
105110
_function = func;

0 commit comments

Comments
 (0)