Para ver el artículo en inglés, active la casilla Inglés. También puede ver el texto en inglés en una ventana emergente si pasa el puntero del mouse por el texto.
Traducción
Inglés

TPL and Traditional .NET Framework Asynchronous Programming

.NET Framework (current version)
 

.NET Framework proporciona los siguientes dos modelos estándar para realizar las operaciones asincrónicas enlazadas a E/S y enlazadas a cálculos:

  • Modelo de programación asincrónica (APM), en el que las operaciones asincrónicas se representan mediante un par de métodos Begin/End como FileStream.BeginRead y Stream.EndRead.

  • Patrón asincrónico basado en eventos (EAP) en el que las operaciones asincrónicas se representan mediante un par método-evento que se denomina OperationNameAsync y OperationNameCompleted, por ejemplo, WebClient.DownloadStringAsync y WebClient.DownloadStringCompleted. (EAP apareció por primera vez en .NET Framework versión 2.0).

La biblioteca TPL (Task Parallel Library, biblioteca de procesamiento paralelo basado en tareas) se puede usar de varias maneras junto con cualquiera de los modelos asincrónicos. Puede exponer las operaciones de APM y EAP como tareas a los consumidores de la biblioteca o puede exponer los modelos de APM, pero usar objetos de tarea para implementarlos internamente. En ambos escenarios, al usar los objetos de tarea, puede simplificar el código y aprovechar la siguiente funcionalidad útil:

  • Registre las devoluciones de llamada, en el formulario de continuaciones de la tarea, en cualquier momento después de que se haya iniciado la tarea.

  • Coordine varias operaciones que se ejecutan en respuesta a un método Begin_, mediante los métodos ContinueWhenAll, ContinueWhenAny, WaitAll o WaitAny.

  • Encapsule las operaciones asincrónicas enlazadas a E/S y enlazadas a cálculos en el mismo objeto de tarea.

  • Supervise el estado del objeto de tarea.

  • Calcule las referencias del estado una operación para un objeto de tarea mediante TaskCompletionSource<TResult>.

Las clases System.Threading.Tasks.TaskFactory y System.Threading.Tasks.TaskFactory<TResult> proporcionan varias sobrecargas de los métodosTaskFactory.FromAsync yTaskFactory<TResult>.FromAsyncque permiten encapsular un par de métodos Begin/End en una instancia Task o Task<TResult>. Las diversas sobrecargas hospedan cualquier par de métodos de Begin/End que tenga entre cero y tres parámetros de entrada.

Para los pares que tienen métodos End que devuelven un valor (Function en Visual Basic), use los métodos de TaskFactory<TResult> que crean un objeto Task<TResult>. Para los métodos End que devuelven un valor void (Sub en Visual Basic), use los métodos de TaskFactory que crean un objeto Task.

En los pocos casos en los que el método Begin tiene más de tres parámetros o contiene parámetros ref o out, se proporcionan las sobrecargas FromAsync adicionales que encapsulan sólo el método End.

En el ejemplo siguiente, se muestra la signatura para la sobrecarga FromAsync que coincide con los métodos FileStream.BeginRead y FileStream.EndRead. Esta sobrecarga toma los tres parámetros de entrada siguientes.

public Task<TResult> FromAsync<TArg1, TArg2, TArg3>(
    Func<TArg1, TArg2, TArg3, AsyncCallback, object, IAsyncResult> beginMethod, //BeginRead
     Func<IAsyncResult, TResult> endMethod, //EndRead
     TArg1 arg1, // the byte[] buffer
     TArg2 arg2, // the offset in arg1 at which to start writing data
     TArg3 arg3, // the maximum number of bytes to read
     object state // optional state information
    ) 

El primer parámetro es un delegado Func<T1, T2, T3, T4, T5, TResult> que coincide con la signatura del método FileStream.BeginRead. El segundo parámetro es un delegado Func<T, TResult> que toma una interfaz IAsyncResult y devuelve TResult. Dado que EndRead devuelve un entero, el compilador deduce el tipo de TResult como Int32 y el tipo de la tarea como Task. Los últimos cuatro parámetros son idénticos a los del método FileStream.BeginRead:

  • Búfer donde se van a almacenar los datos de archivo.

  • Desplazamiento en el búfer donde deben comenzar a escribirse los datos.

  • Cantidad máxima de datos que se van a leer del archivo.

  • Un objeto opcional que almacena los datos de estado definidos por el usuario que se van a pasar a la devolución de llamada.

Si necesita obtener acceso a los datos del archivo, en contraposición a solo el número de bytes, el método FromAsync no es suficiente. En su ligar, use Task, cuya propiedad Result contiene los datos de archivo. Puede hacer si agrega una continuación a la tarea original. La continuación realiza el trabajo que normalmente realizaría el delegado AsyncCallback. Se invoca cuando se completa el antecedente y se ha rellenado el búfer de datos. (El objeto FileStream se debería cerrar antes de devolver un valor).

En el siguiente ejemplo se muestra cómo devolver un objeto Task que encapsula el par BeginRead/EndRead de la clase FileStream.

const int MAX_FILE_SIZE = 14000000;
public static Task<string> GetFileStringAsync(string path)
{
    FileInfo fi = new FileInfo(path);
    byte[] data = null;
    data = new byte[fi.Length];

    FileStream fs = new FileStream(path, FileMode.Open, FileAccess.Read, FileShare.Read, data.Length, true);

    //Task<int> returns the number of bytes read
    Task<int> task = Task<int>.Factory.FromAsync(
            fs.BeginRead, fs.EndRead, data, 0, data.Length, null);

    // It is possible to do other work here while waiting
    // for the antecedent task to complete.
    // ...

    // Add the continuation, which returns a Task<string>. 
    return task.ContinueWith((antecedent) =>
    {
        fs.Close();

        // Result = "number of bytes read" (if we need it.)
        if (antecedent.Result < 100)
        {
            return "Data is too small to bother with.";
        }
        else
        {
            // If we did not receive the entire file, the end of the
            // data buffer will contain garbage.
            if (antecedent.Result < data.Length)
                Array.Resize(ref data, antecedent.Result);

            // Will be returned in the Result property of the Task<string>
            // at some future point after the asynchronous file I/O operation completes.
            return new UTF8Encoding().GetString(data);
        }
    });
}

A continuación, se puede llamar al método de la forma siguiente.


Task<string> t = GetFileStringAsync(path);          

// Do some other work:
// ...

try
{
     Console.WriteLine(t.Result.Substring(0, 500));
}
catch (AggregateException ae)
{
    Console.WriteLine(ae.InnerException.Message);
}            

En las operaciones IAsyncResult típicas, si el delegado AsyncCallback requiere algún dato de estado personalizado, tiene que pasarlo a través del último parámetro Begin para que los datos se puedan empaquetar en el objeto IAsyncResult que se pasará finalmente al método de devolución de llamada. Normalmente no se requiere esto cuando se usan los métodos FromAsync. Si los datos personalizados son conocidos para la continuación, se pueden capturar directamente en el delegado de continuación. El siguiente ejemplo se parece el ejemplo anterior, pero en lugar de examinar la propiedad Result del antecedente, la continuación examina los datos de estado personalizados que son directamente accesibles al delegado de usuario de la continuación.

public Task<string> GetFileStringAsync2(string path)
{             
    FileInfo fi = new FileInfo(path);
    byte[] data = new byte[fi.Length];                       
    MyCustomState state = GetCustomState();
    FileStream fs = new FileStream(path, FileMode.Open, FileAccess.Read, FileShare.Read, data.Length, true);
    // We still pass null for the last parameter because
    // the state variable is visible to the continuation delegate.
    Task<int> task = Task<int>.Factory.FromAsync(
            fs.BeginRead, fs.EndRead, data, 0, data.Length, null);

    return task.ContinueWith((antecedent) =>
    {
        // It is safe to close the filestream now.
        fs.Close();

        // Capture custom state data directly in the user delegate.
        // No need to pass it through the FromAsync method.
        if (state.StateData.Contains("New York, New York"))
        {
            return "Start spreading the news!";
        }
        else
        {
            // If we did not receive the entire file, the end of the
            // data buffer will contain garbage.
            if (antecedent.Result < data.Length)
                Array.Resize(ref data, antecedent.Result);

            // Will be returned in the Result property of the Task<string>
            // at some future point after the asynchronous file I/O operation completes.
            return new UTF8Encoding().GetString(data);
        }
    });

}

Los métodos estáticos ContinueWhenAll y ContinueWhenAny proporcionan flexibilidad adicional cuando se usan junto con los métodos FromAsync. El siguiente ejemplo muestra cómo iniciar varias operaciones asincrónicas de E/S y, a continuación, espera a que todos ellas se completen antes de ejecutar la continuación.

public Task<string> GetMultiFileData(string[] filesToRead)
{
    FileStream fs;
    Task<string>[] tasks = new Task<string>[filesToRead.Length];
    byte[] fileData = null;
    for (int i = 0; i < filesToRead.Length; i++)
    {
        fileData = new byte[0x1000];
        fs = new FileStream(filesToRead[i], FileMode.Open, FileAccess.Read, FileShare.Read, fileData.Length, true);

        // By adding the continuation here, the 
        // Result of each task will be a string.
        tasks[i] = Task<int>.Factory.FromAsync(
                 fs.BeginRead, fs.EndRead, fileData, 0, fileData.Length, null)
                 .ContinueWith((antecedent) =>
                     {
                         fs.Close();

                         // If we did not receive the entire file, the end of the
                         // data buffer will contain garbage.
                         if (antecedent.Result < fileData.Length)
                             Array.Resize(ref fileData, antecedent.Result);

                         // Will be returned in the Result property of the Task<string>
                         // at some future point after the asynchronous file I/O operation completes.
                         return new UTF8Encoding().GetString(fileData);
                     });
    }

    // Wait for all tasks to complete. 
    return Task<string>.Factory.ContinueWhenAll(tasks, (data) =>
    {
        // Propagate all exceptions and mark all faulted tasks as observed.
        Task.WaitAll(data);

        // Combine the results from all tasks.
        StringBuilder sb = new StringBuilder();
        foreach (var t in data)
        {
            sb.Append(t.Result);
        }
        // Final result to be returned eventually on the calling thread.
        return sb.ToString();
    });

}

En los pocos casos en los que el método Begin requiere más de tres parámetros de entrada o tiene parámetros ref o out, puede usar las sobrecargas FromAsync, por ejemplo, TaskFactory<TResult>.FromAsync(IAsyncResult, Func<IAsyncResult, TResult>), que representa sólo el método End. Estos métodos también se pueden usar en cualquier escenario en el que se pasa IAsyncResult y desea encapsularlo en una tarea.

static Task<String> ReturnTaskFromAsyncResult()
{
    IAsyncResult ar = DoSomethingAsynchronously();
    Task<String> t = Task<string>.Factory.FromAsync(ar, _ =>
        {
            return (string)ar.AsyncState;
        });

    return t;
}

La tarea devuelta por un método FromAsync tiene un estado de WaitingForActivation y la iniciará el sistema en algún momento una vez creada la tarea. Si intenta llamar a Start en este tipo de tarea, se producirá una excepción.

No puede cancelar una tarea FromAsync, porque las API subyacentes de .NET Framework admiten actualmente la cancelación en curso del la E/S de archivo o red. Puede agregar la funcionalidad de cancelación a un método que encapsula una llamada FromAsync, pero sólo puede responder a la cancelación antes de que se llame a FromAsync o después de completar (por ejemplo, en una tarea de continuación).

Algunas clases que admiten EAP, por ejemplo, WebClient, admiten la cancelación y esa funcionalidad de cancelación nativa se puede integrar mediante los tokens de cancelación.

La TPL no proporciona ningún método diseñado específicamente para encapsular una operación asincrónica basada en eventos del mismo modo que la familia de métodos FromAsync ajusta el modelo IAsyncResult. Sin embargo, TPL proporciona la clase System.Threading.Tasks.TaskCompletionSource<TResult>, que se puede usar para representar cualquier conjunto arbitrario de operaciones como Task<TResult>. Las operaciones pueden ser sincrónicas o asincrónicas y pueden ser enlazadas a E/S o enlazadas a cálculo, o ambos.

En el siguiente ejemplo se muestra cómo usar TaskCompletionSource<TResult> para exponer un conjunto de operaciones WebClient asincrónicas al código de cliente como un objeto Task<TResult> básico. El método permite escribir una matriz de direcciones URL de web y un término o nombre que se va a buscar y, a continuación, devuelve el número de veces que aparece el término de búsqueda en cada sitio.

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

public class SimpleWebExample
{
  public Task<string[]> GetWordCountsSimplified(string[] urls, string name,
                                                CancellationToken token)
  {
      TaskCompletionSource<string[]> tcs = new TaskCompletionSource<string[]>();
      WebClient[] webClients = new WebClient[urls.Length];
      object m_lock = new object();
      int count = 0;
      List<string> results = new List<string>();

      // If the user cancels the CancellationToken, then we can use the
      // WebClient's ability to cancel its own async operations.
      token.Register(() =>
      {
          foreach (var wc in webClients)
          {
              if (wc != null)
                  wc.CancelAsync();
          }
      });


      for (int i = 0; i < urls.Length; i++)
      {
          webClients[i] = new WebClient();

          #region callback
          // Specify the callback for the DownloadStringCompleted
          // event that will be raised by this WebClient instance.
          webClients[i].DownloadStringCompleted += (obj, args) =>
          {

              // Argument validation and exception handling omitted for brevity.

              // Split the string into an array of words,
              // then count the number of elements that match
              // the search term.
              string[] words = args.Result.Split(' ');
              string NAME = name.ToUpper();
              int nameCount = (from word in words.AsParallel()
                               where word.ToUpper().Contains(NAME)
                               select word)
                              .Count();

              // Associate the results with the url, and add new string to the array that
              // the underlying Task object will return in its Result property.
              lock (m_lock)
              {
                 results.Add(String.Format("{0} has {1} instances of {2}", args.UserState, nameCount, name));

                 // If this is the last async operation to complete,
                 // then set the Result property on the underlying Task.
                 count++;
                 if (count == urls.Length)
                 {
                    tcs.TrySetResult(results.ToArray());
                 }
              }
          };
          #endregion

          // Call DownloadStringAsync for each URL.
          Uri address = null;
          address = new Uri(urls[i]);
          webClients[i].DownloadStringAsync(address, address);

      } // end for

      // Return the underlying Task. The client code
      // waits on the Result property, and handles exceptions
      // in the try-catch block there.
      return tcs.Task;
   }
}

Para obtener un ejemplo más completo, que incluye control de excepciones adicional y muestra cómo llamar al método desde el código de cliente, consulte How to: Wrap EAP Patterns in a Task.

Recuerde que TaskCompletionSource iniciará cualquier tarea creada por TaskCompletionSource<TResult> y, por consiguiente, el código de usuario no debería llamar al método Start en esa tarea.

En algunos escenarios, puede ser deseable exponer directamente el modelo IAsyncResult mediante pares de métodos Begin/End en una API. Por ejemplo, quizás desee mantener la coherencia con las API existentes o puede haber automatizado herramientas que requieren este modelo. En tales casos, puede usar las tareas para simplificar la forma en que se implementa internamente el modelo de APM.

En el siguiente ejemplo se muestra cómo usar las tareas para implementar un par de métodos Begin/End de APM para un método enlazado a cálculo de ejecución prolongada.

class Calculator
{
    public IAsyncResult BeginCalculate(int decimalPlaces, AsyncCallback ac, object state)
    {
        Console.WriteLine("Calling BeginCalculate on thread {0}", Thread.CurrentThread.ManagedThreadId);
        Task<string> f = Task<string>.Factory.StartNew(_ => Compute(decimalPlaces), state);
        if (ac != null) f.ContinueWith((res) => ac(f));
        return f;
    }

    public string Compute(int numPlaces)
    {
        Console.WriteLine("Calling compute on thread {0}", Thread.CurrentThread.ManagedThreadId);

        // Simulating some heavy work.
        Thread.SpinWait(500000000);

        // Actual implemenation left as exercise for the reader.
        // Several examples are available on the Web.
        return "3.14159265358979323846264338327950288";
    }

    public string EndCalculate(IAsyncResult ar)
    {
        Console.WriteLine("Calling EndCalculate on thread {0}", Thread.CurrentThread.ManagedThreadId);
        return ((Task<string>)ar).Result;
    }
}

public class CalculatorClient
{
    static int decimalPlaces = 12;
    public static void Main()
    {
        Calculator calc = new Calculator();
        int places = 35;

        AsyncCallback callBack = new AsyncCallback(PrintResult);
        IAsyncResult ar = calc.BeginCalculate(places, callBack, calc);

        // Do some work on this thread while the calulator is busy.
        Console.WriteLine("Working...");
        Thread.SpinWait(500000);
        Console.ReadLine();
    }

    public static void PrintResult(IAsyncResult result)
    {
        Calculator c = (Calculator)result.AsyncState;
        string piString = c.EndCalculate(result);
        Console.WriteLine("Calling PrintResult on thread {0}; result = {1}",
                    Thread.CurrentThread.ManagedThreadId, piString);
    }
}

El archivo Streamextensions.cs, en la página Ejemplos de programación en paralelo con .NET Framework 4 del sitio web de MSDN, contiene varias implementaciones de la referencia que usan los objetos de tarea para la E/S asincrónica de archivo y red.

Mostrar: