Queue.Synchronized Method (Queue)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Returns a new Queue that wraps the original queue, and is thread safe.

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

[<HostProtectionAttribute(SecurityAction.LinkDemand, Synchronization = true)>]
static member Synchronized : 
        queue:Queue -> Queue

Parameters

queue
Type: System.Collections.Queue

The Queue to synchronize.

Return Value

Type: System.Collections.Queue

A Queue wrapper that is synchronized (thread safe).

Exception Condition
ArgumentNullException

queue is null.

The wrapper returned by this method locks the queue before an operation is performed so that it is performed in a thread-safe manner.

To guarantee the thread safety of the Queue, all operations must be done through this wrapper only.

Enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads can 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. This method is an O(1) operation.

No code example is currently available or this language may not be supported.

The following example shows how to synchronize a Queue, determine if a Queue is synchronized and use a synchronized Queue.

No code example is currently available or this language may not be supported.

Universal Windows Platform
Available since 10
.NET Framework
Available since 1.1
Return to top
Show: