ICollection.SyncRoot Vlastnost

Definice

Obor názvů:

System.Collections

Sestavení:

netstandard.dll, System.Runtime.dll

Zdroj:

ICollection.cs

Získá objekt, který lze použít k synchronizaci přístupu k 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 objektu ICollection.

Poznámky

U kolekcí, jejichž základní úložiště není veřejně dostupné, je očekávaná implementace vrátit aktuální instanci. Všimněte si, že ukazatel na aktuální instanci nemusí být dostatečný pro kolekce, které zabalují jiné kolekce; ty by měly vrátit vlastnost podkladové kolekce SyncRoot .

Většina tříd kolekcí v System.Collections oboru názvů také implementuje metodu Synchronized , která poskytuje synchronizovanou obálku kolem podkladové kolekce. Odvozené třídy však mohou poskytovat vlastní synchronizovanou verzi kolekce pomocí SyncRoot vlastnosti. Synchronizační kód musí provádět operace s SyncRoot vlastností kolekce, nikoli přímo v kolekci. Tím se zajistí správná operace kolekcí odvozených z jiných objektů. Konkrétně udržuje správnou synchronizaci s jinými vlákny, která mohou současně upravovat instanci kolekce.

Při absenci Synchronized metody v kolekci vypadá očekávané využití SyncRoot takto:

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 není vnitřně bezpečným postupem pro přístup z více vláken. I když je kolekce synchronizována, ostatní vlákna mohou stále upravovat kolekci, což způsobí, že enumerátor vyvolá výjimku. Chcete-li zaručit bezpečnost vláken během výčtu, můžete buď uzamknout kolekci během celého výčtu, nebo zachytit výjimky vyplývající z změn provedených jinými vlákny.

Následující příklad kódu ukazuje, jak uzamknout kolekci pomocí SyncRoot vlastnosti během celého výčtu.

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

Viz také

• IsSynchronized