Task Parallel Library e programmazione asincrona .NET Framework tradizionaleTPL and Traditional .NET Framework Asynchronous Programming

.NET Framework offre i due modelli standard seguenti per eseguire operazioni asincrone di solo I/O e di solo calcolo:The .NET Framework provides the following two standard patterns for performing I/O-bound and compute-bound asynchronous operations:

  • Modello di programmazione asincrono (APM, Asynchronous Programming Model), in cui le operazioni asincrone sono rappresentate da una coppia di metodi Begin/End come FileStream.BeginRead e Stream.EndRead.Asynchronous Programming Model (APM), in which asynchronous operations are represented by a pair of Begin/End methods such as FileStream.BeginRead and Stream.EndRead.

  • Modello asincrono basato su eventi (EAP, Event-based Asynchronous Pattern), in cui le operazioni asincrone sono rappresentate da una coppia metodo/evento denominati OperationNameAsync e OperationNameCompleted, ad esempio, WebClient.DownloadStringAsync e WebClient.DownloadStringCompleted.Event-based asynchronous pattern (EAP), in which asynchronous operations are represented by a method/event pair that are named OperationNameAsync and OperationNameCompleted, for example, WebClient.DownloadStringAsync and WebClient.DownloadStringCompleted. Il modello EAP è stato introdotto in .NET Framework versione 2.0.(EAP was introduced in the .NET Framework version 2.0.)

È possibile usare Task Parallel Library (TPL) in diversi modi insieme a uno dei due modelli asincroni.The Task Parallel Library (TPL) can be used in various ways in conjunction with either of the asynchronous patterns. È possibile esporre operazioni APM ed EAP come attività nei consumer della libreria oppure esporre i modelli APM ma usare oggetti Task per implementarli internamente.You can expose both APM and EAP operations as Tasks to library consumers, or you can expose the APM patterns but use Task objects to implement them internally. In entrambi gli scenari, usando oggetti Task è possibile semplificare il codice e trarre vantaggio dalle utili funzionalità seguenti:In both scenarios, by using Task objects, you can simplify the code and take advantage of the following useful functionality:

  • Registrare callback, sotto forma di continuazioni di attività, in qualsiasi momento dopo l'avvio dell'attività.Register callbacks, in the form of task continuations, at any time after the task has started.

  • Coordinare più operazioni eseguite in risposta a un metodo Begin_, usando i metodi ContinueWhenAll e ContinueWhenAny il metodo WaitAll oppure il metodo WaitAny.Coordinate multiple operations that execute in response to a Begin_ method, by using the ContinueWhenAll and ContinueWhenAny methods, or the WaitAll method or the WaitAny method.

  • Incapsulare operazioni asincrone di solo I/O e di solo calcolo nello stesso oggetto Task.Encapsulate asynchronous I/O-bound and compute-bound operations in the same Task object.

  • Monitorare lo stato dell'oggetto Task.Monitor the status of the Task object.

  • Eseguire il marshalling dello stato di un'operazione a un oggetto Task usando TaskCompletionSource<TResult>.Marshal the status of an operation to a Task object by using TaskCompletionSource<TResult>.

Wrapping di operazioni APM in un'attivitàWrapping APM Operations in a Task

Le classi System.Threading.Tasks.TaskFactory e System.Threading.Tasks.TaskFactory<TResult> forniscono entrambe diversi overload dei metodi TaskFactory.FromAsync e TaskFactory<TResult>.FromAsync, che permettono di incapsulare una coppia di metodi Begin/End APM in un'unica istanza di Task o Task<TResult>.Both the System.Threading.Tasks.TaskFactory and System.Threading.Tasks.TaskFactory<TResult> classes provide several overloads of the TaskFactory.FromAsync and TaskFactory<TResult>.FromAsync methods that let you encapsulate an APM Begin/End method pair in one Task or Task<TResult> instance. I diversi overload si adattano a qualsiasi coppia di metodi Begin/End che include da zero a tre parametri di input.The various overloads accommodate any Begin/End method pair that have from zero to three input parameters.

Per le coppie con metodi End che restituiscono un valore (Function in Visual Basic), usare i metodi in TaskFactory<TResult>, che creano un oggetto Task<TResult>.For pairs that have End methods that return a value (Function in Visual Basic), use the methods in TaskFactory<TResult> that create a Task<TResult>. Per i metodi End che restituiscono void (Sub in Visual Basic), usare i metodi in TaskFactory, che creano un oggetto Task.For End methods that return void (Sub in Visual Basic), use the methods in TaskFactory that create a Task.

Per i pochi casi in cui il metodo Begin include più di tre parametri o contiene parametri ref o out, sono disponibili overload FromAsync aggiuntivi che incapsulano solo il metodo End.For those few cases in which the Begin method has more than three parameters or contains ref or out parameters, additional FromAsync overloads that encapsulate only the End method are provided.

L'esempio seguente mostra la firma per l'overload FromAsync che corrisponde ai metodi FileStream.BeginRead e FileStream.EndRead.The following example shows the signature for the FromAsync overload that matches the FileStream.BeginRead and FileStream.EndRead methods. Questo overload accetta i tre parametri di input seguenti.This overload takes three input parameters, as follows.

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
    ) 
Public Function FromAsync(Of TArg1, TArg2, TArg3)(
                ByVal beginMethod As Func(Of TArg1, TArg2, TArg3, AsyncCallback, Object, IAsyncResult),
                ByVal endMethod As Func(Of IAsyncResult, TResult),
                ByVal dataBuffer As TArg1,
                ByVal byteOffsetToStartAt As TArg2,
                ByVal maxBytesToRead As TArg3,
                ByVal stateInfo As Object)

Il primo parametro è un delegato Func<T1,T2,T3,T4,T5,TResult> che corrisponde alla firma del metodo FileStream.BeginRead.The first parameter is a Func<T1,T2,T3,T4,T5,TResult> delegate that matches the signature of the FileStream.BeginRead method. Il secondo parametro è un delegato Func<T,TResult> che accetta un oggetto IAsyncResult e restituisce un valore TResult.The second parameter is a Func<T,TResult> delegate that takes an IAsyncResult and returns a TResult. Poiché EndRead restituisce un numero intero, il compilatore deduce il tipo di TResult come Int32 e il tipo dell'attività come Task.Because EndRead returns an integer, the compiler infers the type of TResult as Int32 and the type of the task as Task. Gli ultimi quattro parametri sono identici a quelli nel metodo FileStream.BeginRead:The last four parameters are identical to those in the FileStream.BeginRead method:

  • Buffer in cui archiviare i dati del file.The buffer in which to store the file data.

  • Offset nel buffer in corrispondenza del quale iniziare a scrivere dati.The offset in the buffer at which to begin writing data.

  • Quantità massima di dati da leggere dal file.The maximum amount of data to read from the file.

  • Oggetto facoltativo che archivia dati di stato definiti dall'utente da passare al callback.An optional object that stores user-defined state data to pass to the callback.

Uso di ContinueWith per la funzionalità di callbackUsing ContinueWith for the Callback Functionality

Se è necessario accedere ai dati nel file e non soltanto al numero di byte, il metodo FromAsync non è sufficiente.If you require access to the data in the file, as opposed to just the number of bytes, the FromAsync method is not sufficient. Usare invece Task, la cui proprietà Result contiene i dati del file.Instead, use Task, whose Result property contains the file data. A questo scopo, è possibile aggiungere una continuazione all'attività originale.You can do this by adding a continuation to the original task. La continuazione esegue le operazioni svolte in genere dal delegato AsyncCallback.The continuation performs the work that would typically be performed by the AsyncCallback delegate. La continuazione viene richiamata al termine dell'attività precedente e dopo che il buffer di dati è stato completato.It is invoked when the antecedent completes, and the data buffer has been filled. L'oggetto FileStream deve essere chiuso prima della restituzione.(The FileStream object should be closed before returning.)

L'esempio seguente mostra come restituire un oggetto Task che incapsula la coppia BeginRead/EndRead della classe FileStream.The following example shows how to return a Task that encapsulates the BeginRead/EndRead pair of the FileStream class.

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);
        }
    });
}
Const MAX_FILE_SIZE As Integer = 14000000
Shared Function GetFileStringAsync(ByVal path As String) As Task(Of String)
    Dim fi As New FileInfo(path)
    Dim data(fi.Length) As Byte

    Dim fs As FileStream = New FileStream(path, FileMode.Open, FileAccess.Read, FileShare.Read, data.Length, True)

    ' Task(Of Integer) returns the number of bytes read
    Dim myTask As Task(Of Integer) = Task(Of Integer).Factory.FromAsync(
        AddressOf fs.BeginRead, AddressOf fs.EndRead, data, 0, data.Length, Nothing)

    ' 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 myTask.ContinueWith(Function(antecedent)
                                   fs.Close()
                                   If (antecedent.Result < 100) Then
                                       Return "Data is too small to bother with."
                                   End If
                                   ' If we did not receive the entire file, the end of the
                                   ' data buffer will contain garbage.
                                   If (antecedent.Result < data.Length) Then
                                       Array.Resize(data, antecedent.Result)
                                   End If

                                   ' 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)
                               End Function)

End Function

Il metodo può quindi essere chiamato nel modo seguente.The method can then be called, as follows.


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);
}            
Dim myTask As Task(Of String) = GetFileStringAsync(path)

' Do some other work
' ...

Try
    Console.WriteLine(myTask.Result.Substring(0, 500))
Catch ex As AggregateException
    Console.WriteLine(ex.InnerException.Message)
End Try

Fornire dati di stato personalizzatiProviding Custom State Data

Nelle tipiche operazioni IAsyncResult se il delegato AsyncCallback richiede dati di stato, è necessario passarli attraverso l'ultimo parametro nel metodo Begin, in modo che sia possibile creare un pacchetto dei dati nell'oggetto IAsyncResult, che viene infine passato al metodo di callback.In typical IAsyncResult operations, if your AsyncCallback delegate requires some custom state data, you have to pass it in through the last parameter in the Begin method, so that the data can be packaged into the IAsyncResult object that is eventually passed to the callback method. Questo approccio non è in genere necessario quando si usano i metodi FromAsync.This is typically not required when the FromAsync methods are used. Se i dati personalizzati sono noti alla continuazione, possono essere acquisiti direttamente nel delegato della continuazione.If the custom data is known to the continuation, then it can be captured directly in the continuation delegate. L'esempio seguente assomiglia a quello precedente, ma invece di esaminare la proprietà Result dell'attività precedente, la continuazione esamina i dati di stato personalizzati, cui il delegato dell'utente della continuazione può accedere direttamente.The following example resembles the previous example, but instead of examining the Result property of the antecedent, the continuation examines the custom state data that is directly accessible to the user delegate of the continuation.

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);
        }
    });
    
}
Public Function GetFileStringAsync2(ByVal path As String) As Task(Of String)
    Dim fi = New FileInfo(path)
    Dim data(fi.Length) As Byte
    Dim state As New MyCustomState()

    Dim fs As 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.
    Dim myTask As Task(Of Integer) = Task(Of Integer).Factory.FromAsync(
            AddressOf fs.BeginRead, AddressOf fs.EndRead, data, 0, data.Length, Nothing)

    Return myTask.ContinueWith(Function(antecedent)
                                   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")) Then
                                       Return "Start spreading the news!"
                                   End If

                                   ' If we did not receive the entire file, the end of the
                                   ' data buffer will contain garbage.
                                   If (antecedent.Result < data.Length) Then
                                       Array.Resize(data, antecedent.Result)
                                   End If
                                   '/ 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)
                               End Function)

End Function

Sincronizzazione di più attività FromAsyncSynchronizing Multiple FromAsync Tasks

I metodi statici ContinueWhenAll e ContinueWhenAny offrono flessibilità aggiunta se vengono usati insieme ai metodi FromAsync.The static ContinueWhenAll and ContinueWhenAny methods provide added flexibility when used in conjunction with the FromAsync methods. L'esempio seguente mostra come avviare più operazioni di I/O asincrone e quindi attenderne il completamento prima di eseguire la continuazione.The following example shows how to initiate multiple asynchronous I/O operations, and then wait for all of them to complete before you execute the continuation.

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();
    });

}
Public Function GetMultiFileData(ByVal filesToRead As String()) As Task(Of String)
    Dim fs As FileStream
    Dim tasks(filesToRead.Length) As Task(Of String)
    Dim fileData() As Byte = Nothing
    For i As Integer = 0 To filesToRead.Length
        fileData(&H1000) = New Byte()
        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(Of Integer).Factory.FromAsync(AddressOf fs.BeginRead,
                                                      AddressOf fs.EndRead,
                                                      fileData,
                                                      0,
                                                      fileData.Length,
                                                      Nothing).
                                                  ContinueWith(Function(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) Then
                                                                       ReDim Preserve fileData(antecedent.Result)
                                                                   End If

                                                                   '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)
                                                               End Function)
    Next

    Return Task(Of String).Factory.ContinueWhenAll(tasks, Function(data)

                                                              ' Propagate all exceptions and mark all faulted tasks as observed.
                                                              Task.WaitAll(data)

                                                              ' Combine the results from all tasks.
                                                              Dim sb As New StringBuilder()
                                                              For Each t As Task(Of String) In data
                                                                  sb.Append(t.Result)
                                                              Next
                                                              ' Final result to be returned eventually on the calling thread.
                                                              Return sb.ToString()
                                                          End Function)
End Function

Attività FromAsync solo per il metodo EndFromAsync Tasks For Only the End Method

Per i pochi casi in cui il metodo Begin richiede più di tre parametri di input o include parametri ref o out, è possibile usare gli overload FromAsync, ad esempio TaskFactory<TResult>.FromAsync(IAsyncResult, Func<IAsyncResult,TResult>), che rappresentano solo il metodo End.For those few cases in which the Begin method requires more than three input parameters, or has ref or out parameters, you can use the FromAsync overloads, for example, TaskFactory<TResult>.FromAsync(IAsyncResult, Func<IAsyncResult,TResult>), that represent only the End method. Questi metodi possono essere usati anche in qualsiasi scenario in cui viene passato un oggetto IAsyncResult e si vuole incapsularlo in un'attività.These methods can also be used in any scenario in which you are passed an IAsyncResult and want to encapsulate it in a Task.

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

    return t;
}
Shared Function ReturnTaskFromAsyncResult() As Task(Of String)
    Dim ar As IAsyncResult = DoSomethingAsynchronously()
    Dim t As Task(Of String) = Task(Of String).Factory.FromAsync(ar, Function(res) CStr(res.AsyncState))
    Return t
End Function

Avvio e annullamento di attività FromAsyncStarting and Canceling FromAsync Tasks

L'attività restituita da un metodo FromAsync ha lo stato WaitingForActivation e verrà avviata dal sistema in un determinato momento al termine della sua creazione.The task returned by a FromAsync method has a status of WaitingForActivation and will be started by the system at some point after the task is created. Se si tenta di chiamare Start su questa attività, viene generata un'eccezione.If you attempt to call Start on such a task, an exception will be raised.

Non è possibile annullare un'attività FromAsync, perché le API di .NET Framework sottostanti non supportano l'annullamento in corso di operazioni di I/O su file o di rete.You cannot cancel a FromAsync task, because the underlying .NET Framework APIs currently do not support in-progress cancellation of file or network I/O. È possibile aggiungere la funzionalità di annullamento a un metodo che incapsula una chiamata di FromAsync, ma è possibile rispondere all'annullamento prima che FromAsync venga chiamato o dopo il suo completamento, ad esempio in un'attività di continuazione.You can add cancellation functionality to a method that encapsulates a FromAsync call, but you can only respond to the cancellation before FromAsync is called or after it completed (for example, in a continuation task).

Alcune classi che supportano il modello EAP, ad esempio WebClient, supportano l'annullamento ed è possibile integrare questa funzionalità di annullamento nativa usando token di annullamento.Some classes that support EAP, for example, WebClient, do support cancellation, and you can integrate that native cancellation functionality by using cancellation tokens.

Esposizione di operazioni EAP complesse come attivitàExposing Complex EAP Operations As Tasks

TPL non fornisce alcun metodo progettato in modo specifico per incapsulare un'operazione asincrona basata su eventi allo stesso modo in cui la famiglia di metodi FromAsync esegue il wrapping del modello IAsyncResult.The TPL does not provide any methods that are specifically designed to encapsulate an event-based asynchronous operation in the same way that the FromAsync family of methods wrap the IAsyncResult pattern. Tuttavia, TPL fornisce la classe System.Threading.Tasks.TaskCompletionSource<TResult>, che può essere usata per rappresentare qualsiasi set arbitrario di operazioni come Task<TResult>.However, the TPL does provide the System.Threading.Tasks.TaskCompletionSource<TResult> class, which can be used to represent any arbitrary set of operations as a Task<TResult>. Le operazioni possono essere sincrone o asincrone di solo I/O o di solo calcolo, o di entrambi i tipi.The operations may be synchronous or asynchronous, and may be I/O bound or compute-bound, or both.

L'esempio seguente mostra come usare un oggetto TaskCompletionSource<TResult> per esporre un set di operazioni WebClient asincrone al codice client come Task<TResult> di base.The following example shows how to use a TaskCompletionSource<TResult> to expose a set of asynchronous WebClient operations to client code as a basic Task<TResult>. Il metodo permette di immettere una matrice di URL Web e un termine o un nome da cercare e quindi restituisce il numero di volte in cui il termine di ricerca è presente in ogni sito.The method lets you enter an array of Web URLs, and a term or name to search for, and then returns the number of times the search term occurs on each site.

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;
   }
}
Imports System.Collections.Generic
Imports System.Net
Imports System.Threading
Imports System.Threading.Tasks

Public Class SimpleWebExample
   Dim tcs As New TaskCompletionSource(Of String())
   Dim token As CancellationToken
   Dim results As New List(Of String)
   Dim m_lock As New Object()
   Dim count As Integer
   Dim addresses() As String
   Dim nameToSearch As String
   
   Public Function GetWordCountsSimplified(ByVal urls() As String, ByVal str As String,
                                           ByVal token As CancellationToken) As Task(Of String())
      addresses = urls
      nameToSearch = str
      
      Dim webClients(urls.Length - 1) As WebClient

      ' If the user cancels the CancellationToken, then we can use the
      ' WebClient's ability to cancel its own async operations.
      token.Register(Sub()
                        For Each wc As WebClient In webClients
                           If wc IsNot Nothing Then
                              wc.CancelAsync()
                           End If
                        Next
                     End Sub)

      For i As Integer = 0 To urls.Length - 1
         webClients(i) = New WebClient()

         ' Specify the callback for the DownloadStringCompleted
         ' event that will be raised by this WebClient instance.
         AddHandler webClients(i).DownloadStringCompleted, AddressOf WebEventHandler

         Dim address As New Uri(urls(i))
         ' Pass the address, and also use it for the userToken
         ' to identify the page when the delegate is invoked.
         webClients(i).DownloadStringAsync(address, address)
      Next

      ' Return the underlying Task. The client code
      ' waits on the Result property, and handles exceptions
      ' in the try-catch block there.
      Return tcs.Task
   End Function

   Public Sub WebEventHandler(ByVal sender As Object, ByVal args As DownloadStringCompletedEventArgs)

      If args.Cancelled = True Then
         tcs.TrySetCanceled()
         Return
      ElseIf args.Error IsNot Nothing Then
         tcs.TrySetException(args.Error)
         Return
      Else
         ' Split the string into an array of words,
         ' then count the number of elements that match
         ' the search term.
         Dim words() As String = args.Result.Split(" "c)

         Dim name As String = nameToSearch.ToUpper()
         Dim 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.
         SyncLock (m_lock)
            results.Add(String.Format("{0} has {1} instances of {2}", args.UserState, nameCount, nameToSearch))
            count = count + 1
            If (count = addresses.Length) Then
               tcs.TrySetResult(results.ToArray())
            End If
         End SyncLock
      End If
   End Sub
End Class

Per un esempio più completo, che include gestione aggiuntiva delle eccezioni e mostra come chiamare il metodo dal codice client, vedere Procedura: Eseguire il wrapping di modelli EAP in un'attività.For a more complete example, which includes additional exception handling and shows how to call the method from client code, see How to: Wrap EAP Patterns in a Task.

Tenere presente che qualsiasi attività creata da TaskCompletionSource<TResult> verrà avviata da TaskCompletionSource e, di conseguenza, il codice utente non deve chiamare il metodo Start sull'attività.Remember that any task that is created by a TaskCompletionSource<TResult> will be started by that TaskCompletionSource and, therefore, user code should not call the Start method on that task.

Implementazione del modello APM usando attivitàImplementing the APM Pattern By Using Tasks

In alcuni scenari può essere opportuno esporre direttamente il modello IAsyncResult usando coppie di metodi Begin/End in un'API.In some scenarios, it may be desirable to directly expose the IAsyncResult pattern by using Begin/End method pairs in an API. Ad esempio, si potrebbe voler mantenere la coerenza con le API esistenti o disporre di strumenti automatici che richiedono questo modello.For example, you may want to maintain consistency with existing APIs, or you may have automated tools that require this pattern. In questi casi, è possibile usare attività per semplificare l'implementazione interna del modello APM.In such cases, you can use Tasks to simplify how the APM pattern is implemented internally.

L'esempio seguente mostra come usare attività per implementare una coppia di metodi Begin/End APM per un metodo di solo calcolo a esecuzione prolungata.The following example shows how to use tasks to implement an APM Begin/End method pair for a long-running compute-bound method.

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);
    }
}
Class Calculator
    Public Function BeginCalculate(ByVal decimalPlaces As Integer, ByVal ac As AsyncCallback, ByVal state As Object) As IAsyncResult
        Console.WriteLine("Calling BeginCalculate on thread {0}", Thread.CurrentThread.ManagedThreadId)
        Dim myTask = Task(Of String).Factory.StartNew(Function(obj) Compute(decimalPlaces), state)
        myTask.ContinueWith(Sub(antedecent) ac(myTask))

    End Function
    Private Function Compute(ByVal decimalPlaces As Integer)
        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"
    End Function

    Public Function EndCalculate(ByVal ar As IAsyncResult) As String
        Console.WriteLine("Calling EndCalculate on thread {0}", Thread.CurrentThread.ManagedThreadId)
        Return CType(ar, Task(Of String)).Result
    End Function
End Class

Class CalculatorClient
    Shared decimalPlaces As Integer
    Shared Sub Main()
        Dim calc As New Calculator
        Dim places As Integer = 35
        Dim callback As New AsyncCallback(AddressOf PrintResult)
        Dim ar As IAsyncResult = calc.BeginCalculate(places, callback, calc)

        ' Do some work on this thread while the calulator is busy.
        Console.WriteLine("Working...")
        Thread.SpinWait(500000)
        Console.ReadLine()
    End Sub

    Public Shared Sub PrintResult(ByVal result As IAsyncResult)
        Dim c As Calculator = CType(result.AsyncState, Calculator)
        Dim piString As String = c.EndCalculate(result)
        Console.WriteLine("Calling PrintResult on thread {0}; result = {1}",
                   Thread.CurrentThread.ManagedThreadId, piString)
    End Sub

End Class

Uso del codice di esempio StreamExtensionsUsing the StreamExtensions Sample Code

Nel file Streamextensions.cs, disponibile in Samples for Parallel Programming with the .NET Framework 4 (Esempi di programmazione parallela con .NET Framework 4), sono contenute diverse implementazioni di riferimento che usano oggetti Task per l'I/O asincrono di file e di rete.The Streamextensions.cs file, in Samples for Parallel Programming with the .NET Framework 4, contains several reference implementations that use Task objects for asynchronous file and network I/O.

Vedere ancheSee Also

Task Parallel Library (TPL)Task Parallel Library (TPL)