mbed library sources. Supersedes mbed-src.
Dependents: Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more
Diff: drivers/TimerEvent.h
- Revision:
- 182:a56a73fd2a6f
- Parent:
- 168:9672193075cf
- Child:
- 189:f392fc9709a3
--- a/drivers/TimerEvent.h Fri Feb 16 16:09:33 2018 +0000 +++ b/drivers/TimerEvent.h Tue Mar 20 16:56:18 2018 +0000 @@ -47,13 +47,31 @@ // The handler called to service the timer event of the derived class virtual void handler() = 0; - // insert relative timestamp in to linked list + /** Set relative timestamp of the internal event. + * @param timestamp event's us timestamp + * + * @warning + * Do not insert more than one timestamp. + * The same @a event object is used for every @a insert/insert_absolute call. + * + * @warning + * Ticker's present timestamp is used for reference. For timestamps + * from the past the event is scheduled after ticker's overflow. + * For reference @see convert_timestamp + */ void insert(timestamp_t timestamp); - // insert absolute timestamp into linked list + /** Set absolute timestamp of the internal event. + * @param timestamp event's us timestamp + * + * @warning + * Do not insert more than one timestamp. + * The same @a event object is used for every @a insert/insert_absolute call. + */ void insert_absolute(us_timestamp_t timestamp); - // remove from linked list, if in it + /** Remove timestamp. + */ void remove(); ticker_event_t event;