Changeset 4154 for pjproject/trunk/pjlib/include/pj/timer.h

Timestamp:

Jun 5, 2012 10:41:17 AM (12 years ago)

Author:

bennylp

Message:

Re #1527: added debugging facility to the timer heap. By enabling PJ_TIMER_DEBUG, application can use pj_timer_heap_dump() or pjsip_endpt_dump() to dump the timer entries along with the source location where it is scheduled from. The macro will also enable dumping the timer heap entries when the SIP endpoint is being destroyed

File:

• pjproject/trunk/pjlib/include/pj/timer.h (modified) (4 diffs)

pjproject/trunk/pjlib/include/pj/timer.h

@@ -86 +86 @@
  * This structure represents an entry to the timer.
  */
-struct pj_timer_entry
+typedef struct pj_timer_entry
 {
     /** 
@@ -118 +118 @@
      */
     pj_time_val _timer_value;
-};
+
+#if PJ_TIMER_DEBUG
+    const char  *src_file;
+    int          src_line;
+#endif
+} pj_timer_entry;
 
 
@@ -209 +214 @@
  * @return          PJ_SUCCESS, or the appropriate error code.
  */
+#if PJ_TIMER_DEBUG
+#  define pj_timer_heap_schedule(ht,e,d) \
+                        pj_timer_heap_schedule_dbg(ht,e,d,__FILE__,__LINE__)
+
+  PJ_DECL(pj_status_t) pj_timer_heap_schedule_dbg( pj_timer_heap_t *ht,
+                                                   pj_timer_entry *entry,
+                                                   const pj_time_val *delay,
+                                                   const char *src_file,
+                                                   int src_line);
+#else
 PJ_DECL(pj_status_t) pj_timer_heap_schedule( pj_timer_heap_t *ht,
                                              pj_timer_entry *entry, 
                                              const pj_time_val *delay);
+#endif  /* PJ_TIMER_DEBUG */
 
 /**
@@ -263 +279 @@
                                       pj_time_val *next_delay);
 
+#if PJ_TIMER_DEBUG
+/**
+ * Dump timer heap entries.
+ *
+ * @param ht        The timer heap.
+ */
+PJ_DECL(void) pj_timer_heap_dump(pj_timer_heap_t *ht);
+#endif
+
 /**
  * @}