ICollection.SyncRoot Właściwość

Definicja

Pobiera obiekt, który może służyć do synchronizowania dostępu do obiektu ICollection.

C#
public object SyncRoot { get; }

Wartość właściwości

Obiekt, który może służyć do synchronizowania dostępu do obiektu ICollection.

Uwagi

W przypadku kolekcji, których bazowy magazyn nie jest publicznie dostępny, oczekiwana implementacja zwraca bieżące wystąpienie. Należy pamiętać, że wskaźnik do bieżącego wystąpienia może nie być wystarczający dla kolekcji, które opakowują inne kolekcje; te powinny zwracać właściwość kolekcji bazowej SyncRoot .

Większość klas kolekcji w System.Collections przestrzeni nazw implementuje również metodę Synchronized , która zapewnia zsynchronizowaną otokę wokół bazowej kolekcji. Klasy pochodne mogą jednak zapewnić własną zsynchronizowaną wersję kolekcji przy użyciu SyncRoot właściwości . Synchronizowanie kodu musi wykonywać operacje na SyncRoot właściwości kolekcji, a nie bezpośrednio w kolekcji. Gwarantuje to prawidłowe funkcjonowanie kolekcji, które są uzyskiwane z innych obiektów. W szczególności utrzymuje właściwą synchronizację z innymi wątkami, które mogą jednocześnie modyfikować wystąpienie kolekcji.

W przypadku braku Synchronized metody w kolekcji oczekiwane użycie wygląda SyncRoot następująco:

C#
ICollection myCollection = someCollection;
lock(myCollection.SyncRoot)
{
    // Some operation on the collection, which is now thread safe.
}

Wyliczanie w kolekcji nie jest wewnętrznie procedurą odporną na wielowątkowość. Nawet gdy kolekcja jest synchronizowana, inne wątki nadal mogą ją modyfikować. Powoduje to zgłaszanie wyjątku przez moduł wyliczający. Aby zagwarantować bezpieczeństwo wątków podczas wyliczania, można zablokować kolekcję podczas całego procesu wyliczania albo rejestrować wyjątki wynikłe ze zmian wprowadzanych przez inne wątków.

Poniższy przykład kodu pokazuje, jak zablokować kolekcję przy użyciu SyncRoot właściwości podczas całego wyliczenia.

C#
ICollection myCollection = someCollection;
lock(myCollection.SyncRoot)
{
    foreach (object item in myCollection)
    {
        // Insert your code here.
    }
}

Dotyczy

Produkt Wersje
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP 10.0

Zobacz też