ICollection.SyncRoot Właściwość

Definicja

Pobiera obiekt, który może służyć do synchronizowania dostępu do 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

Wartość właściwości

Obiekt, który może służyć do synchronizowania dostępu do ICollection.An object that can be used to synchronize access to the ICollection.

Uwagi

W przypadku kolekcji, których magazyn podstawowy nie jest dostępny publicznie, oczekiwana implementacja ma zwrócić bieżące wystąpienie.For collections whose underlying store is not publicly available, the expected implementation is to return the current instance. Należy zauważyć, że wskaźnik do bieżącego wystąpienia może być niewystarczający dla kolekcji, które zawijają inne kolekcje; powinny one zwracać SyncRoot Właściwość źródłowej kolekcji.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.

Większość klas kolekcji w System.Collections przestrzeni nazw Synchronized implementuje również metodę, która zapewnia zsynchronizowaną otokę wokół źródłowej kolekcji.Most collection classes in the System.Collections namespace also implement a Synchronized method, which provides a synchronized wrapper around the underlying collection. Jednak klasy pochodne mogą udostępniać własne zsynchronizowane wersje kolekcji przy użyciu SyncRoot właściwości.However, derived classes can provide their own synchronized version of the collection using the SyncRoot property. Kod synchronizacji musi wykonywać operacje na SyncRoot właściwości kolekcji, nie bezpośrednio w kolekcji.The synchronizing code must perform operations on the SyncRoot property of the collection, not directly on the collection. Gwarantuje to prawidłowe funkcjonowanie kolekcji, które są uzyskiwane z innych obiektów.This ensures proper operation of collections that are derived from other objects. W celu zapewnienia prawidłowej synchronizacji z innymi wątkami, które mogą jednocześnie modyfikować wystąpienie kolekcji.Specifically, it maintains proper synchronization with other threads that might be simultaneously modifying the collection instance.

W przypadku braku Synchronized metody w kolekcji oczekiwane SyncRoot użycie wygląda następująco: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

Wyliczanie w kolekcji nie jest wewnętrznie procedurą odporną na wielowątkowość.Enumerating through a collection is intrinsically not a thread-safe procedure. Nawet gdy kolekcja jest synchronizowana, inne wątki nadal mogą ją modyfikować. Powoduje to zgłaszanie wyjątku przez moduł wyliczający.Even when a collection is synchronized, other threads can still modify the collection, which causes the enumerator to throw an exception. 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.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.

Poniższy przykład kodu pokazuje, jak zablokować kolekcję przy użyciu SyncRoot właściwości podczas całego wyliczania.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

Dotyczy

Zobacz też