ParallelLoopState ParallelLoopState ParallelLoopState ParallelLoopState Class

Définition

Permet aux itérations de boucles parallèles d’interagir avec d’autres itérations.Enables iterations of parallel loops to interact with other iterations. Une instance de cette classe est fournie par la classe Parallel à chaque boucle ; vous ne pouvez pas créer d’instances dans votre code.An instance of this class is provided by the Parallel class to each loop; you can not create instances in your code.

public ref class ParallelLoopState
public class ParallelLoopState
type ParallelLoopState = class
Public Class ParallelLoopState
Héritage
ParallelLoopStateParallelLoopStateParallelLoopStateParallelLoopState

Exemples

L’exemple suivant exécute jusqu’à 100 itérations d’une boucle en parallèle.The following example executes up to 100 iterations of a loop in parallel. Chaque itération est suspendue pour un intervalle aléatoire compris entre 1 et 1 000 millisecondes.Each iteration pauses for a random interval from 1 to 1,000 milliseconds. Une valeur générée de manière aléatoire détermine sur quelle itération de la boucle Break la méthode est appelée.A randomly generated value determines on which iteration of the loop the Break method is called. Comme le montre la sortie de l’exemple, aucune itération dont l’index est supérieur à LowestBreakIteration la valeur de propriété démarre après l’appel Break à la méthode.As the output from the example shows, no iterations whose index is greater than the LowestBreakIteration property value start after the call to the Break method.

using System;
using System.Threading;
using System.Threading.Tasks;

public class Example
{
   public static void Main()
   {
      var rnd = new Random();
      int breakIndex = rnd.Next(1, 11);
      Nullable<long> lowest = new Nullable<long>();

      Console.WriteLine("Will call Break at iteration {0}\n",
                        breakIndex);

      var result = Parallel.For(1, 101, (i, state) => {
                                            Console.WriteLine("Beginning iteration {0}", i);
                                            int delay;
                                            Monitor.Enter(rnd);
                                               delay = rnd.Next(1, 1001);
                                            Monitor.Exit(rnd);
                                            Thread.Sleep(delay);
                                            
                                            if (state.ShouldExitCurrentIteration) {
                                               if (state.LowestBreakIteration < i)
                                                  return;
                                            }

                                            if (i == breakIndex) {
                                               Console.WriteLine("Break in iteration {0}", i);
                                               state.Break();
                                               if (state.LowestBreakIteration.HasValue)
                                                  if (lowest < state.LowestBreakIteration)
                                                     lowest = state.LowestBreakIteration;
                                                  else
                                                     lowest = state.LowestBreakIteration;
                                            }

                                            Console.WriteLine("Completed iteration {0}", i);
                                       });
         if (lowest.HasValue)
            Console.WriteLine("\nLowest Break Iteration: {0}", lowest);
         else
            Console.WriteLine("\nNo lowest break iteration.");
   }
}
// The example displays output like the following:
//       Will call Break at iteration 8
//
//       Beginning iteration 1
//       Beginning iteration 13
//       Beginning iteration 97
//       Beginning iteration 25
//       Beginning iteration 49
//       Beginning iteration 37
//       Beginning iteration 85
//       Beginning iteration 73
//       Beginning iteration 61
//       Completed iteration 85
//       Beginning iteration 86
//       Completed iteration 61
//       Beginning iteration 62
//       Completed iteration 86
//       Beginning iteration 87
//       Completed iteration 37
//       Beginning iteration 38
//       Completed iteration 38
//       Beginning iteration 39
//       Completed iteration 25
//       Beginning iteration 26
//       Completed iteration 26
//       Beginning iteration 27
//       Completed iteration 73
//       Beginning iteration 74
//       Completed iteration 62
//       Beginning iteration 63
//       Completed iteration 39
//       Beginning iteration 40
//       Completed iteration 40
//       Beginning iteration 41
//       Completed iteration 13
//       Beginning iteration 14
//       Completed iteration 1
//       Beginning iteration 2
//       Completed iteration 97
//       Beginning iteration 98
//       Completed iteration 49
//       Beginning iteration 50
//       Completed iteration 87
//       Completed iteration 27
//       Beginning iteration 28
//       Completed iteration 50
//       Beginning iteration 51
//       Beginning iteration 88
//       Completed iteration 14
//       Beginning iteration 15
//       Completed iteration 15
//       Completed iteration 2
//       Beginning iteration 3
//       Beginning iteration 16
//       Completed iteration 63
//       Beginning iteration 64
//       Completed iteration 74
//       Beginning iteration 75
//       Completed iteration 41
//       Beginning iteration 42
//       Completed iteration 28
//       Beginning iteration 29
//       Completed iteration 29
//       Beginning iteration 30
//       Completed iteration 98
//       Beginning iteration 99
//       Completed iteration 64
//       Beginning iteration 65
//       Completed iteration 42
//       Beginning iteration 43
//       Completed iteration 88
//       Beginning iteration 89
//       Completed iteration 51
//       Beginning iteration 52
//       Completed iteration 16
//       Beginning iteration 17
//       Completed iteration 43
//       Beginning iteration 44
//       Completed iteration 44
//       Beginning iteration 45
//       Completed iteration 99
//       Beginning iteration 4
//       Completed iteration 3
//       Beginning iteration 8
//       Completed iteration 4
//       Beginning iteration 5
//       Completed iteration 52
//       Beginning iteration 53
//       Completed iteration 75
//       Beginning iteration 76
//       Completed iteration 76
//       Beginning iteration 77
//       Completed iteration 65
//       Beginning iteration 66
//       Completed iteration 5
//       Beginning iteration 6
//       Completed iteration 89
//       Beginning iteration 90
//       Completed iteration 30
//       Beginning iteration 31
//       Break in iteration 8
//       Completed iteration 8
//       Completed iteration 6
//       Beginning iteration 7
//       Completed iteration 7
//
//       Lowest Break Iteration: 8
Imports System.Threading
Imports System.Threading.Tasks

Module Example
   Public Sub Main()
      Dim rnd As New Random()
      Dim breakIndex As Integer = rnd.Next(1, 11)
      Dim lowest As New Nullable(Of Long)()

      Console.WriteLine("Will call Break at iteration {0}", breakIndex)
      Console.WriteLine()

      Dim result = Parallel.For(1, 101, Sub(i, state)
                                            Console.WriteLine("Beginning iteration {0}", i)
                                            Dim delay As Integer
                                            Monitor.Enter(rnd)
                                               delay = rnd.Next(1, 1001)
                                            Monitor.Exit(rnd)
                                            Thread.Sleep(delay)

                                            If state.ShouldExitCurrentIteration Then
                                               If state.LowestBreakIteration < i Then
                                                  Return
                                               End If
                                            End If

                                            If i = breakIndex Then
                                               Console.WriteLine("Break in iteration {0}", i)
                                               state.Break()
                                               If state.LowestBreakIteration.HasValue Then
                                                  If lowest < state.LowestBreakIteration Then
                                                     lowest = state.LowestBreakIteration
                                                  Else
                                                     lowest = state.LowestBreakIteration
                                                  End If
                                               End If
                                            End If

                                            Console.WriteLine("Completed iteration {0}", i)
                                       End Sub )
         Console.WriteLine()
         If lowest.HasValue Then
            Console.WriteLine("Lowest Break Iteration: {0}", lowest)
         Else
            Console.WriteLine("No lowest break iteration.")
         End If
   End Sub
End Module
' The example displays output like the following:
'       Will call Break at iteration 8
'
'       Beginning iteration 1
'       Beginning iteration 13
'       Beginning iteration 97
'       Beginning iteration 25
'       Beginning iteration 49
'       Beginning iteration 37
'       Beginning iteration 85
'       Beginning iteration 73
'       Beginning iteration 61
'       Completed iteration 85
'       Beginning iteration 86
'       Completed iteration 61
'       Beginning iteration 62
'       Completed iteration 86
'       Beginning iteration 87
'       Completed iteration 37
'       Beginning iteration 38
'       Completed iteration 38
'       Beginning iteration 39
'       Completed iteration 25
'       Beginning iteration 26
'       Completed iteration 26
'       Beginning iteration 27
'       Completed iteration 73
'       Beginning iteration 74
'       Completed iteration 62
'       Beginning iteration 63
'       Completed iteration 39
'       Beginning iteration 40
'       Completed iteration 40
'       Beginning iteration 41
'       Completed iteration 13
'       Beginning iteration 14
'       Completed iteration 1
'       Beginning iteration 2
'       Completed iteration 97
'       Beginning iteration 98
'       Completed iteration 49
'       Beginning iteration 50
'       Completed iteration 87
'       Completed iteration 27
'       Beginning iteration 28
'       Completed iteration 50
'       Beginning iteration 51
'       Beginning iteration 88
'       Completed iteration 14
'       Beginning iteration 15
'       Completed iteration 15
'       Completed iteration 2
'       Beginning iteration 3
'       Beginning iteration 16
'       Completed iteration 63
'       Beginning iteration 64
'       Completed iteration 74
'       Beginning iteration 75
'       Completed iteration 41
'       Beginning iteration 42
'       Completed iteration 28
'       Beginning iteration 29
'       Completed iteration 29
'       Beginning iteration 30
'       Completed iteration 98
'       Beginning iteration 99
'       Completed iteration 64
'       Beginning iteration 65
'       Completed iteration 42
'       Beginning iteration 43
'       Completed iteration 88
'       Beginning iteration 89
'       Completed iteration 51
'       Beginning iteration 52
'       Completed iteration 16
'       Beginning iteration 17
'       Completed iteration 43
'       Beginning iteration 44
'       Completed iteration 44
'       Beginning iteration 45
'       Completed iteration 99
'       Beginning iteration 4
'       Completed iteration 3
'       Beginning iteration 8
'       Completed iteration 4
'       Beginning iteration 5
'       Completed iteration 52
'       Beginning iteration 53
'       Completed iteration 75
'       Beginning iteration 76
'       Completed iteration 76
'       Beginning iteration 77
'       Completed iteration 65
'       Beginning iteration 66
'       Completed iteration 5
'       Beginning iteration 6
'       Completed iteration 89
'       Beginning iteration 90
'       Completed iteration 30
'       Beginning iteration 31
'       Break in iteration 8
'       Completed iteration 8
'       Completed iteration 6
'       Beginning iteration 7
'       Completed iteration 7
'
'       Lowest Break Iteration: 8

Étant donné que les itérations de la boucle sont susceptibles de s’exécuter quand Break la méthode est appelée, chaque itération appelle ShouldExitCurrentIteration la propriété pour vérifier si une autre itération a Break appelé la méthode.Because iterations of the loop are still likely to be executing when the Break method is called, each iteration calls the ShouldExitCurrentIteration property to check whether another iteration has called the Break method. Si la valeur de la truepropriété est, l’itération vérifie la valeur LowestBreakIteration de la propriété et, si elle est supérieure à la valeur d’index de l’itération actuelle, est retournée immédiatement.If the property value is true, the iteration checks the value of the LowestBreakIteration property and, if it is greater than the current iteration's index value, returns immediately.

Remarques

Notez que vous ne pouvez pas instancier une instance de cette classe.Note that you cannot instantiate an instance of this class. Il est généré automatiquement par le compilateur en tant qu’argument dans un appel à Parallel.For la Parallel.ForEach méthode ou.It is automatically generated by the compiler as an argument in a call to the Parallel.For or Parallel.ForEach method. Cet exemple en fournit une illustration.The example provides an illustration.

Les constructions telles que for et foreach (dans C#) et For et For Each (dans Visual Basic) s’exécutent de manière séquentielle à partir de l’index le plus bas jusqu’au plus élevé ou du premier objet d’un jeu au dernier.Constructs such as for and foreach (in C#) and For and For Each (in Visual Basic) execute sequentially from the lowest index to the highest or from the first object in a set to the last. En revanche, les Parallel.For méthodes Parallel.ForEach et ne le font pas.In contrast, the Parallel.For and Parallel.ForEach methods do not. Étant donné que les itérations individuelles de la boucle s’exécutent en parallèle, elles peuvent commencer et se terminer dans n’importe quel ordre.Because individual iterations of the loop run in parallel, they can begin and end in any order. La ParallelLoopState classe permet à des itérations de boucles parallèles d’interagir les unes avec les autres.The ParallelLoopState class allows individual iterations of parallel loops to interact with one another. La ParallelLoopState classe vous permet d’effectuer les opérations suivantes:The ParallelLoopState class allows you to:

  • Quittez l’itération actuelle et empêchez le démarrage des itérations supplémentaires Stop en appelant la méthode.Exit the current iteration and prevent any additional iterations from starting by calling the Stop method. Cela n’affecte pas les itérations qui ont déjà commencé l’exécution.This does not affect iterations that have already begun execution.

  • Empêchez l’exécution des itérations dont l’index est supérieur à l’index actuel en Break appelant la méthode.Prevent any iterations with an index greater than the current index from executing by calling the Break method. Cela n’affecte pas les itérations qui ont déjà commencé l’exécution.This does not affect iterations that have already begun execution.

  • Déterminez si une exception s’est produite dans une itération de boucle en extrayant la valeur IsExceptional de la propriété.Determine whether an exception has occurred in any loop iteration by retrieving the value of the IsExceptional property.

  • Déterminez si une itération de la boucle a appelé Stop la méthode en extrayant la valeur de la IsStopped propriété.Determine whether any iteration of the loop has called the Stop method by retrieving the value of the IsStopped property. Vous pouvez utiliser cette propriété pour retourner des itérations de la boucle qui a démarré avant l’appel à Stop la méthode, mais qui sont toujours en cours d’exécution.You can use this property to return from iterations of the loop that started before the call to the Stop method but are still executing.

  • Déterminez si une itération de la boucle a appelé Break la Stop méthode ou ou a levé une exception en extrayant la valeur de la ShouldExitCurrentIteration propriété.Determine whether any iteration of the loop has called the Break or Stop method or has thrown an exception by retrieving the value of the ShouldExitCurrentIteration property.

  • Quittez une itération de longue durée dont l’index est supérieur à l’index d’une itération dans laquelle Break a été appelé en extrayant la valeur de LowestBreakIteration la propriété.Exit from a long-running iteration whose index is greater than the index of an iteration in which Break was called by retrieving the value of the LowestBreakIteration property.

Propriétés

IsExceptional IsExceptional IsExceptional IsExceptional

Indique si une itération de la boucle a levé une exception qui n'a pas été gérée par cette itération.Gets whether any iteration of the loop has thrown an exception that went unhandled by that iteration.

IsStopped IsStopped IsStopped IsStopped

Indique si une itération de la boucle a appelé la méthode Stop().Gets whether any iteration of the loop has called the Stop() method.

LowestBreakIteration LowestBreakIteration LowestBreakIteration LowestBreakIteration

Obtient l'itération la plus basse de la boucle d'où Break() a été appelé.Gets the lowest iteration of the loop from which Break() was called.

ShouldExitCurrentIteration ShouldExitCurrentIteration ShouldExitCurrentIteration ShouldExitCurrentIteration

Indique si l'itération actuelle de la boucle doit s'arrêter en fonction des requêtes effectuées par cette itération ou d'autres.Gets whether the current iteration of the loop should exit based on requests made by this or other iterations.

Méthodes

Break() Break() Break() Break()

Indique que l’exécution de la boucle Parallel doit s’arrêter après l’itération actuelle dès que le système le peut.Communicates that the Parallel loop should cease execution of iterations beyond the current iteration at the system's earliest convenience.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Détermine si l'objet spécifié est identique à l'objet actuel.Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Fait office de fonction de hachage par défaut.Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Obtient le Type de l'instance actuelle.Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Crée une copie superficielle de l'objet Object actuel.Creates a shallow copy of the current Object.

(Inherited from Object)
Stop() Stop() Stop() Stop()

Indique que l'exécution de la boucle Parallel doit s'arrêter dès que le système le peut.Communicates that the Parallel loop should cease execution at the system's earliest convenience.

ToString() ToString() ToString() ToString()

Retourne une chaîne qui représente l'objet actuel.Returns a string that represents the current object.

(Inherited from Object)

S’applique à

Cohérence de thread

Une ParallelLoopState instance est destinée à être utilisée uniquement dans le corps de la boucle à laquelle une instance a été fournie.A ParallelLoopState instance is meant to be used only within the body of the loop to which an instance was provided. Il n’est pas possible d’utiliser une ParallelLoopState instance fournie après la fin de la boucle associée, ni de la transmettre explicitement à d’autres threads et de faire en sorte que ces threads y accèdent à tout moment.It is not safe to use a provided ParallelLoopState instance after the associated loop ends, nor is it safe to explicitly hand it off to other threads and have those threads access it at any time. Une instance ParallelLoopState différente sera fournie à chaque thread impliqué dans une boucle.A different ParallelLoopState instance will be provided to each thread involved in a loop.

Voir aussi