Queue<T>.ICollection.SyncRoot Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets an object that can be used to synchronize access to the ICollection.
property System::Object ^ System::Collections::ICollection::SyncRoot { System::Object ^ get(); };object System.Collections.ICollection.SyncRoot { get; }member this.System.Collections.ICollection.SyncRoot : obj ReadOnly Property SyncRoot As Object Implements ICollection.SyncRootProperty Value
An object that can be used to synchronize access to the ICollection. In the default implementation of Queue<T>, this property always returns the current instance.
Implements
Remarks
Default implementations of collections in System.Collections.Generic are not synchronized.
Enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization.
SyncRoot returns an object, which can be used to synchronize access to the ICollection. Synchronization is effective only if all threads lock this object before accessing the collection. The following code shows the use of the SyncRoot property for C#, C++, and Visual Basic.
ICollection ic = ...;
lock (ic.SyncRoot) {
// Access the collection.
}
Dim ic As ICollection = ...
SyncLock ic.SyncRoot
' Access the collection.
End SyncLock
ICollection^ ic = ...;
try {
Monitor::Enter(ic->SyncRoot);
// Access the collection.
}
finally {
Monitor::Exit(ic->SyncRoot);
}
Retrieving the value of this property is an O(1) operation.
