Task.Wait Méthode

Définition

Attend la fin de l'exécution de Task.

Surcharges

Wait(TimeSpan)

Attend la fin de l'exécution de la Task dans un intervalle de temps spécifié.

Wait(CancellationToken)

Attend la fin de l'exécution de Task. L'attente se termine si un jeton d'annulation est annulé avant la fin de la tâche.

Wait(Int32)

Attend la fin de l'exécution de la Task en un nombre de millisecondes spécifié.

Wait(Int32, CancellationToken)

Attend la fin de l'exécution de Task. L'attente se termine si un intervalle de délai est écoulé ou si un jeton d'annulation est annulé avant la fin de la tâche.

Wait()

Attend la fin de l'exécution de Task.

Wait(TimeSpan)

Attend la fin de l'exécution de la Task dans un intervalle de temps spécifié.

public:
 bool Wait(TimeSpan timeout);
public bool Wait (TimeSpan timeout);
member this.Wait : TimeSpan -> bool
Public Function Wait (timeout As TimeSpan) As Boolean

Paramètres

timeout
TimeSpan

TimeSpan qui représente le nombre de millièmes de secondes à attendre ou TimeSpan qui représente -1 millième de seconde, pour attendre indéfiniment.

Retours

Boolean

true si l'exécution de Task s'est terminée dans le délai imparti ; sinon, false.

Exceptions

Task a été supprimé.

timeout est un nombre négatif différent de -1 milliseconde, qui représente un délai d’attente infini. -ou- timeout est supérieur à MaxValue.

La tâche a été annulée. La collection InnerExceptions contient un objet TaskCanceledException.

  • ou - Une exception a été levée pendant l’exécution de la tâche. La collection InnerExceptions contient des informations sur l’exception ou les exceptions.

Exemples

L’exemple suivant démarre une tâche qui génère des entiers aléatoires 5 millions entre 0 et 100 et calcule leur moyenne. L’exemple utilise la Wait(TimeSpan) méthode pour attendre que l’application se termine dans un délai de 150 millisecondes. Si l’application se termine normalement, la tâche affiche la somme et la moyenne des nombres aléatoires qu’elle a générés. Si l’intervalle de délai d’attente est écoulé, l’exemple affiche un message avant qu’il ne se termine.

using System;
using System.Threading.Tasks;

public class Example
{
   public static void Main()
   {
      Task t = Task.Run( () => {
                            Random rnd = new Random();
                            long sum = 0;
                            int n = 5000000;
                            for (int ctr = 1; ctr <= n; ctr++) {
                               int number = rnd.Next(0, 101);
                               sum += number;
                            }
                            Console.WriteLine("Total:   {0:N0}", sum);
                            Console.WriteLine("Mean:    {0:N2}", sum/n);
                            Console.WriteLine("N:       {0:N0}", n);   
                         } );
     TimeSpan ts = TimeSpan.FromMilliseconds(150);
     if (! t.Wait(ts))
        Console.WriteLine("The timeout interval elapsed.");
   }
}
// The example displays output similar to the following:
//       Total:   50,015,714
//       Mean:    50.02
//       N:       1,000,000
// Or it displays the following output:
//      The timeout interval elapsed.
Imports System.Threading.Tasks

Module Example
   Public Sub Main()
      Dim t As Task = Task.Run( Sub()
                                   Dim rnd As New Random()
                                   Dim sum As Long
                                   Dim n As Integer = 5000000
                                   For ctr As Integer = 1 To n
                                      Dim number As Integer = rnd.Next(0, 101)
                                      sum += number
                                   Next
                                   Console.WriteLine("Total:   {0:N0}", sum)
                                   Console.WriteLine("Mean:    {0:N2}", sum/n)
                                   Console.WriteLine("N:       {0:N0}", n)   
                                End Sub)
     Dim ts As TimeSpan = TimeSpan.FromMilliseconds(150)
     If Not t.Wait(ts) Then
        Console.WriteLine("The timeout interval elapsed.")
     End If
   End Sub
End Module
' The example displays output similar to the following:
'       Total:   50,015,714
'       Mean:    50.02
'       N:       1,000,000
' Or it displays the following output:
'       The timeout interval elapsed.

Remarques

Wait(TimeSpan) est une méthode de synchronisation qui oblige le thread appelant à attendre l’exécution de l’instance de tâche actuelle jusqu’à ce que l’un des éléments suivants se produise :

  • La tâche se termine correctement.

  • La tâche elle-même est annulée ou lève une exception. Dans ce cas, vous gérez une AggregateException exception. La AggregateException.InnerExceptions propriété contient des détails sur l’exception ou les exceptions.

  • L’intervalle défini par s' timeout écoule. Dans ce cas, le thread actuel reprend l’exécution et la méthode retourne false .

S’applique à

Wait(CancellationToken)

Attend la fin de l'exécution de Task. L'attente se termine si un jeton d'annulation est annulé avant la fin de la tâche.

public:
 void Wait(System::Threading::CancellationToken cancellationToken);
public void Wait (System.Threading.CancellationToken cancellationToken);
member this.Wait : System.Threading.CancellationToken -> unit
Public Sub Wait (cancellationToken As CancellationToken)

Paramètres

cancellationToken
CancellationToken

Jeton d’annulation à observer en attendant que la tâche se termine.

Exceptions

cancellationToken a été annulé.

La tâche a été supprimée.

La tâche a été annulée. La collection InnerExceptions contient un objet TaskCanceledException.

  • ou - Une exception a été levée pendant l’exécution de la tâche. La collection InnerExceptions contient des informations sur l’exception ou les exceptions.

Exemples

L’exemple suivant illustre l’utilisation simple d’un jeton d’annulation pour annuler l’attente de l’achèvement d’une tâche. Une tâche est lancée, appelle la CancellationTokenSource.Cancel méthode pour annuler les jetons d’annulation de la source du jeton, puis retarde cinq secondes. Notez que la tâche elle-même n’a pas été passée au jeton d’annulation et qu’elle n’est pas annulable. Le thread d’application appelle la méthode de la tâche Task.Wait pour attendre que la tâche se termine, mais l’attente est annulée une fois que le jeton d’annulation est annulé et qu’une OperationCanceledException exception est levée. Le gestionnaire d’exceptions signale l’exception, puis se met en veille pendant six secondes. Comme le montre la sortie de l’exemple, ce délai permet à la tâche de se terminer dans l' RanToCompletion État.

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

public class Example
{
   public static void Main()
   {
      CancellationTokenSource ts = new CancellationTokenSource();

      Task t = Task.Run( () => { Console.WriteLine("Calling Cancel...");
                                 ts.Cancel();
                                 Task.Delay(5000).Wait();
                                 Console.WriteLine("Task ended delay...");
                               });
      try {
         Console.WriteLine("About to wait for the task to complete...");
         t.Wait(ts.Token);
      }
      catch (OperationCanceledException e) {
         Console.WriteLine("{0}: The wait has been canceled. Task status: {1:G}",
                           e.GetType().Name, t.Status);
         Thread.Sleep(6000);
         Console.WriteLine("After sleeping, the task status:  {0:G}", t.Status);
      }
      ts.Dispose();
   }
}
// The example displays output like the following:
//    About to wait for the task to complete...
//    Calling Cancel...
//    OperationCanceledException: The wait has been canceled. Task status: Running
//    Task ended delay...
//    After sleeping, the task status:  RanToCompletion
Imports System.Threading
Imports System.Threading.Tasks

Module Example
   Public Sub Main()
      Dim ts As New CancellationTokenSource()

      Dim t = Task.Run( Sub()
                           Console.WriteLine("Calling Cancel...")
                           ts.Cancel()
                           Task.Delay(5000).Wait()
                           Console.WriteLine("Task ended delay...")
                        End Sub)
      Try
         Console.WriteLine("About to wait for the task to complete...")
         t.Wait(ts.Token)
      Catch e As OperationCanceledException
         Console.WriteLine("{0}: The wait has been canceled. Task status: {1:G}",
                           e.GetType().Name, t.Status)
         Thread.Sleep(6000)
         Console.WriteLine("After sleeping, the task status:  {0:G}", t.Status)
      End Try
      ts.Dispose()
   End Sub
End Module
' The example displays output like the following:
'    About to wait for the task to complete...
'    Calling Cancel...
'    OperationCanceledException: The wait has been canceled. Task status: Running
'    Task ended delay...
'    After sleeping, the task status:  RanToCompletion

Remarques

La Wait(CancellationToken) méthode crée une attente annulable. autrement dit, elle provoque l’attente du thread actuel jusqu’à ce que l’un des éléments suivants se produise :

Notes

L’annulation du cancellationToken jeton d’annulation n’a aucun effet sur la tâche en cours d’exécution, sauf si le jeton d’annulation a également été passé et est prêt à gérer l’annulation. Le passage cancellationToken de l’objet à cette méthode permet simplement à l’attente d’être annulée.

S’applique à

Wait(Int32)

Attend la fin de l'exécution de la Task en un nombre de millisecondes spécifié.

public:
 bool Wait(int millisecondsTimeout);
public bool Wait (int millisecondsTimeout);
member this.Wait : int -> bool
Public Function Wait (millisecondsTimeout As Integer) As Boolean

Paramètres

millisecondsTimeout
Int32

Nombre de millisecondes à attendre, ou Infinite (-1) pour un délai d'attente infini.

Retours

Boolean

true si l'exécution de Task s'est terminée dans le délai imparti ; sinon, false.

Exceptions

Task a été supprimé.

millisecondsTimeout est un nombre négatif différent de -1, qui représente un délai d’attente infini.

La tâche a été annulée. La collection InnerExceptions contient un objet TaskCanceledException.

  • ou - Une exception a été levée pendant l’exécution de la tâche. La collection InnerExceptions contient des informations sur l’exception ou les exceptions.

Exemples

L’exemple suivant démarre une tâche qui génère des entiers aléatoires 5 millions entre 0 et 100 et calcule leur moyenne. L’exemple utilise la Wait(Int32) méthode pour attendre que l’application se termine dans un délai de 150 millisecondes. Si l’application se termine normalement, la tâche affiche la somme et la moyenne des nombres aléatoires qu’elle a générés. Si l’intervalle de délai d’attente est écoulé, l’exemple affiche un message avant qu’il ne se termine.

using System;
using System.Threading.Tasks;

public class Example
{
   public static void Main()
   {
      Task t = Task.Run( () => {
                            Random rnd = new Random();
                            long sum = 0;
                            int n = 5000000;
                            for (int ctr = 1; ctr <= n; ctr++) {
                               int number = rnd.Next(0, 101);
                               sum += number;
                            }
                            Console.WriteLine("Total:   {0:N0}", sum);
                            Console.WriteLine("Mean:    {0:N2}", sum/n);
                            Console.WriteLine("N:       {0:N0}", n);   
                         } );
     if (! t.Wait(150))
        Console.WriteLine("The timeout interval elapsed.");
   }
}
// The example displays output similar to the following:
//       Total:   50,015,714
//       Mean:    50.02
//       N:       1,000,000
// Or it displays the following output:
//      The timeout interval elapsed.
Imports System.Threading.Tasks

Module Example
   Public Sub Main()
      Dim t As Task = Task.Run( Sub()
                                   Dim rnd As New Random()
                                   Dim sum As Long
                                   Dim n As Integer = 5000000
                                   For ctr As Integer = 1 To n
                                      Dim number As Integer = rnd.Next(0, 101)
                                      sum += number
                                   Next
                                   Console.WriteLine("Total:   {0:N0}", sum)
                                   Console.WriteLine("Mean:    {0:N2}", sum/n)
                                   Console.WriteLine("N:       {0:N0}", n)   
                                End Sub)
     If Not t.Wait(150) Then
        Console.WriteLine("The timeout interval elapsed.")
     End If
   End Sub
End Module
' The example displays output similar to the following:
'       Total:   50,015,714
'       Mean:    50.02
'       N:       1,000,000
' Or it displays the following output:
'       The timeout interval elapsed.

Remarques

Wait(Int32) est une méthode de synchronisation qui oblige le thread appelant à attendre l’exécution de l’instance de tâche actuelle jusqu’à ce que l’un des éléments suivants se produise :

  • La tâche se termine correctement.

  • La tâche elle-même est annulée ou lève une exception. Dans ce cas, vous gérez une AggregateException exception. La AggregateException.InnerExceptions propriété contient des détails sur l’exception ou les exceptions.

  • L’intervalle défini par s' millisecondsTimeout écoule. Dans ce cas, le thread actuel reprend l’exécution et la méthode retourne false .

S’applique à

Wait(Int32, CancellationToken)

Attend la fin de l'exécution de Task. L'attente se termine si un intervalle de délai est écoulé ou si un jeton d'annulation est annulé avant la fin de la tâche.

public:
 bool Wait(int millisecondsTimeout, System::Threading::CancellationToken cancellationToken);
public bool Wait (int millisecondsTimeout, System.Threading.CancellationToken cancellationToken);
member this.Wait : int * System.Threading.CancellationToken -> bool
Public Function Wait (millisecondsTimeout As Integer, cancellationToken As CancellationToken) As Boolean

Paramètres

millisecondsTimeout
Int32

Nombre de millisecondes à attendre, ou Infinite (-1) pour un délai d'attente infini.

cancellationToken
CancellationToken

Jeton d’annulation à observer en attendant que la tâche se termine.

Retours

Boolean

true si l'exécution de Task s'est terminée dans le délai imparti ; sinon, false.

Exceptions

cancellationToken a été annulé.

Task a été supprimé.

millisecondsTimeout est un nombre négatif différent de -1, qui représente un délai d’attente infini.

La tâche a été annulée. La collection InnerExceptions contient un objet TaskCanceledException.

  • ou - Une exception a été levée pendant l’exécution de la tâche. La collection InnerExceptions contient des informations sur l’exception ou les exceptions.

Exemples

L’exemple suivant appelle la Wait(Int32, CancellationToken) méthode pour fournir une valeur de délai d’attente et un jeton d’annulation qui peuvent mettre fin à l’attente de l’achèvement d’une tâche. Un nouveau thread est démarré et exécute la CancelToken méthode, qui s’interrompt, puis appelle la CancellationTokenSource.Cancel méthode pour annuler les jetons d’annulation. Une tâche est ensuite lancée et retarde de 5 secondes. La Wait méthode est ensuite appelée pour attendre la fin de la tâche et est fournie à la fois une valeur de délai d’expiration courte et un jeton d’annulation.

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

public class Example
{
   public static void Main()
   {
      CancellationTokenSource ts = new CancellationTokenSource();
      Thread thread = new Thread(CancelToken);
      thread.Start(ts);

      Task t = Task.Run( () => { Task.Delay(5000).Wait();
                                 Console.WriteLine("Task ended delay...");
                               });
      try {
         Console.WriteLine("About to wait completion of task {0}", t.Id);
         bool result = t.Wait(1510, ts.Token);
         Console.WriteLine("Wait completed normally: {0}", result);
         Console.WriteLine("The task status:  {0:G}", t.Status);
      }
      catch (OperationCanceledException e) {
         Console.WriteLine("{0}: The wait has been canceled. Task status: {1:G}",
                           e.GetType().Name, t.Status);
         Thread.Sleep(4000);
         Console.WriteLine("After sleeping, the task status:  {0:G}", t.Status);
         ts.Dispose();
      }
   }

   private static void CancelToken(Object obj)
   {
      Thread.Sleep(1500);
      Console.WriteLine("Canceling the cancellation token from thread {0}...",
                        Thread.CurrentThread.ManagedThreadId);
      CancellationTokenSource source = obj as CancellationTokenSource;
      if (source != null) source.Cancel();
   }
}
// The example displays output like the following if the wait is canceled by
// the cancellation token:
//    About to wait completion of task 1
//    Canceling the cancellation token from thread 3...
//    OperationCanceledException: The wait has been canceled. Task status: Running
//    Task ended delay...
//    After sleeping, the task status:  RanToCompletion
// The example displays output like the following if the wait is canceled by
// the timeout interval expiring:
//    About to wait completion of task 1
//    Wait completed normally: False
//    The task status:  Running
//    Canceling the cancellation token from thread 3...
Imports System.Threading
Imports System.Threading.Tasks

Module Example
   Public Sub Main()
      Dim ts As New CancellationTokenSource()
      Dim thread As New Thread(AddressOf CancelToken)
      thread.Start(ts)

      Dim t As Task = Task.Run( Sub()
                                   Task.Delay(5000).Wait()
                                    Console.WriteLine("Task ended delay...")
                                End Sub)
      Try
         Console.WriteLine("About to wait completion of task {0}", t.Id)
         Dim result As Boolean = t.Wait(1510, ts.Token)
         Console.WriteLine("Wait completed normally: {0}", result)
         Console.WriteLine("The task status:  {0:G}", t.Status)
      Catch e As OperationCanceledException
         Console.WriteLine("{0}: The wait has been canceled. Task status: {1:G}",
                           e.GetType().Name, t.Status)
         Thread.Sleep(4000)
         Console.WriteLine("After sleeping, the task status:  {0:G}", t.Status)
         ts.Dispose()
      End Try
   End Sub

   Private Sub CancelToken(obj As Object)
      Thread.Sleep(1500)
      Console.WriteLine("Canceling the cancellation token from thread {0}...",
                        Thread.CurrentThread.ManagedThreadId)

      If TypeOf obj Is CancellationTokenSource Then
         Dim source As CancellationTokenSource = CType(obj, CancellationTokenSource)
         source.Cancel()
      End If
   End Sub
End Module
' The example displays output like the following if the wait is canceled by
' the cancellation token:
'    About to wait completion of task 1
'    Canceling the cancellation token from thread 3...
'    OperationCanceledException: The wait has been canceled. Task status: Running
'    Task ended delay...
'    After sleeping, the task status:  RanToCompletion
' The example displays output like the following if the wait is canceled by
' the timeout interval expiring:
'    About to wait completion of task 1
'    Wait completed normally: False
'    The task status:  Running
'    Canceling the cancellation token from thread 3...

Notez que la sortie précise de l’exemple varie selon que l’attente a été annulée en raison du jeton d’annulation ou parce que l’intervalle de délai d’attente s’est écoulé.

Remarques

Wait(Int32, CancellationToken) est une méthode de synchronisation qui oblige le thread appelant à attendre l’exécution de l’instance de tâche actuelle jusqu’à ce que l’un des éléments suivants se produise :

  • La tâche se termine correctement.

  • La tâche elle-même est annulée ou lève une exception. Dans ce cas, vous gérez une AggregateException exception. La AggregateException.InnerExceptions propriété contient des détails sur l’exception ou les exceptions.

  • Le cancellationToken jeton d’annulation est annulé. Dans ce cas, l’appel à la Wait(Int32, CancellationToken) méthode lève une exception OperationCanceledException .

  • L’intervalle défini par s' millisecondsTimeout écoule. Dans ce cas, le thread actuel reprend l’exécution et la méthode retourne false .

Notes

L’annulation du cancellationToken jeton d’annulation n’a aucun effet sur la tâche en cours d’exécution, sauf si le jeton d’annulation a également été passé et est prêt à gérer l’annulation. Le passage cancellationToken de l’objet à cette méthode permet simplement à l’attente d’être annulée en fonction d’une condition.

S’applique à

Wait()

Attend la fin de l'exécution de Task.

public:
 void Wait();
public void Wait ();
member this.Wait : unit -> unit
Public Sub Wait ()

Exceptions

Task a été supprimé.

La tâche a été annulée. La collection InnerExceptions contient un objet TaskCanceledException.

  • ou - Une exception a été levée pendant l’exécution de la tâche. La collection InnerExceptions contient des informations sur l’exception ou les exceptions.

Exemples

L’exemple suivant démarre une tâche qui génère des entiers aléatoires 1 million entre 0 et 100 et calcule leur moyenne. L’exemple utilise la Wait méthode pour s’assurer que la tâche se termine avant la fin de l’application. Dans le cas contraire, comme il s’agit d’une application console, l’exemple se termine avant que la tâche puisse calculer et afficher la moyenne.

using System;
using System.Threading.Tasks;

public class Example
{
   public static void Main()
   {
      Task t = Task.Run( () => {
                            Random rnd = new Random();
                            long sum = 0;
                            int n = 1000000;
                            for (int ctr = 1; ctr <= n; ctr++) {
                               int number = rnd.Next(0, 101);
                               sum += number;
                            }
                            Console.WriteLine("Total:   {0:N0}", sum);
                            Console.WriteLine("Mean:    {0:N2}", sum/n);
                            Console.WriteLine("N:       {0:N0}", n);   
                         } );
     t.Wait();
   }
}
// The example displays output similar to the following:
//       Total:   50,015,714
//       Mean:    50.02
//       N:       1,000,000
Imports System.Threading.Tasks

Module Example
   Public Sub Main()
      Dim t As Task = Task.Run( Sub()
                                   Dim rnd As New Random()
                                   Dim sum As Long
                                   Dim n As Integer = 1000000
                                   For ctr As Integer = 1 To n
                                      Dim number As Integer = rnd.Next(0, 101)
                                      sum += number
                                   Next
                                   Console.WriteLine("Total:   {0:N0}", sum)
                                   Console.WriteLine("Mean:    {0:N2}", sum/n)
                                   Console.WriteLine("N:       {0:N0}", n)   
                                End Sub)
     t.Wait()
   End Sub
End Module
' The example displays output similar to the following:
'       Total:   50,015,714
'       Mean:    50.02
'       N:       1,000,000

Remarques

Wait méthode de synchronisation qui oblige le thread appelant à attendre la fin de la tâche en cours. Si l’exécution de la tâche actuelle n’a pas démarré, la méthode Wait tente de supprimer la tâche du planificateur et de l’exécuter Inline sur le thread actuel. S’il n’y parvient pas, ou si la tâche en cours a déjà démarré l’exécution, elle bloque le thread appelant jusqu’à ce que la tâche se termine. Pour plus d’informations, consultez Task. Wait et « Inline » dans le blog Parallel Programming with .net (en anglais).

Voir aussi

S’applique à