Microsoft.Samples.Collections

Heap.Synchronized Method 

Returns a synchronized (thread-safe) wrapper for the Heap.

public static Heap Synchronized(
   Heap heap
);

Parameters

heap
The Heap to synchronize.

Return Value

A synchronized wrapper around the Heap.

Remarks

To guarantee the thread safety of the Heap, all operations must be done through this wrapper. Enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. The following code example shows how to lock the collection using the SyncRoot during the entire enumeration:

            Heap myCollection = new Heap();
            lock( myCollection.SyncRoot ) 
            {
                foreach ( Object item in myCollection ) 
                {
                    // Insert your code here.
                }
            }
            

Exceptions

Exception TypeCondition
ArgumentNullExceptionheap is a null reference (Nothing in Visual Basic).

See Also

Heap Class | Microsoft.Samples.Collections Namespace