Task.WhenAll Método

Definición

Espacio de nombres:

System.Threading.Tasks

Ensamblado:

System.Runtime.dll

Crea una tarea que se completará cuando se hayan completado todas las tareas proporcionadas.

Sobrecargas

WhenAll(IEnumerable<Task>)	Crea una tarea que se completará cuando se hayan completado todos los objetos Task de una colección enumerable.
WhenAll(Task[])	Crea una tarea que se completará cuando se hayan completado todos los objetos Task de una matriz.
WhenAll<TResult>(IEnumerable<Task<TResult>>)	Crea una tarea que se completará cuando se hayan completado todos los objetos Task<TResult> de una colección enumerable.
WhenAll<TResult>(Task<TResult>[])	Crea una tarea que se completará cuando se hayan completado todos los objetos Task<TResult> de una matriz.

WhenAll(IEnumerable<Task>)

Source:

Task.cs

Crea una tarea que se completará cuando se hayan completado todos los objetos Task de una colección enumerable.

C#

public static System.Threading.Tasks.Task WhenAll (System.Collections.Generic.IEnumerable<System.Threading.Tasks.Task> tasks);

Parámetros

tasks

IEnumerable<Task>

Las tareas que se van a esperar para completarse.

Devoluciones

Task

Tarea que representa la finalización de todas las tareas proporcionadas.

Excepciones

ArgumentNullException

El argumento tasks se null.

ArgumentException

La colección tasks contenía una tarea de null.

Ejemplos

En el ejemplo siguiente se crea un conjunto de tareas que hacen ping a las direcciones URL de una matriz. Las tareas se almacenan en una colección de List<Task> que se pasa al método WhenAll(IEnumerable<Task>). Una vez que la llamada al método Wait garantiza que se hayan completado todos los subprocesos, el ejemplo examina la propiedad Task.Status para determinar si se ha defectuoso alguna tarea.

C#

using System;
using System.Collections.Generic;
using System.Net.NetworkInformation;
using System.Threading;
using System.Threading.Tasks;

public class Example
{
   public static void Main()
   {
      int failed = 0;
      var tasks = new List<Task>();
      String[] urls = { "www.adatum.com", "www.cohovineyard.com",
                        "www.cohowinery.com", "www.northwindtraders.com",
                        "www.contoso.com" };
      
      foreach (var value in urls) {
         var url = value;
         tasks.Add(Task.Run( () => { var png = new Ping();
                                     try {
                                        var reply = png.Send(url);
                                        if (! (reply.Status == IPStatus.Success)) {
                                           Interlocked.Increment(ref failed);
                                           throw new TimeoutException("Unable to reach " + url + ".");
                                        }
                                     }
                                     catch (PingException) {
                                        Interlocked.Increment(ref failed);
                                        throw;
                                     }
                                   }));
      }
      Task t = Task.WhenAll(tasks);
      try {
         t.Wait();
      }
      catch {}   

      if (t.Status == TaskStatus.RanToCompletion)
         Console.WriteLine("All ping attempts succeeded.");
      else if (t.Status == TaskStatus.Faulted)
         Console.WriteLine("{0} ping attempts failed", failed);      
   }
}
// The example displays output like the following:
//       5 ping attempts failed

Comentarios

Las sobrecargas del método WhenAll que devuelven un objeto Task suelen llamarse cuando está interesado en el estado de un conjunto de tareas o en las excepciones producidas por un conjunto de tareas.

Nota

La llamada a WhenAll(IEnumerable<Task>) método no bloquea el subproceso que realiza la llamada.

Si alguna de las tareas proporcionadas se completa en un estado defectuoso, la tarea devuelta también se completará en un estado de Faulted, donde sus excepciones contendrán la agregación del conjunto de excepciones desencapsuladas de cada una de las tareas proporcionadas.

Si no se ha producido ningún error en las tareas proporcionadas, pero al menos se canceló una de ellas, la tarea devuelta finalizará en el estado de Canceled.

Si no se ha producido ningún error en ninguna de las tareas y ninguna de las tareas se canceló, la tarea resultante finalizará en el estado RanToCompletion.

Si la matriz o enumerable proporcionada no contiene ninguna tarea, la tarea devuelta pasará inmediatamente a un estado de RanToCompletion antes de que se devuelva al autor de la llamada.

WhenAll(Task[])

Source:

Task.cs

Crea una tarea que se completará cuando se hayan completado todos los objetos Task de una matriz.

C#

public static System.Threading.Tasks.Task WhenAll (params System.Threading.Tasks.Task[] tasks);

Parámetros

tasks

Task[]

Las tareas que se van a esperar para completarse.

Devoluciones

Task

Tarea que representa la finalización de todas las tareas proporcionadas.

Excepciones

ArgumentNullException

El argumento tasks se null.

ArgumentException

La matriz tasks contenía una tarea de null.

Ejemplos

En el ejemplo siguiente se crea un conjunto de tareas que hacen ping a las direcciones URL de una matriz. Las tareas se almacenan en una colección de List<Task> que se convierte en una matriz y se pasan al método WhenAll(IEnumerable<Task>). Una vez que la llamada al método Wait garantiza que se hayan completado todos los subprocesos, el ejemplo examina la propiedad Task.Status para determinar si se ha defectuoso alguna tarea.

C#

using System;
using System.Collections.Generic;
using System.Net.NetworkInformation;
using System.Threading;
using System.Threading.Tasks;

public class Example
{
   public static async Task Main()
   {
      int failed = 0;
      var tasks = new List<Task>();
      String[] urls = { "www.adatum.com", "www.cohovineyard.com",
                        "www.cohowinery.com", "www.northwindtraders.com",
                        "www.contoso.com" };
      
      foreach (var value in urls) {
         var url = value;
         tasks.Add(Task.Run( () => { var png = new Ping();
                                     try {
                                        var reply = png.Send(url);
                                        if (! (reply.Status == IPStatus.Success)) {
                                           Interlocked.Increment(ref failed);
                                           throw new TimeoutException("Unable to reach " + url + ".");
                                        }
                                     }
                                     catch (PingException) {
                                        Interlocked.Increment(ref failed);
                                        throw;
                                     }
                                   }));
      }
      Task t = Task.WhenAll(tasks.ToArray());
      try {
         await t;
      }
      catch {}   

      if (t.Status == TaskStatus.RanToCompletion)
         Console.WriteLine("All ping attempts succeeded.");
      else if (t.Status == TaskStatus.Faulted)
         Console.WriteLine("{0} ping attempts failed", failed);      
   }
}
// The example displays output like the following:
//       5 ping attempts failed

Comentarios

Las sobrecargas del método WhenAll que devuelven un objeto Task suelen llamarse cuando está interesado en el estado de un conjunto de tareas o en las excepciones producidas por un conjunto de tareas.

Nota

La llamada a WhenAll(Task[]) método no bloquea el subproceso que realiza la llamada.

Si alguna de las tareas proporcionadas se completa en un estado defectuoso, la tarea devuelta también se completará en un estado de Faulted, donde sus excepciones contendrán la agregación del conjunto de excepciones desencapsuladas de cada una de las tareas proporcionadas.

Si no se ha producido ningún error en las tareas proporcionadas, pero al menos se canceló una de ellas, la tarea devuelta finalizará en el estado de Canceled.

Si no se ha producido ningún error en ninguna de las tareas y ninguna de las tareas se canceló, la tarea resultante finalizará en el estado RanToCompletion.

Si la matriz o enumerable proporcionada no contiene ninguna tarea, la tarea devuelta pasará inmediatamente a un estado de RanToCompletion antes de que se devuelva al autor de la llamada.

WhenAll<TResult>(IEnumerable<Task<TResult>>)

Source:

Task.cs

Crea una tarea que se completará cuando se hayan completado todos los objetos Task<TResult> de una colección enumerable.

C#

public static System.Threading.Tasks.Task<TResult[]> WhenAll<TResult> (System.Collections.Generic.IEnumerable<System.Threading.Tasks.Task<TResult>> tasks);

Parámetros de tipo

TResult

Tipo de la tarea completada.

Parámetros

tasks

IEnumerable<Task<TResult>>

Las tareas que se van a esperar para completarse.

Devoluciones

Task<TResult[]>

Tarea que representa la finalización de todas las tareas proporcionadas.

Excepciones

ArgumentNullException

El argumento tasks se null.

ArgumentException

La colección tasks contenía una tarea de null.

Ejemplos

En el ejemplo siguiente se crean diez tareas, cada una de las cuales crea una instancia de un generador de números aleatorios que crea 1000 números aleatorios entre 1 y 1000 y calcula su media. El método Delay(Int32) se usa para retrasar la creación de instancias de los generadores de números aleatorios para que no se creen con valores de inicialización idénticos. La llamada al método WhenAll devuelve una matriz Int64 que contiene la media calculada por cada tarea. A continuación, se usan para calcular la media global.

C#

using System;
using System.Collections.Generic;
using System.Threading.Tasks;

public class Example
{
   public static void Main()
   {
      var tasks = new List<Task<long>>();
      for (int ctr = 1; ctr <= 10; ctr++) {
         int delayInterval = 18 * ctr;
         tasks.Add(Task.Run(async () => { long total = 0;
                                          await Task.Delay(delayInterval);
                                          var rnd = new Random();
                                          // Generate 1,000 random numbers.
                                          for (int n = 1; n <= 1000; n++)
                                             total += rnd.Next(0, 1000);
                                          return total; } ));
      }
      var continuation = Task.WhenAll(tasks);
      try {
         continuation.Wait();
      }
      catch (AggregateException)
      { }
   
      if (continuation.Status == TaskStatus.RanToCompletion) {
         long grandTotal = 0;
         foreach (var result in continuation.Result) {
            grandTotal += result;
            Console.WriteLine("Mean: {0:N2}, n = 1,000", result/1000.0);
         }
   
         Console.WriteLine("\nMean of Means: {0:N2}, n = 10,000",
                           grandTotal/10000);
      }
      // Display information on faulted tasks.
      else {
         foreach (var t in tasks) {
            Console.WriteLine("Task {0}: {1}", t.Id, t.Status);
         }
      }
   }
}
// The example displays output like the following:
//       Mean: 506.34, n = 1,000
//       Mean: 504.69, n = 1,000
//       Mean: 489.32, n = 1,000
//       Mean: 505.96, n = 1,000
//       Mean: 515.31, n = 1,000
//       Mean: 499.94, n = 1,000
//       Mean: 496.92, n = 1,000
//       Mean: 508.58, n = 1,000
//       Mean: 494.88, n = 1,000
//       Mean: 493.53, n = 1,000
//
//       Mean of Means: 501.55, n = 10,000

En este caso, las diez tareas individuales se almacenan en un objeto List<T>. List<T> implementa la interfaz IEnumerable<T>.

Comentarios

La llamada a WhenAll<TResult>(IEnumerable<Task<TResult>>) método no bloquea el subproceso que realiza la llamada. Sin embargo, una llamada a la propiedad de Result devuelta bloquea el subproceso que realiza la llamada.

Si alguna de las tareas proporcionadas se completa en un estado defectuoso, la tarea devuelta también se completará en un estado de Faulted, donde sus excepciones contendrán la agregación del conjunto de excepciones desencapsuladas de cada una de las tareas proporcionadas.

Si no se ha producido ningún error en las tareas proporcionadas, pero al menos se canceló una de ellas, la tarea devuelta finalizará en el estado de Canceled.

Si no se ha producido ningún error en ninguna de las tareas y ninguna de las tareas se canceló, la tarea resultante finalizará en el estado RanToCompletion. La propiedad Task<TResult>.Result de la tarea devuelta se establecerá en una matriz que contenga todos los resultados de las tareas proporcionadas en el mismo orden que se proporcionaron (por ejemplo, si la matriz de tareas de entrada contenía t1, t2, t3, la propiedad Task<TResult>.Result de la tarea de salida devolverá un TResult[] donde arr[0] == t1.Result, arr[1] == t2.Result, and arr[2] == t3.Result).

Si el argumento tasks no contiene ninguna tarea, la tarea devuelta pasará inmediatamente a un estado de RanToCompletion antes de que se devuelva al autor de la llamada. El TResult[] devuelto será una matriz de 0 elementos.

WhenAll<TResult>(Task<TResult>[])

Source:

Task.cs

Crea una tarea que se completará cuando se hayan completado todos los objetos Task<TResult> de una matriz.

C#

public static System.Threading.Tasks.Task<TResult[]> WhenAll<TResult> (params System.Threading.Tasks.Task<TResult>[] tasks);

Parámetros de tipo

TResult

Tipo de la tarea completada.

Parámetros

tasks

Task<TResult>[]

Las tareas que se van a esperar para completarse.

Devoluciones

Task<TResult[]>

Tarea que representa la finalización de todas las tareas proporcionadas.

Excepciones

ArgumentNullException

El argumento tasks se null.

ArgumentException

La matriz tasks contenía una tarea de null.

Ejemplos

En el ejemplo siguiente se crean diez tareas, cada una de las cuales crea una instancia de un generador de números aleatorios que crea 1000 números aleatorios entre 1 y 1000 y calcula su media. En este caso, las diez tareas individuales se almacenan en una matriz de Task<Int64>. El método Delay(Int32) se usa para retrasar la creación de instancias de los generadores de números aleatorios para que no se creen con valores de inicialización idénticos. La llamada al método WhenAll devuelve una matriz Int64 que contiene la media calculada por cada tarea. A continuación, se usan para calcular la media global.

C#

using System;
using System.Collections.Generic;
using System.Threading.Tasks;

public class Example
{
   public static void Main()
   {
      var tasks = new Task<long>[10];
      for (int ctr = 1; ctr <= 10; ctr++) {
         int delayInterval = 18 * ctr;
         tasks[ctr - 1] = Task.Run(async () => { long total = 0;
                                                 await Task.Delay(delayInterval);
                                                 var rnd = new Random();
                                                 // Generate 1,000 random numbers.
                                                 for (int n = 1; n <= 1000; n++)
                                                    total += rnd.Next(0, 1000);

                                                 return total; } );
      }
      var continuation = Task.WhenAll(tasks);
      try {
         continuation.Wait();
      }
      catch (AggregateException)
      {}
   
      if (continuation.Status == TaskStatus.RanToCompletion) {
         long grandTotal = 0;
         foreach (var result in continuation.Result) {
            grandTotal += result;
            Console.WriteLine("Mean: {0:N2}, n = 1,000", result/1000.0);
         }
   
         Console.WriteLine("\nMean of Means: {0:N2}, n = 10,000",
                           grandTotal/10000);
      }
      // Display information on faulted tasks.
      else { 
         foreach (var t in tasks)
            Console.WriteLine("Task {0}: {1}", t.Id, t.Status);
      }
   }
}
// The example displays output like the following:
//       Mean: 506.38, n = 1,000
//       Mean: 501.01, n = 1,000
//       Mean: 505.36, n = 1,000
//       Mean: 492.00, n = 1,000
//       Mean: 508.36, n = 1,000
//       Mean: 503.99, n = 1,000
//       Mean: 504.95, n = 1,000
//       Mean: 508.58, n = 1,000
//       Mean: 490.23, n = 1,000
//       Mean: 501.59, n = 1,000
//
//       Mean of Means: 502.00, n = 10,000

Comentarios

La llamada a WhenAll<TResult>(Task<TResult>[]) método no bloquea el subproceso que realiza la llamada. Sin embargo, una llamada a la propiedad de Result devuelta bloquea el subproceso que realiza la llamada.

Si alguna de las tareas proporcionadas se completa en un estado defectuoso, la tarea devuelta también se completará en un estado de Faulted, donde sus excepciones contendrán la agregación del conjunto de excepciones desencapsuladas de cada una de las tareas proporcionadas.

Si no se ha producido ningún error en las tareas proporcionadas, pero al menos se canceló una de ellas, la tarea devuelta finalizará en el estado de Canceled.

Si no se ha producido ningún error en ninguna de las tareas y ninguna de las tareas se canceló, la tarea resultante finalizará en el estado RanToCompletion. El Result de la tarea devuelta se establecerá en una matriz que contenga todos los resultados de las tareas proporcionadas en el mismo orden que se proporcionaron (por ejemplo, si la matriz de tareas de entrada contenía t1, t2, t3, la Result de la tarea de salida devolverá un TResult[] donde arr[0] == t1.Result, arr[1] == t2.Result, and arr[2] == t3.Result).

Si la matriz o enumerable proporcionada no contiene ninguna tarea, la tarea devuelta pasará inmediatamente a un estado de RanToCompletion antes de que se devuelva al autor de la llamada. El TResult[] devuelto será una matriz de 0 elementos.