Interlocked Class

Definition

Fournit des opérations atomiques pour des variables partagées par plusieurs threads.Provides atomic operations for variables that are shared by multiple threads.

public ref class Interlocked abstract sealed
public ref class Interlocked sealed
public static class Interlocked
public sealed class Interlocked
type Interlocked = class
Public Class Interlocked
Public NotInheritable Class Interlocked
Inheritance
Interlocked

Examples

L’exemple de code suivant montre un mécanisme de verrouillage de ressource thread-safe.The following code example shows a thread-safe resource locking mechanism.

using namespace System;
using namespace System::Threading;

const int numThreads = 10;
const int numThreadIterations = 5;
ref class MyInterlockedExchangeExampleClass
{
public:
   static void MyThreadProc()
   {
      for ( int i = 0; i < numThreadIterations; i++ )
      {
         UseResource();
         
         //Wait 1 second before next attempt.
         Thread::Sleep( 1000 );

      }
   }


private:
   //A simple method that denies reentrancy.
   static bool UseResource()
   {
      
      //0 indicates that the method is not in use.
      if ( 0 == Interlocked::Exchange( usingResource, 1 ) )
      {
         Console::WriteLine( " {0} acquired the lock", Thread::CurrentThread->Name );
         
         //Code to access a resource that is not thread safe would go here.
         //Simulate some work
         Thread::Sleep( 500 );
         Console::WriteLine( " {0} exiting lock", Thread::CurrentThread->Name );
         
         //Release the lock
         Interlocked::Exchange( usingResource, 0 );
         return true;
      }
      else
      {
         Console::WriteLine( " {0} was denied the lock", Thread::CurrentThread->Name );
         return false;
      }
   }


   //0 for false, 1 for true.
   static int usingResource;
};

int main()
{
   Thread^ myThread;
   Random^ rnd = gcnew Random;
   for ( int i = 0; i < numThreads; i++ )
   {
      myThread = gcnew Thread( gcnew ThreadStart( MyInterlockedExchangeExampleClass::MyThreadProc ) );
      myThread->Name = String::Format( "Thread {0}", i + 1 );
      
      //Wait a random amount of time before starting next thread.
      Thread::Sleep( rnd->Next( 0, 1000 ) );
      myThread->Start();

   }
}

using System;
using System.Threading;

namespace InterlockedExchange_Example
{
    class MyInterlockedExchangeExampleClass
    {
        //0 for false, 1 for true.
        private static int usingResource = 0;

        private const int numThreadIterations = 5;
        private const int numThreads = 10;

        static void Main()
        {
            Thread myThread;
            Random rnd = new Random();

            for(int i = 0; i < numThreads; i++)
            {
                myThread = new Thread(new ThreadStart(MyThreadProc));
                myThread.Name = String.Format("Thread{0}", i + 1);
            
                //Wait a random amount of time before starting next thread.
                Thread.Sleep(rnd.Next(0, 1000));
                myThread.Start();
            }
        }

        private static void MyThreadProc()
        {
            for(int i = 0; i < numThreadIterations; i++)
            {
                UseResource();
            
                //Wait 1 second before next attempt.
                Thread.Sleep(1000);
            }
        }

        //A simple method that denies reentrancy.
        static bool UseResource()
        {
            //0 indicates that the method is not in use.
            if(0 == Interlocked.Exchange(ref usingResource, 1))
            {
                Console.WriteLine("{0} acquired the lock", Thread.CurrentThread.Name);
            
                //Code to access a resource that is not thread safe would go here.
            
                //Simulate some work
                Thread.Sleep(500);

                Console.WriteLine("{0} exiting lock", Thread.CurrentThread.Name);
            
                //Release the lock
                Interlocked.Exchange(ref usingResource, 0);
                return true;
            }
            else
            {
                Console.WriteLine("   {0} was denied the lock", Thread.CurrentThread.Name);
                return false;
            }
        }
    }
}  
Imports System.Threading

Namespace InterlockedExchange_Example
    Class MyInterlockedExchangeExampleClass
        '0 for false, 1 for true.
        Private Shared usingResource As Integer = 0

        Private Const numThreadIterations As Integer = 5
        Private Const numThreads As Integer = 10

        <MTAThread> _
        Shared Sub Main()
            Dim myThread As Thread
            Dim rnd As New Random()

            Dim i As Integer
            For i = 0 To numThreads - 1
                myThread = New Thread(AddressOf MyThreadProc)
                myThread.Name = String.Format("Thread{0}", i + 1)

                'Wait a random amount of time before starting next thread.
                Thread.Sleep(rnd.Next(0, 1000))
                myThread.Start()
            Next i
        End Sub

        Private Shared Sub MyThreadProc()
            Dim i As Integer
            For i = 0 To numThreadIterations - 1
                UseResource()

                'Wait 1 second before next attempt.
                Thread.Sleep(1000)
            Next i
        End Sub 

        'A simple method that denies reentrancy.
        Shared Function UseResource() As Boolean
            '0 indicates that the method is not in use.
            If 0 = Interlocked.Exchange(usingResource, 1) Then
                Console.WriteLine("{0} acquired the lock", Thread.CurrentThread.Name)

                'Code to access a resource that is not thread safe would go here.
                'Simulate some work
                Thread.Sleep(500)

                Console.WriteLine("{0} exiting lock", Thread.CurrentThread.Name)

                'Release the lock
                Interlocked.Exchange(usingResource, 0)
                Return True
            Else
                Console.WriteLine("   {0} was denied the lock", Thread.CurrentThread.Name)
                Return False
            End If
        End Function 
    End Class 
End Namespace 

Remarks

Les méthodes de cette classe permettent de se protéger contre les erreurs qui peuvent se produire lorsque le planificateur change de contexte pendant qu’un thread met à jour une variable accessible par d’autres threads, ou lorsque deux threads s’exécutent simultanément sur des processeurs distincts.The methods of this class help protect against errors that can occur when the scheduler switches contexts while a thread is updating a variable that can be accessed by other threads, or when two threads are executing concurrently on separate processors. Les membres de cette classe ne lèvent pas d’exceptions.The members of this class do not throw exceptions.

Les méthodes Increment et Decrement incrémentent ou décrémentent une variable et stockent la valeur résultante dans une opération unique.The Increment and Decrement methods increment or decrement a variable and store the resulting value in a single operation. Sur la plupart des ordinateurs, l’incrémentation d’une variable n’est pas une opération atomique, ce qui nécessite les étapes suivantes :On most computers, incrementing a variable is not an atomic operation, requiring the following steps:

  1. Charger une valeur d’une variable d’instance dans un registre.Load a value from an instance variable into a register.

  2. Incrémente ou décrémente la valeur.Increment or decrement the value.

  3. Stocke la valeur dans la variable d’instance.Store the value in the instance variable.

Si vous n’utilisez pas Increment et Decrement, un thread peut être devancé après l’exécution des deux premières étapes.If you do not use Increment and Decrement, a thread can be preempted after executing the first two steps. Un autre thread peut ensuite exécuter les trois étapes.Another thread can then execute all three steps. Lorsque le premier thread reprend l’exécution, il remplace la valeur dans la variable d’instance et l’effet de l’incrémentation ou de la décrémentation effectué par le deuxième thread est perdu.When the first thread resumes execution, it overwrites the value in the instance variable, and the effect of the increment or decrement performed by the second thread is lost.

La méthode Add ajoute atomiquement une valeur entière à une variable de type entier et retourne la nouvelle valeur de la variable.The Add method atomically adds an integer value to an integer variable and returns the new value of the variable.

La méthode Exchange échange de manière atomique les valeurs des variables spécifiées.The Exchange method atomically exchanges the values of the specified variables. La méthode CompareExchange combine deux opérations : la comparaison de deux valeurs et le stockage d’une troisième valeur dans l’une des variables, en fonction du résultat de la comparaison.The CompareExchange method combines two operations: comparing two values and storing a third value in one of the variables, based on the outcome of the comparison. Les opérations de comparaison et d’échange sont effectuées sous la forme d’une opération atomique.The compare and exchange operations are performed as an atomic operation.

Assurez-vous que tout accès en écriture ou en lecture à une variable partagée est atomique.Ensure that any write or read access to a shared variable is atomic. Dans le cas contraire, les données sont peut-être endommagées ou la valeur chargée est peut-être incorrecte.Otherwise, the data might be corrupted or the loaded value might be incorrect.

Methods

Add(Int32, Int32)

Ajoute deux entiers 32 bits et remplace le premier entier par la somme, sous la forme d'une opération atomique.Adds two 32-bit integers and replaces the first integer with the sum, as an atomic operation.

Add(Int64, Int64)

Ajoute deux entiers 64 bits et remplace le premier entier par la somme, sous la forme d'une opération atomique.Adds two 64-bit integers and replaces the first integer with the sum, as an atomic operation.

Add(UInt32, UInt32)
Add(UInt64, UInt64)
And(Int32, Int32)
And(Int64, Int64)
And(UInt32, UInt32)
And(UInt64, UInt64)
CompareExchange(Double, Double, Double)

Compare deux nombres à virgule flottante double précision et remplace le premier en cas d'égalité.Compares two double-precision floating point numbers for equality and, if they are equal, replaces the first value.

CompareExchange(Int32, Int32, Int32)

Compare deux entiers signés de 32 bits et remplace la première valeur en cas d'égalité.Compares two 32-bit signed integers for equality and, if they are equal, replaces the first value.

CompareExchange(Int64, Int64, Int64)

Compare deux entiers signés de 64 bits et remplace la première valeur en cas d'égalité.Compares two 64-bit signed integers for equality and, if they are equal, replaces the first value.

CompareExchange(IntPtr, IntPtr, IntPtr)

Compare deux handles ou pointeurs spécifiques à la plateforme et remplace le premier en cas d'égalité.Compares two platform-specific handles or pointers for equality and, if they are equal, replaces the first one.

CompareExchange(Object, Object, Object)

Compare deux objets et remplace le premier en cas d'égalité des références.Compares two objects for reference equality and, if they are equal, replaces the first object.

CompareExchange(Single, Single, Single)

Compare deux nombres à virgule flottante simple précision et remplace le premier en cas d'égalité.Compares two single-precision floating point numbers for equality and, if they are equal, replaces the first value.

CompareExchange(UInt32, UInt32, UInt32)
CompareExchange(UInt64, UInt64, UInt64)
CompareExchange<T>(T, T, T)

Compare deux instances du type référence spécifié T pour et remplace la première en cas d’égalité par référence.Compares two instances of the specified reference type T for reference equality and, if they are equal, replaces the first one.

Decrement(Int32)

Décrémente une variable spécifiée et stocke le résultat, sous la forme d'une opération atomique.Decrements a specified variable and stores the result, as an atomic operation.

Decrement(Int64)

Décrémente la variable spécifiée et stocke le résultat sous la forme d'une opération atomique.Decrements the specified variable and stores the result, as an atomic operation.

Decrement(UInt32)
Decrement(UInt64)
Exchange(Double, Double)

Affecte une valeur spécifiée à un nombre à virgule flottante double précision, puis retourne la valeur d'origine, sous la forme d'une opération atomique.Sets a double-precision floating point number to a specified value and returns the original value, as an atomic operation.

Exchange(Int32, Int32)

Affecte un entier signé 32 bits à une valeur spécifiée, puis retourne la valeur d'origine, sous la forme d'une opération atomique.Sets a 32-bit signed integer to a specified value and returns the original value, as an atomic operation.

Exchange(Int64, Int64)

Affecte une valeur spécifiée à un entier signé 64 bits, puis retourne la valeur d'origine, sous la forme d'une opération atomique.Sets a 64-bit signed integer to a specified value and returns the original value, as an atomic operation.

Exchange(IntPtr, IntPtr)

Affecte une valeur spécifiée à un handle ou un pointeur spécifique à la plateforme, puis retourne la valeur d'origine, sous la forme d'une opération atomique.Sets a platform-specific handle or pointer to a specified value and returns the original value, as an atomic operation.

Exchange(Object, Object)

Affecte une valeur spécifiée à un objet, puis retourne une référence à l'objet d'origine sous la forme d'une opération atomique.Sets an object to a specified value and returns a reference to the original object, as an atomic operation.

Exchange(Single, Single)

Affecte une valeur spécifiée à un nombre à virgule flottante simple précision, puis retourne la valeur d'origine, sous la forme d'une opération atomique.Sets a single-precision floating point number to a specified value and returns the original value, as an atomic operation.

Exchange(UInt32, UInt32)
Exchange(UInt64, UInt64)
Exchange<T>(T, T)

Affecte une valeur spécifiée à la variable de type spécifié T et retourne la valeur d’origine, sous la forme d’une opération atomique.Sets a variable of the specified type T to a specified value and returns the original value, as an atomic operation.

Increment(Int32)

Incrémente une variable spécifiée et stocke le résultat sous la forme d'une opération atomique.Increments a specified variable and stores the result, as an atomic operation.

Increment(Int64)

Incrémente une variable spécifiée et stocke le résultat sous la forme d'une opération atomique.Increments a specified variable and stores the result, as an atomic operation.

Increment(UInt32)
Increment(UInt64)
MemoryBarrier()

Synchronise l'accès à la mémoire comme suit : le processeur qui exécute le thread actuel ne peut pas réorganiser les instructions de sorte que les accès à la mémoire avant l'appel de MemoryBarrier() s'exécutent après les accès à la mémoire postérieurs à l'appel de MemoryBarrier().Synchronizes memory access as follows: The processor that executes the current thread cannot reorder instructions in such a way that memory accesses before the call to MemoryBarrier() execute after memory accesses that follow the call to MemoryBarrier().

MemoryBarrierProcessWide()

Fournit un cloisonnement de mémoire à l’échelle du processus qui garantit que les lectures et les écritures des processeurs ne peuvent pas se déplacer au sein du cloisonnement.Provides a process-wide memory barrier that ensures that reads and writes from any CPU cannot move across the barrier.

Or(Int32, Int32)
Or(Int64, Int64)
Or(UInt32, UInt32)
Or(UInt64, UInt64)
Read(Int64)

Retourne une valeur 64 bits chargée sous la forme d'une opération atomique.Returns a 64-bit value, loaded as an atomic operation.

Read(UInt64)
SpeculationBarrier()

Définit une barrière de mémoire qui bloque l’exécution spéculative au-delà de ce point tant que les lectures et les écritures en attente ne sont pas terminées.Defines a memory fence that blocks speculative execution past this point until pending reads and writes are complete.

Applies to

Thread Safety

Ce type est thread-safe.This type is thread safe.

See also