ICollection.SyncRoot Vlastnost

Definice

Získává objekt, který lze použít k synchronizaci přístupu k ICollection .Gets an object that can be used to synchronize access to the ICollection.

public:
 property System::Object ^ SyncRoot { System::Object ^ get(); };
public object SyncRoot { get; }
member this.SyncRoot : obj
Public ReadOnly Property SyncRoot As Object

Hodnota vlastnosti

Object

Objekt, který lze použít k synchronizaci přístupu k ICollection .An object that can be used to synchronize access to the ICollection.

Poznámky

U kolekcí, jejichž základní úložiště není veřejně dostupné, je očekávanou implementací vrácení aktuální instance.For collections whose underlying store is not publicly available, the expected implementation is to return the current instance. Všimněte si, že ukazatel na aktuální instanci nemusí být dostatečný pro kolekce, které zabalí jiné kolekce. Ty by měly vracet základní vlastnost kolekce SyncRoot .Note that the pointer to the current instance might not be sufficient for collections that wrap other collections; those should return the underlying collection's SyncRoot property.

Většina tříd kolekcí v System.Collections oboru názvů také implementuje Synchronized metodu, která poskytuje synchronizovanou obálku kolem základní kolekce.Most collection classes in the System.Collections namespace also implement a Synchronized method, which provides a synchronized wrapper around the underlying collection. Odvozené třídy však mohou poskytnout svou vlastní synchronizovanou verzi kolekce pomocí SyncRoot Vlastnosti.However, derived classes can provide their own synchronized version of the collection using the SyncRoot property. Synchronizační kód musí provádět operace s SyncRoot vlastností kolekce, nikoli přímo na kolekci.The synchronizing code must perform operations on the SyncRoot property of the collection, not directly on the collection. Tím zajistíte správnou funkci kolekcí, které jsou odvozeny z jiných objektů.This ensures proper operation of collections that are derived from other objects. Konkrétně udržuje správnou synchronizaci s dalšími vlákny, které mohou současně upravovat instanci kolekce.Specifically, it maintains proper synchronization with other threads that might be simultaneously modifying the collection instance.

V případě absence Synchronized metody v kolekci je očekávané použití pro SyncRoot vypadá takto:In the absence of a Synchronized method on a collection, the expected usage for SyncRoot looks as follows:

ICollection^ myCollection = someCollection;
bool lockTaken = false;
try
{
    Monitor::Enter(myCollection->SyncRoot, lockTaken);
    // Some operation on the collection, which is now thread safe.
}
finally
{
    if (lockTaken)
    {
        Monitor::Exit(myCollection->SyncRoot);
    }
}
ICollection myCollection = someCollection;
lock(myCollection.SyncRoot)
{
    // Some operation on the collection, which is now thread safe.
}
Dim myCollection As ICollection = someCollection
SyncLock myCollection.SyncRoot
    ' Some operation on the collection, which is now thread safe.
End SyncLock

Výčet prostřednictvím kolekce nemůže být procedurou bezpečnou pro přístup z více vláken.Enumerating through a collection is intrinsically not a thread-safe procedure. I v případě, že jde o synchronizovanou kolekci, mohou úpravy provádět i ostatní vlákna, což způsobuje vyvolání výjimky enumerátorem.Even when a collection is synchronized, other threads can still modify the collection, which causes the enumerator to throw an exception. K zaručení bezpečnosti přístupu z více vláken můžete buďto zamknout kolekci na celou dobu práce s výčtem, nebo zachycovat výjimky vzniklé v důsledku změn prováděných ostatními vlákny.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.

Následující příklad kódu ukazuje, jak uzamknout kolekci pomocí SyncRoot vlastnosti během celého výčtu.The following code example shows how to lock the collection using the SyncRoot property during the entire enumeration.

ICollection^ myCollection = someCollection;
bool lockTaken = false;
try
{
    Monitor::Enter(myCollection->SyncRoot, lockTaken);
    for each (Object^ item in myCollection);
    {
        // Insert your code here.
    }
}
finally
{
    if (lockTaken)
    {
        Monitor::Exit(myCollection->SyncRoot);
    }
}
ICollection myCollection = someCollection;
lock(myCollection.SyncRoot)
{
    foreach (object item in myCollection)
    {
        // Insert your code here.
    }
}
Dim myCollection As ICollection = someCollection
SyncLock myCollection.SyncRoot
    For Each item In myCollection
        ' Insert your code here.
    Next item
End SyncLock

Platí pro

Viz také