ICollection.SyncRoot プロパティとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

ICollection.SyncRoot プロパティ

ICollection へのアクセスを同期するために使用できるオブジェクトを取得します。

名前空間: System.Collections
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

ReadOnly Property SyncRoot As
 Object

Visual Basic (使用法)

Dim instance As ICollection
Dim value As Object

value = instance.SyncRoot

Object SyncRoot { get; }

C++

property Object^ SyncRoot {
    Object^ get ();
}

/** @property */
Object get_SyncRoot ()

JScript

function get SyncRoot () : Object

プロパティ値
ICollection へのアクセスを同期するために使用できるオブジェクト。

解説

基になっているストアがパブリックではないコレクションの場合、現在のインスタンスを返す実装が要求されます。ただし、他のコレクションをラップするコレクションの場合、現在のインスタンスへのポインタを返すのでは不十分なことがあります。このようなコレクションは、基になっているコレクションの SyncRoot プロパティを返す必要があります。

System.Collections 名前空間内のほとんどのコレクションクラスは、Synchronized メソッドも実装しています。このメソッドは、基になるコレクションをラップする同期されたラッパーを提供します。ただし、派生クラスでは、SyncRoot プロパティを使用して、独自にコレクションを同期させることができます。コードによる同期操作は、コレクションで直接実行するのではなく、コレクションの SyncRoot プロパティで実行する必要があります。これにより、他のオブジェクトから派生したコレクションの操作が正常に実行されます。特に、コレクションインスタンスを同時に変更する可能性がある別スレッドとの間で、正常な同期を維持します。

コレクションが Synchronized メソッドを実装していない場合は、SyncRoot を次のように使用します。

ICollection MyCollection =...
 lock(MyCollection.SyncRoot) {
  // Some operation on the collection, which is now thread safe.
 }

Visual Basic

Dim myCollection as New
 ICollection()
 SyncLock myCollection.SyncRoot
  ' Some operation on the collection, which is now thread safe.
 End SyncLock

コレクションの列挙処理は、本質的にはスレッドセーフな処理ではありません。コレクションが同期されている場合でも、他のスレッドがそのコレクションを変更する可能性はあり、そのような状況が発生すると列挙子は例外をスローします。列挙処理を確実にスレッドセーフに行うには、列挙中にコレクションをロックするか、他のスレッドによって行われた変更によってスローされる例外をキャッチします。

列挙処理中に SyncRoot プロパティを使用してコレクションをロックする方法を次のコード例に示します。

ICollection myCollection = new ICollection();
 lock(myCollection.SyncRoot) {
  foreach (Object item in myCollection) {
  // Insert your code here.
  }
 }

Visual Basic

Dim myCollection As New
 ICollection()
 Dim item As Object
 SyncLock myCollection.SyncRoot
  For Each item In myCollection
  ' Insert your code here.
  Next item
 End SyncLock