minor: Add warning method doc about possibly inconsistent results returned from BlockingQueue.Contains(), Count() and GetQueueArray()

1 files changed, 19 insertions, 1 deletions

diff --git a/OpenSim/Framework/BlockingQueue.cs b/OpenSim/Framework/BlockingQueue.cs
index cc016b0..aef1192 100644
--- a/OpenSim/Framework/BlockingQueue.cs
+++ b/OpenSim/Framework/BlockingQueue.cs
@@ -89,6 +89,12 @@ namespace OpenSim.Framework
             }
         }
 
+        /// <summary>
+        /// Indicate whether this queue contains the given item.
+        /// </summary>
+        /// <remarks>
+        /// This method is not thread-safe.  Do not rely on the result without consistent external locking.
+        /// </remarks>
         public bool Contains(T item)
         {
             if (m_queue.Count < 1 && m_pqueue.Count < 1)
@@ -102,11 +108,23 @@ namespace OpenSim.Framework
             }
         }
 
+        /// <summary>
+        /// Return a count of the number of requests on this queue.
+        /// </summary>
+        /// <remarks>
+        /// This method is not thread-safe.  Do not rely on the result without consistent external locking.
+        /// </remarks>
         public int Count()
         {
-            return m_queue.Count+m_pqueue.Count;
+            return m_queue.Count + m_pqueue.Count;
         }
 
+        /// <summary>
+        /// Return the array of items on this queue.
+        /// </summary>
+        /// <remarks>
+        /// This method is not thread-safe.  Do not rely on the result without consistent external locking.
+        /// </remarks>
         public T[] GetQueueArray()
         {
             if (m_queue.Count < 1 && m_pqueue.Count < 1)