ICollection.SyncRoot Свойство

Определение

Пространство имен:

System.Collections

Сборки:

netstandard.dll, System.Runtime.dll

Исходный код:

ICollection.cs

Получает объект, который можно использовать для синхронизации доступа к объекту ICollection.

public:
 property System::Object ^ SyncRoot { System::Object ^ get(); };

public object SyncRoot { get; }

member this.SyncRoot : obj

Public ReadOnly Property SyncRoot As Object

Значение свойства

Object

Объект, который можно использовать для синхронизации доступа к объекту ICollection.

Комментарии

Для коллекций, базовые хранилища которых недоступны для общедоступного доступа, ожидается, что реализация возвращает текущий экземпляр. Обратите внимание, что указатель на текущий экземпляр может быть недостаточно для коллекций, которые упаковывают другие коллекции; они должны возвращать свойство базовой коллекции SyncRoot .

Большинство классов коллекций System.Collections в пространстве имен также реализуют Synchronized метод, который предоставляет синхронизированную оболочку вокруг базовой коллекции. Однако производные классы могут предоставлять собственную синхронизированную версию коллекции с помощью SyncRoot свойства. Синхронизированный код должен выполнять операции со свойством SyncRoot коллекции, а не непосредственно в коллекции. Это обеспечивает правильную работу коллекций, производных от других объектов. В частности, он поддерживает правильную синхронизацию с другими потоками, которые могут одновременно изменять экземпляр коллекции.

При отсутствии Synchronized метода в коллекции ожидаемое использование 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

Перечисление через коллекцию по сути не является потокобезопасной процедурой. Даже если коллекция синхронизирована, другие потоки по-прежнему могут изменять коллекцию, что приводит к возникновению исключения перечислителем. Чтобы гарантировать безопасность потоков во время перечисления, можно заблокировать коллекцию во время всего перечисления или поймать исключения, полученные из изменений, внесенных другими потоками.

В следующем примере кода показано, как заблокировать коллекцию с помощью 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

См. также раздел

• IsSynchronized