pj_timer_entry Struct Reference [Timer Heap Management.]

Data Fields
void *	user_data
int	id
pj_timer_heap_callback *	cb
pj_timer_id_t	_timer_id
pj_time_val	_timer_value

---

Detailed Description

This structure represents an entry to the timer.

Forward declaration for timer entry.

---

Field Documentation

pj_timer_id_t pj_timer_entry::_timer_id

Internal unique timer ID, which is assigned by the timer heap. Application should not touch this ID.

pj_time_val pj_timer_entry::_timer_value

The future time when the timer expires, which the value is updated by timer heap when the timer is scheduled.

pj_timer_heap_callback* pj_timer_entry::cb

Callback to be called when the timer expires.

int pj_timer_entry::id

Arbitrary ID assigned by the user/owner of this entry. Applications can use this ID to distinguish multiple timer entries that share the same callback and user_data.

void* pj_timer_entry::user_data

User data to be associated with this entry. Applications normally will put the instance of object that owns the timer entry in this field.

---

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

• timer.h