Export (0) Print
Expand All

Queue<T>.ICollection.SyncRoot Property

Gets an object that can be used to synchronize access to the ICollection.

Namespace:  System.Collections.Generic
Assembly:  System (in System.dll)

Object ICollection.SyncRoot { get; }

Property Value

Type: System.Object
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

ICollection.SyncRoot

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.
}

Retrieving the value of this property is an O(1) operation.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Community Additions

ADD
Show:
© 2014 Microsoft