ecu_timer Struct Reference

ECU: ecu_timer Struct Reference
ECU
ecu_timer Struct Reference

Timer object represented as node in linked list. More...

#include <timer.h>

Collaboration diagram for ecu_timer:
[legend]

Data Fields

struct ecu_dnode dnode
 Linked list node in ecu_tlist.
 
ecu_tick_t expiration
 Absolute time, in ticks, when this timer expires.
 
ecu_tick_t period
 Timer expires once elapsed ticks exceeds this value.
 
enum ecu_timer_type_e type
 Single shot, periodic, etc.
 
bool(* callback )(struct ecu_timer *me, void *obj)
 Mandatory callback that executes when timer expires. First parameter passed is this timer object. Callback should return true if successful or return false if it needs to be retried in the next call to ecu_tlist_service(). An example return false scenario could be a write to a queue failed due to it being full, so the write needs to be reattempted.
 
void * obj
 Optional object to pass to ecu_timer::callback.
 

Detailed Description

Timer object represented as node in linked list.

Warning
PRIVATE. Unless otherwise specified, all members can only be edited via the public API.

The documentation for this struct was generated from the following file: