Interlocked.CompareExchange 方法

定義

命名空間:

System.Threading

組件:

System.Threading.dll

比較兩個值是否相等，如果相等，則取代第一個值。

多載

CompareExchange(UIntPtr, UIntPtr, UIntPtr)	比較兩個平台特定的控制代碼或指標是否相等；如果相等，則取代第一個。
CompareExchange(UInt64, UInt64, UInt64)	比較兩個 64 位元不帶正負號的整數是否相等，如果相等，則取代第一個值。
CompareExchange(UInt32, UInt32, UInt32)	比較兩個 32 位元不帶正負號的整數是否相等，如果相等，則取代第一個值。
CompareExchange(Single, Single, Single)	比較兩個單精確度浮點數是否相等；如果相等，則取代第一個值。
CompareExchange(Object, Object, Object)	比較兩個物件的參考是否相等；如果相等，則取代第一個物件。
CompareExchange(Int64, Int64, Int64)	比較兩個 64 位元帶正負號的整數是否相等，如果相等，則取代第一個值。
CompareExchange(Int32, Int32, Int32)	比較兩個 32 位元帶正負號的整數是否相等，如果相等，則取代第一個值。
CompareExchange(Double, Double, Double)	比較兩個雙精確度浮點數是否相等；如果相等，則取代第一個值。
CompareExchange(IntPtr, IntPtr, IntPtr)	比較兩個平台特定的控制代碼或指標是否相等；如果相等，則取代第一個。
CompareExchange<T>(T, T, T)	比較指定參考型別 T 的兩個執行個體是否參考相等；如果相等，則取代第一個。

CompareExchange(UIntPtr, UIntPtr, UIntPtr)

Source:

Interlocked.cs

重要

此 API 不符合 CLS 規範。

比較兩個平台特定的控制代碼或指標是否相等；如果相等，則取代第一個。

public:
 static UIntPtr CompareExchange(UIntPtr % location1, UIntPtr value, UIntPtr comparand);

[System.CLSCompliant(false)]
public static UIntPtr CompareExchange (ref UIntPtr location1, UIntPtr value, UIntPtr comparand);

[<System.CLSCompliant(false)>]
static member CompareExchange : unativeint * unativeint * unativeint -> unativeint

Public Shared Function CompareExchange (ByRef location1 As UIntPtr, value As UIntPtr, comparand As UIntPtr) As UIntPtr

參數

location1

UIntPtr

unativeint

UIntPtr 目的端，其值會與 comparand 的值進行比較，且可能被 value 所取代。

value

UIntPtr

unativeint

UIntPtr，當比較的結果相等時會取代目的端值。

comparand

UIntPtr

unativeint

UIntPtr，會與 location1 的值相比較。

傳回

UIntPtr

unativeint

location1 中的原始值。

屬性

CLSCompliantAttribute

例外狀況

NullReferenceException

location1 的位址為 null 指標。

CompareExchange(UInt64, UInt64, UInt64)

Source:

Interlocked.cs

重要

此 API 不符合 CLS 規範。

比較兩個 64 位元不帶正負號的整數是否相等，如果相等，則取代第一個值。

public:
 static System::UInt64 CompareExchange(System::UInt64 % location1, System::UInt64 value, System::UInt64 comparand);

[System.CLSCompliant(false)]
public static ulong CompareExchange (ref ulong location1, ulong value, ulong comparand);

[<System.CLSCompliant(false)>]
static member CompareExchange : uint64 * uint64 * uint64 -> uint64

Public Shared Function CompareExchange (ByRef location1 As ULong, value As ULong, comparand As ULong) As ULong

參數

location1

UInt64

目的端，其值會與 comparand 進行比較且可能會被取代。

value

UInt64

當比較的結果相等時，會取代目的端值的值。

comparand

UInt64

與 location1 的值比較的值。

傳回

UInt64

location1 中的原始值。

屬性

CLSCompliantAttribute

例外狀況

NullReferenceException

location1 的位址為 null 指標。

CompareExchange(UInt32, UInt32, UInt32)

Source:

Interlocked.cs

重要

此 API 不符合 CLS 規範。

比較兩個 32 位元不帶正負號的整數是否相等，如果相等，則取代第一個值。

public:
 static System::UInt32 CompareExchange(System::UInt32 % location1, System::UInt32 value, System::UInt32 comparand);

[System.CLSCompliant(false)]
public static uint CompareExchange (ref uint location1, uint value, uint comparand);

[<System.CLSCompliant(false)>]
static member CompareExchange : uint32 * uint32 * uint32 -> uint32

Public Shared Function CompareExchange (ByRef location1 As UInteger, value As UInteger, comparand As UInteger) As UInteger

參數

location1

UInt32

目的端，其值會與 comparand 進行比較且可能會被取代。

value

UInt32

當比較的結果相等時，會取代目的端值的值。

comparand

UInt32

與 location1 的值比較的值。

傳回

UInt32

location1 中的原始值。

屬性

CLSCompliantAttribute

例外狀況

NullReferenceException

location1 的位址為 null 指標。

CompareExchange(Single, Single, Single)

Source:

Interlocked.cs

比較兩個單精確度浮點數是否相等；如果相等，則取代第一個值。

public:
 static float CompareExchange(float % location1, float value, float comparand);

public static float CompareExchange (ref float location1, float value, float comparand);

static member CompareExchange : single * single * single -> single

Public Shared Function CompareExchange (ByRef location1 As Single, value As Single, comparand As Single) As Single

參數

location1

Single

目的端，其值會與 comparand 進行比較且可能會被取代。

value

Single

當比較的結果相等時，會取代目的端值的值。

comparand

Single

與 location1 的值比較的值。

傳回

Single

location1 中的原始值。

例外狀況

NullReferenceException

location1 的位址為 null 指標。

範例

下列程式代碼範例示範可累積執行中總 Single 值的線程安全方法。 兩個線程會使用安全線程方法和一般加法新增一系列 Single 值，以及比較線程完成總計時。 在雙處理器計算機上，總計有顯著的差異。

在安全線程方法中，會儲存執行總計的初始值，然後使用 CompareExchange 方法來交換新計算的總計與舊總計。 如果傳回值不等於執行總計的已儲存值，則另一個線程已同時更新總計。 在此情況下，必須重複嘗試更新執行總計。

// This example demonstrates a thread-safe method that adds to a
// running total.  
using System;
using System.Threading;

public class ThreadSafe
{
    // Field totalValue contains a running total that can be updated
    // by multiple threads. It must be protected from unsynchronized 
    // access.
    private float totalValue = 0.0F;

    // The Total property returns the running total.
    public float Total { get { return totalValue; }}

    // AddToTotal safely adds a value to the running total.
    public float AddToTotal(float addend)
    {
        float initialValue, computedValue;
        do
        {
            // Save the current running total in a local variable.
            initialValue = totalValue;

            // Add the new value to the running total.
            computedValue = initialValue + addend;

            // CompareExchange compares totalValue to initialValue. If
            // they are not equal, then another thread has updated the
            // running total since this loop started. CompareExchange
            // does not update totalValue. CompareExchange returns the
            // contents of totalValue, which do not equal initialValue,
            // so the loop executes again.
        }
        while (initialValue != Interlocked.CompareExchange(ref totalValue, 
            computedValue, initialValue));
        // If no other thread updated the running total, then 
        // totalValue and initialValue are equal when CompareExchange
        // compares them, and computedValue is stored in totalValue.
        // CompareExchange returns the value that was in totalValue
        // before the update, which is equal to initialValue, so the 
        // loop ends.

        // The function returns computedValue, not totalValue, because
        // totalValue could be changed by another thread between
        // the time the loop ends and the function returns.
        return computedValue;
    }
}

public class Test
{
    // Create an instance of the ThreadSafe class to test.
    private static ThreadSafe ts = new ThreadSafe();
    private static float control;

    private static Random r = new Random();
    private static ManualResetEvent mre = new ManualResetEvent(false);

    public static void Main()
    {
        // Create two threads, name them, and start them. The
        // thread will block on mre.
        Thread t1 = new Thread(TestThread);
        t1.Name = "Thread 1";
        t1.Start();
        Thread t2 = new Thread(TestThread);
        t2.Name = "Thread 2";
        t2.Start();

        // Now let the threads begin adding random numbers to 
        // the total.
        mre.Set();
        
        // Wait until all the threads are done.
        t1.Join();
        t2.Join();

        Console.WriteLine("Thread safe: {0}  Ordinary float: {1}", 
            ts.Total, control);
    }

    private static void TestThread()
    {
        // Wait until the signal.
        mre.WaitOne();

        for(int i = 1; i <= 1000000; i++)
        {
            // Add to the running total in the ThreadSafe instance, and
            // to an ordinary float.
            //
            float testValue = (float) r.NextDouble();
            control += testValue;
            ts.AddToTotal(testValue);
        }
    }
}

/* On a dual-processor computer, this code example produces output 
   similar to the following:

Thread safe: 17039.57  Ordinary float: 15706.44
 */

' This example demonstrates a thread-safe method that adds to a
' running total.  
Imports System.Threading

Public Class ThreadSafe
    ' Field totalValue contains a running total that can be updated
    ' by multiple threads. It must be protected from unsynchronized 
    ' access.
    Private totalValue As Single = 0.0

    ' The Total property returns the running total.
    Public ReadOnly Property Total As Single
        Get
            Return totalValue
        End Get
    End Property

    ' AddToTotal safely adds a value to the running total.
    Public Function AddToTotal(ByVal addend As Single) As Single
        Dim initialValue, computedValue As Single
        Do
            ' Save the current running total in a local variable.
            initialValue = totalValue

            ' Add the new value to the running total.
            computedValue = initialValue + addend

            ' CompareExchange compares totalValue to initialValue. If
            ' they are not equal, then another thread has updated the
            ' running total since this loop started. CompareExchange
            ' does not update totalValue. CompareExchange returns the
            ' contents of totalValue, which do not equal initialValue,
            ' so the loop executes again.
        Loop While initialValue <> Interlocked.CompareExchange( _
            totalValue, computedValue, initialValue)
        ' If no other thread updated the running total, then 
        ' totalValue and initialValue are equal when CompareExchange
        ' compares them, and computedValue is stored in totalValue.
        ' CompareExchange returns the value that was in totalValue
        ' before the update, which is equal to initialValue, so the 
        ' loop ends.

        ' The function returns computedValue, not totalValue, because
        ' totalValue could be changed by another thread between
        ' the time the loop ends and the function returns.
        Return computedValue
    End Function
End Class

Public Class Test
    ' Create an instance of the ThreadSafe class to test.
    Private Shared ts As New ThreadSafe()
    Private Shared control As Single

    Private Shared r As New Random()
    Private Shared mre As New ManualResetEvent(false)

    <MTAThread> _
    Public Shared Sub Main()
        ' Create two threads, name them, and start them. The
        ' threads will block on mre.
        Dim t1 As New Thread(AddressOf TestThread)
        t1.Name = "Thread 1"
        t1.Start()
        Dim t2 As New Thread(AddressOf TestThread)
        t2.Name = "Thread 2"
        t2.Start()

        ' Now let the threads begin adding random numbers to 
        ' the total.
        mre.Set()
        
        ' Wait until all the threads are done.
        t1.Join()
        t2.Join()

        Console.WriteLine("Thread safe: {0}  Ordinary Single: {1}", ts.Total, control)
    End Sub

    Private Shared Sub TestThread()
        ' Wait until the signal.
        mre.WaitOne()

        For i As Integer = 1 to 1000000
            ' Add to the running total in the ThreadSafe instance, and
            ' to an ordinary Single.
            '
            Dim testValue As Single = r.NextDouble()
            control += testValue
            ts.AddToTotal(testValue)
        Next
    End Sub
End Class

' On a dual-processor computer, this code example produces output 
' similar to the following:
'
'Thread safe: 17039.57  Ordinary Single: 15706.44

備註

如果 comparand 和中的 location1 值相等，則會 value 儲存在 中 location1。 否則，不會執行任何作業。 比較和交換作業會以不可部分完成的作業的形式執行。 的傳回值是 中的location1原始值CompareExchange，不論交換是否發生。

另請參閱

• Managed 執行緒處理
• 同步處理原始物件概觀

CompareExchange(Object, Object, Object)

Source:

Interlocked.cs

比較兩個物件的參考是否相等；如果相等，則取代第一個物件。

public:
 static System::Object ^ CompareExchange(System::Object ^ % location1, System::Object ^ value, System::Object ^ comparand);

public static object? CompareExchange (ref object? location1, object? value, object? comparand);

static member CompareExchange : obj * obj * obj -> obj

Public Shared Function CompareExchange (ByRef location1 As Object, value As Object, comparand As Object) As Object

參數

location1

Object

以傳址方式與 comparand 比較的目的地物件，且可能被取代。

value

Object

若參考比較結果相等，此物件會取代目的地物件。

comparand

Object

以傳址方式與位於location1 之物件比較的物件。

傳回

Object

location1 中的原始值。

例外狀況

NullReferenceException

location1 的位址為 null 指標。

備註

重要

從 .NET Framework 2.0 開始，CompareExchange<T>(T, T, T) 方法多載會為參考型別提供型別安全的替代方法。 建議您呼叫它，而不是這個多載。

如果 comparand 和 中的 location1 物件相等，則 value 會儲存在 中 location1。 否則，不會執行任何作業。 比較和交換作業會以不可部分完成的作業的形式執行。 的傳回值是 中的location1原始值CompareExchange，不論交換是否發生。

注意

對象會比較參考相等，而不是值相等。 因此，相同實值類型的兩個boxed實例 (例如，整數3) 一律顯示為不相等，而且不會執行任何作業。 請勿將此多載與實值型別搭配使用。

另請參閱

• Managed 執行緒處理
• 同步處理原始物件概觀

CompareExchange(Int64, Int64, Int64)

Source:

Interlocked.cs

比較兩個 64 位元帶正負號的整數是否相等，如果相等，則取代第一個值。

public:
 static long CompareExchange(long % location1, long value, long comparand);

public static long CompareExchange (ref long location1, long value, long comparand);

static member CompareExchange : int64 * int64 * int64 -> int64

Public Shared Function CompareExchange (ByRef location1 As Long, value As Long, comparand As Long) As Long

參數

location1

Int64

目的端，其值會與 comparand 進行比較且可能會被取代。

value

Int64

當比較的結果相等時，會取代目的端值的值。

comparand

Int64

與 location1 的值比較的值。

傳回

Int64

location1 中的原始值。

例外狀況

NullReferenceException

location1 的位址為 null 指標。

備註

如果 comparand 和中的 location1 值相等，則會 value 儲存在 中 location1。 否則，不會執行任何作業。 比較和交換作業會以不可部分完成的作業的形式執行。 的傳回值是 中的location1原始值CompareExchange，不論交換是否發生。

另請參閱

• Managed 執行緒處理
• 同步處理原始物件概觀

CompareExchange(Int32, Int32, Int32)

Source:

Interlocked.cs

比較兩個 32 位元帶正負號的整數是否相等，如果相等，則取代第一個值。

public:
 static int CompareExchange(int % location1, int value, int comparand);

public static int CompareExchange (ref int location1, int value, int comparand);

static member CompareExchange : int * int * int -> int

Public Shared Function CompareExchange (ByRef location1 As Integer, value As Integer, comparand As Integer) As Integer

參數

location1

Int32

目的端，其值會與 comparand 進行比較且可能會被取代。

value

Int32

當比較的結果相等時，會取代目的端值的值。

comparand

Int32

與 location1 的值比較的值。

傳回

Int32

location1 中的原始值。

例外狀況

NullReferenceException

location1 的位址為 null 指標。

範例

下列程式代碼範例示範可累積執行總計的線程安全方法。 會儲存執行總計的初始值，然後使用 CompareExchange 方法，將新計算的總計與舊總計交換。 如果傳回值不等於執行總計的已儲存值，則另一個線程已同時更新總計。 在此情況下，必須重複嘗試更新執行總計。

注意

在 Add .NET Framework 2.0 版中引進的方法，提供更方便的方式來累積整數的線程安全執行總計。

// This example demonstrates a thread-safe method that adds to a
// running total.  It cannot be run directly.  You can compile it
// as a library, or add the class to a project.
#using <system.dll>

using namespace System::Threading;
public ref class ThreadSafe
{
private:

   // totalValue contains a running total that can be updated
   // by multiple threads. It must be protected from unsynchronized 
   // access.
   int totalValue;

public:

   property int Total 
   {

      // The Total property returns the running total.
      int get()
      {
         return totalValue;
      }

   }

   // AddToTotal safely adds a value to the running total.
   int AddToTotal( int addend )
   {
      int initialValue;
      int computedValue;
      do
      {
         
         // Save the current running total in a local variable.
         initialValue = totalValue;
         
         // Add the new value to the running total.
         computedValue = initialValue + addend;
         
         // CompareExchange compares totalValue to initialValue. If
         // they are not equal, then another thread has updated the
         // running total since this loop started. CompareExchange
         // does not update totalValue. CompareExchange returns the
         // contents of totalValue, which do not equal initialValue,
         // so the loop executes again.
      }
      while ( initialValue != Interlocked::CompareExchange( totalValue, computedValue, initialValue ) );

      
      // If no other thread updated the running total, then 
      // totalValue and initialValue are equal when CompareExchange
      // compares them, and computedValue is stored in totalValue.
      // CompareExchange returns the value that was in totalValue
      // before the update, which is equal to initialValue, so the 
      // loop ends.
      // The function returns computedValue, not totalValue, because
      // totalValue could be changed by another thread between
      // the time the loop ends and the function returns.
      return computedValue;
   }

};

// This example demonstrates a thread-safe method that adds to a
// running total.  It cannot be run directly.  You can compile it
// as a library, or add the class to a project.
using System.Threading;

public class ThreadSafe {
    // totalValue contains a running total that can be updated
    // by multiple threads. It must be protected from unsynchronized 
    // access.
    private int totalValue = 0;

    // The Total property returns the running total.
    public int Total {
        get { return totalValue; }
    }

    // AddToTotal safely adds a value to the running total.
    public int AddToTotal(int addend) {
        int initialValue, computedValue;
        do {
            // Save the current running total in a local variable.
            initialValue = totalValue;

            // Add the new value to the running total.
            computedValue = initialValue + addend;

            // CompareExchange compares totalValue to initialValue. If
            // they are not equal, then another thread has updated the
            // running total since this loop started. CompareExchange
            // does not update totalValue. CompareExchange returns the
            // contents of totalValue, which do not equal initialValue,
            // so the loop executes again.
        } while (initialValue != Interlocked.CompareExchange(
            ref totalValue, computedValue, initialValue));
        // If no other thread updated the running total, then 
        // totalValue and initialValue are equal when CompareExchange
        // compares them, and computedValue is stored in totalValue.
        // CompareExchange returns the value that was in totalValue
        // before the update, which is equal to initialValue, so the 
        // loop ends.

        // The function returns computedValue, not totalValue, because
        // totalValue could be changed by another thread between
        // the time the loop ends and the function returns.
        return computedValue;
    }
}

' This example demonstrates a thread-safe method that adds to a
' running total.  It cannot be run directly.  You can compile it
' as a library, or add the class to a project.
Imports System.Threading

Public Class ThreadSafe
    ' Field totalValue contains a running total that can be updated
    ' by multiple threads. It must be protected from unsynchronized 
    ' access.
    Private totalValue As Integer = 0

    ' The Total property returns the running total.
    Public ReadOnly Property Total As Integer
        Get
            Return totalValue
        End Get
    End Property

    ' AddToTotal safely adds a value to the running total.
    Public Function AddToTotal(ByVal addend As Integer) As Integer
        Dim initialValue, computedValue As Integer
        Do
            ' Save the current running total in a local variable.
            initialValue = totalValue

            ' Add the new value to the running total.
            computedValue = initialValue + addend

            ' CompareExchange compares totalValue to initialValue. If
            ' they are not equal, then another thread has updated the
            ' running total since this loop started. CompareExchange
            ' does not update totalValue. CompareExchange returns the
            ' contents of totalValue, which do not equal initialValue,
            ' so the loop executes again.
        Loop While initialValue <> Interlocked.CompareExchange( _
            totalValue, computedValue, initialValue)
        ' If no other thread updated the running total, then 
        ' totalValue and initialValue are equal when CompareExchange
        ' compares them, and computedValue is stored in totalValue.
        ' CompareExchange returns the value that was in totalValue
        ' before the update, which is equal to initialValue, so the 
        ' loop ends.

        ' The function returns computedValue, not totalValue, because
        ' totalValue could be changed by another thread between
        ' the time the loop ends and the function returns.
        Return computedValue
    End Function
End Class

備註

如果 comparand 和中的 location1 值相等，則會 value 儲存在 中 location1。 否則，不會執行任何作業。 比較和交換作業會以不可部分完成的作業執行。 的傳回值 CompareExchange 是 中的 location1原始值，不論交換是否發生。

另請參閱

• Managed 執行緒處理
• 同步處理原始物件概觀

CompareExchange(Double, Double, Double)

Source:

Interlocked.cs

比較兩個雙精確度浮點數是否相等；如果相等，則取代第一個值。

public:
 static double CompareExchange(double % location1, double value, double comparand);

public static double CompareExchange (ref double location1, double value, double comparand);

static member CompareExchange : double * double * double -> double

Public Shared Function CompareExchange (ByRef location1 As Double, value As Double, comparand As Double) As Double

參數

location1

Double

目的端，其值會與 comparand 進行比較且可能會被取代。

value

Double

當比較的結果相等時，會取代目的端值的值。

comparand

Double

與 location1 的值比較的值。

傳回

Double

location1 中的原始值。

例外狀況

NullReferenceException

location1 的位址為 null 指標。

範例

下列程式代碼範例示範可累積執行中值總計的 Double 線程安全方法。 兩個線程會使用安全線程方法和一般加法，以及當線程完成總計時，新增一系列 Double 的值。 在雙處理器計算機上，總計有顯著差異。

在安全線程方法中，會儲存執行總計的初始值，然後使用 CompareExchange 方法來交換新計算的總計與舊總計。 如果傳回值不等於執行總計的儲存值，則另一個線程同時更新總計。 在此情況下，必須重複嘗試更新執行總計。

// This example demonstrates a thread-safe method that adds to a
// running total.  
using System;
using System.Threading;

public class ThreadSafe
{
    // Field totalValue contains a running total that can be updated
    // by multiple threads. It must be protected from unsynchronized 
    // access.
    private double totalValue = 0.0;

    // The Total property returns the running total.
    public double Total { get { return totalValue; }}

    // AddToTotal safely adds a value to the running total.
    public double AddToTotal(double addend)
    {
        double initialValue, computedValue;
        do
        {
            // Save the current running total in a local variable.
            initialValue = totalValue;

            // Add the new value to the running total.
            computedValue = initialValue + addend;

            // CompareExchange compares totalValue to initialValue. If
            // they are not equal, then another thread has updated the
            // running total since this loop started. CompareExchange
            // does not update totalValue. CompareExchange returns the
            // contents of totalValue, which do not equal initialValue,
            // so the loop executes again.
        }
        while (initialValue != Interlocked.CompareExchange(ref totalValue, 
            computedValue, initialValue));
        // If no other thread updated the running total, then 
        // totalValue and initialValue are equal when CompareExchange
        // compares them, and computedValue is stored in totalValue.
        // CompareExchange returns the value that was in totalValue
        // before the update, which is equal to initialValue, so the 
        // loop ends.

        // The function returns computedValue, not totalValue, because
        // totalValue could be changed by another thread between
        // the time the loop ends and the function returns.
        return computedValue;
    }
}

public class Test
{
    // Create an instance of the ThreadSafe class to test.
    private static ThreadSafe ts = new ThreadSafe();
    private static double control;

    private static Random r = new Random();
    private static ManualResetEvent mre = new ManualResetEvent(false);

    public static void Main()
    {
        // Create two threads, name them, and start them. The
        // thread will block on mre.
        Thread t1 = new Thread(TestThread);
        t1.Name = "Thread 1";
        t1.Start();
        Thread t2 = new Thread(TestThread);
        t2.Name = "Thread 2";
        t2.Start();

        // Now let the threads begin adding random numbers to 
        // the total.
        mre.Set();
        
        // Wait until all the threads are done.
        t1.Join();
        t2.Join();

        Console.WriteLine("Thread safe: {0}  Ordinary Double: {1}", 
            ts.Total, control);
    }

    private static void TestThread()
    {
        // Wait until the signal.
        mre.WaitOne();

        for(int i = 1; i <= 1000000; i++)
        {
            // Add to the running total in the ThreadSafe instance, and
            // to an ordinary double.
            //
            double testValue = r.NextDouble();
            control += testValue;
            ts.AddToTotal(testValue);
        }
    }
}

/* On a dual-processor computer, this code example produces output 
   similar to the following:

Thread safe: 998068.049623744  Ordinary Double: 759775.417190589
 */

' This example demonstrates a thread-safe method that adds to a
' running total.  
Imports System.Threading

Public Class ThreadSafe
    ' Field totalValue contains a running total that can be updated
    ' by multiple threads. It must be protected from unsynchronized 
    ' access.
    Private totalValue As Double = 0.0

    ' The Total property returns the running total.
    Public ReadOnly Property Total As Double
        Get
            Return totalValue
        End Get
    End Property

    ' AddToTotal safely adds a value to the running total.
    Public Function AddToTotal(ByVal addend As Double) As Double
        Dim initialValue, computedValue As Double
        Do
            ' Save the current running total in a local variable.
            initialValue = totalValue

            ' Add the new value to the running total.
            computedValue = initialValue + addend

            ' CompareExchange compares totalValue to initialValue. If
            ' they are not equal, then another thread has updated the
            ' running total since this loop started. CompareExchange
            ' does not update totalValue. CompareExchange returns the
            ' contents of totalValue, which do not equal initialValue,
            ' so the loop executes again.
        Loop While initialValue <> Interlocked.CompareExchange( _
            totalValue, computedValue, initialValue)
        ' If no other thread updated the running total, then 
        ' totalValue and initialValue are equal when CompareExchange
        ' compares them, and computedValue is stored in totalValue.
        ' CompareExchange returns the value that was in totalValue
        ' before the update, which is equal to initialValue, so the 
        ' loop ends.

        ' The function returns computedValue, not totalValue, because
        ' totalValue could be changed by another thread between
        ' the time the loop ends and the function returns.
        Return computedValue
    End Function
End Class

Public Class Test
    ' Create an instance of the ThreadSafe class to test.
    Private Shared ts As New ThreadSafe()
    Private Shared control As Double

    Private Shared r As New Random()
    Private Shared mre As New ManualResetEvent(false)

    <MTAThread> _
    Public Shared Sub Main()
        ' Create two threads, name them, and start them. The
        ' threads will block on mre.
        Dim t1 As New Thread(AddressOf TestThread)
        t1.Name = "Thread 1"
        t1.Start()
        Dim t2 As New Thread(AddressOf TestThread)
        t2.Name = "Thread 2"
        t2.Start()

        ' Now let the threads begin adding random numbers to 
        ' the total.
        mre.Set()
        
        ' Wait until all the threads are done.
        t1.Join()
        t2.Join()

        Console.WriteLine("Thread safe: {0}  Ordinary Double: {1}", ts.Total, control)
    End Sub

    Private Shared Sub TestThread()
        ' Wait until the signal.
        mre.WaitOne()

        For i As Integer = 1 to 1000000
            ' Add to the running total in the ThreadSafe instance, and
            ' to an ordinary double.
            '
            Dim testValue As Double = r.NextDouble
            control += testValue
            ts.AddToTotal(testValue)
        Next
    End Sub
End Class

' On a dual-processor computer, this code example produces output 
' similar to the following:
'
'Thread safe: 998068.049623744  Ordinary Double: 759775.417190589

備註

如果 comparand 和中的 location1 值相等，則會 value 儲存在 中 location1。 否則，不會執行任何作業。 比較和交換作業會以不可部分完成的作業執行。 的傳回值 CompareExchange 是 中的 location1原始值，不論交換是否發生。

另請參閱

• Managed 執行緒處理
• 同步處理原始物件概觀

CompareExchange(IntPtr, IntPtr, IntPtr)

Source:

Interlocked.cs

比較兩個平台特定的控制代碼或指標是否相等；如果相等，則取代第一個。

public:
 static IntPtr CompareExchange(IntPtr % location1, IntPtr value, IntPtr comparand);

public static IntPtr CompareExchange (ref IntPtr location1, IntPtr value, IntPtr comparand);

static member CompareExchange : nativeint * nativeint * nativeint -> nativeint

Public Shared Function CompareExchange (ByRef location1 As IntPtr, value As IntPtr, comparand As IntPtr) As IntPtr

參數

location1

IntPtr

nativeint

IntPtr 目的端，其值會與 comparand 的值進行比較，且可能被 value 所取代。

value

IntPtr

nativeint

IntPtr，當比較的結果相等時會取代目的端值。

comparand

IntPtr

nativeint

IntPtr，會與 location1 的值相比較。

傳回

IntPtr

nativeint

location1 中的原始值。

例外狀況

NullReferenceException

location1 的位址為 null 指標。

備註

如果 comparand 和中的 location1 值相等，則會 value 儲存在 中 location1。 否則，不會執行任何作業。 比較和交換作業會以不可部分完成的作業執行。 不論交換是否發生，這個方法的傳回值都是 中的 location1原始值。

注意

IntPtr 是平臺特定的類型。

另請參閱

• Managed 執行緒處理
• 同步處理原始物件概觀

CompareExchange<T>(T, T, T)

Source:

Interlocked.CoreCLR.cs

比較指定參考型別 T 的兩個執行個體是否參考相等；如果相等，則取代第一個。

public:
generic <typename T>
 where T : class static T CompareExchange(T % location1, T value, T comparand);

public static T CompareExchange<T> (ref T location1, T value, T comparand) where T : class;

static member CompareExchange : 'T * 'T * 'T -> 'T (requires 'T : null)

Public Shared Function CompareExchange(Of T As Class) (ByRef location1 As T, value As T, comparand As T) As T

類型參數

T

要用於 location1、value 和 comparand 的型別。 此類型必須是參考類型。

參數

location1

T

以傳址方式與 comparand 比較其值的目的地，且可能被取代。 此為參考參數 (在 C# 中為 ref，在 Visual Basic 中為 ByRef)。

value

T

當以傳址方式比較的結果相等時，會取代目的地的值。

comparand

T

以傳址方式與位於 location1 之值比較的值。

傳回

T

location1 中的原始值。

例外狀況

NullReferenceException

location1 的位址為 null 指標。

備註

如果 comparand 和 中的 location1 值依傳址相等，則會 value 儲存在 中 location1。 否則，不會執行任何作業。 比較和交換會以不可部分完成的作業執行。 不論交換是否發生，這個方法的傳回值都是 中的 location1原始值。

這個方法僅支持參考型別。 實值型Int32別、Int64、IntPtr、 Single和 Double都有 方法的多CompareExchange載，但不支援其他實值型別。

注意

此方法多載最好是 CompareExchange(Object, Object, Object) 方法多載，因為後者需要晚期綁定存取目的地物件。