BLOG | DOCUMENTATION | TRAC

Home --> Documentations --> PJLIB Reference

pj_timer_entry Struct Reference
[Timer Heap Management.]

Data Fields

void * user_data
int id
pj_timer_heap_callbackcb
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

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

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

Callback to be called when the timer expires.

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.

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:

 


PJLIB Open Source, high performance, small footprint, and very very portable framework
Copyright (C) 2006-2009 Teluu Inc.