[asterisk-commits] russell: branch russell/heap r176017 - /team/russell/heap/include/asterisk/

[SVN commits to the Asterisk project]

Author: russell
Date: Sun Feb 15 21:28:46 2009
New Revision: 176017

URL: http://svn.digium.com/svn-view/asterisk?view=rev&rev=176017
Log:
Make a note that it is expected that locking will be handled by the user of the API.

Modified:
    team/russell/heap/include/asterisk/heap.h

Modified: team/russell/heap/include/asterisk/heap.h
URL: http://svn.digium.com/svn-view/asterisk/team/russell/heap/include/asterisk/heap.h?view=diff&rev=176017&r1=176016&r2=176017
==============================================================================
--- team/russell/heap/include/asterisk/heap.h (original)
+++ team/russell/heap/include/asterisk/heap.h Sun Feb 15 21:28:46 2009
@@ -27,6 +27,11 @@
 
 /*!
  * \brief A max heap.
+ *
+ * \note Thread-safety is left to the user of the API.  The heap API provides
+ *       no locking of its own.  If the heap will be accessed by multiple threads,
+ *       then a lock must be used to ensure that only a single operation is
+ *       done on the heap at a time.
  */
 struct ast_heap;