Queue.SyncRoot プロパティ

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

Queue.SyncRoot プロパティ

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

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

Visual Basic (宣言)

Public Overridable ReadOnly
 Property SyncRoot As Object

Visual Basic (使用法)

Dim instance As Queue
Dim value As Object

value = instance.SyncRoot

C#

public virtual Object SyncRoot { get; }

C++

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

J#

/** @property */
public Object get_SyncRoot ()

JScript

public function get SyncRoot
 () : Object

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

解説

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

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

使用例

列挙処理中に SyncRoot を使用してコレクションをロックする方法を次のコード例に示します。このプロパティ値を取得することは、O(1) 操作になります。

C#

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

Visual Basic

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

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
Queue クラス
Queue メンバ
System.Collections 名前空間
Queue.IsSynchronized プロパティ
Synchronized