Merge pull request #5045 from maciejbocianski/ticker_fix

Ticker class description update - small interval warning
pull/5217/head
Jimmy Brisson 2017-09-28 14:01:36 -05:00 committed by GitHub
commit f57f0d4631
1 changed files with 5 additions and 0 deletions

View File

@ -101,6 +101,11 @@ public:
* *
* @param func pointer to the function to be called * @param func pointer to the function to be called
* @param t the time between calls in micro-seconds * @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) { void attach_us(Callback<void()> func, us_timestamp_t t) {
// lock only for the initial callback setup // lock only for the initial callback setup