ICollection.SyncRoot Propiedad

Definición

Obtiene un objeto que se puede usar para sincronizar el acceso a ICollection.

C#
public object SyncRoot { get; }

Valor de propiedad

Un objeto que se puede usar para sincronizar el acceso a la clase ICollection.

Comentarios

Para las colecciones cuyo almacenamiento subyacente no esté disponible públicamente, la implementación esperada tan sólo debe devolver la instancia actual. Tenga en cuenta que es posible que el puntero a la instancia actual no sea suficiente para las colecciones que encapsulan otras colecciones; deben devolver la propiedad de la SyncRoot colección subyacente.

La mayoría de las clases de colección del espacio de nombres System.Collections también implementan un método Synchronized que proporciona un contenedor sincronizado alrededor de la colección subyacente. Sin embargo, las clases derivadas pueden proporcionar su propia versión sincronizada de la colección mediante la propiedad SyncRoot. El código de la sincronización debe realizar las operaciones en la propiedad SyncRoot de la colección, y no directamente en la colección. De este modo, se garantiza el funcionamiento correcto de las colecciones derivadas de otros objetos. En concreto, mantiene la sincronización correcta con otros subprocesos que podrían modificar al mismo tiempo la instancia de la colección.

En ausencia de un Synchronized método en una colección, el uso esperado para SyncRoot tiene el siguiente aspecto:

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

Enumerar una colección no es intrínsecamente un procedimiento seguro para subprocesos. Incluso cuando una colección está sincronizada, otros subprocesos todavía pueden modificarla, lo que hace que el enumerador produzca una excepción. Con el fin de garantizar la seguridad para la ejecución de subprocesos durante la enumeración, se puede bloquear la colección durante toda la enumeración o detectar las excepciones resultantes de los cambios realizados por otros subprocesos.

En el ejemplo de código siguiente se muestra cómo bloquear la colección mediante la SyncRoot propiedad durante toda la enumeración.

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

Se aplica a

Produto Versións
.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

Consulte también