[asterisk-commits] russell: trunk r176904 - /trunk/include/asterisk/heap.h

[SVN commits to the Asterisk project]

Author: russell
Date: Wed Feb 18 00:14:47 2009
New Revision: 176904

URL: http://svn.digium.com/svn-view/asterisk?view=rev&rev=176904
Log:
Add example code for a heap traversal.

Modified:
    trunk/include/asterisk/heap.h

Modified: trunk/include/asterisk/heap.h
URL: http://svn.digium.com/svn-view/asterisk/trunk/include/asterisk/heap.h?view=diff&rev=176904&r1=176903&r2=176904
==============================================================================
--- trunk/include/asterisk/heap.h (original)
+++ trunk/include/asterisk/heap.h Wed Feb 18 00:14:47 2009
@@ -155,6 +155,28 @@
  * \note If this function is being used in combination with ast_heap_size() for
  *       purposes of traversing the heap, the heap must be locked for the entire
  *       duration of the traversal.
+ *
+ * Example code for a traversal:
+ * \code
+ *
+ * struct ast_heap *h;
+ *
+ * ...
+ *
+ * size_t size, i;
+ * void *cur_obj;
+ *
+ * ast_heap_rdlock(h);
+ *
+ * size = ast_heap_size(h);
+ *
+ * for (i = 1; i <= size && (cur_obj = ast_heap_peek(h, i)); i++) {
+ *     ... Do stuff with cur_obj ...
+ * }
+ *
+ * ast_heap_unlock(h);
+ *
+ * \endcode
  */
 void *ast_heap_peek(struct ast_heap *h, unsigned int index);