ICollection.SyncRoot Propriedade

Definição

Obtém um objeto que pode ser usado para sincronizar o acesso ao 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

Valor da propriedade

Um objeto que pode ser usado para sincronizar o acesso ao ICollection.An object that can be used to synchronize access to the ICollection.

Comentários

Para coleções cujo armazenamento subjacente não está disponível publicamente, a implementação esperada é retornar a instância atual.For collections whose underlying store is not publicly available, the expected implementation is to return the current instance. Observe que o ponteiro para a instância atual pode não ser suficiente para coleções que encapsulam outras coleções; Eles devem retornar a propriedade da SyncRoot coleção subjacente.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.

A maioria das classes de System.Collections coleção no namespace também Synchronized implementa um método, que fornece um wrapper sincronizado em volta da coleção subjacente.Most collection classes in the System.Collections namespace also implement a Synchronized method, which provides a synchronized wrapper around the underlying collection. No entanto, as classes derivadas podem fornecer sua própria versão sincronizada da SyncRoot coleção usando a propriedade.However, derived classes can provide their own synchronized version of the collection using the SyncRoot property. O código de sincronização deve executar operações na SyncRoot propriedade da coleção, não diretamente na coleção.The synchronizing code must perform operations on the SyncRoot property of the collection, not directly on the collection. Isso garante a operação apropriada das coleções que são derivadas de outros objetos.This ensures proper operation of collections that are derived from other objects. Especificamente, ele mantém a sincronização adequada com outros threads que podem estar modificando simultaneamente a instância de coleção.Specifically, it maintains proper synchronization with other threads that might be simultaneously modifying the collection instance.

Na ausência de um Synchronized método em uma coleção, o uso esperado para SyncRoot tem a seguinte aparência: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

A enumeração por meio de uma coleção não é um procedimento thread-safe intrínseco.Enumerating through a collection is intrinsically not a thread-safe procedure. Mesmo quando uma coleção está sincronizada, outros threads ainda podem modificar a coleção, o que faz o enumerador lançar uma exceção.Even when a collection is synchronized, other threads can still modify the collection, which causes the enumerator to throw an exception. Para garantir thread-safe durante a enumeração, é possível bloquear a coleção durante toda a enumeração ou verificar as exceções resultantes das alterações feitas por outros threads.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.

O exemplo de código a seguir mostra como bloquear a coleção usando SyncRoot a propriedade durante toda a enumeração.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

Aplica-se a

Veja também