kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-10-12 07:35:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add example code for a heap traversal.

Browse Source 
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@176904 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Russell Bryant
2009-02-18 06:14:47 +00:00
parent a844cfa904
commit b5410fad00
1 changed files with 22 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
include/asterisk/heap.h
View File

@@ -155,6 +155,28 @@ void *ast_heap_remove(struct ast_heap *h, void *elm);
* \note If this function is being used in combination with ast_heap_size() for * \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 * purposes of traversing the heap, the heap must be locked for the entire
* duration of the traversal. * 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); void *ast_heap_peek(struct ast_heap *h, unsigned int index);