TaskFactory<TResult> Класс

Определение

Предоставляет поддержку создания и планирования объектов Task<TResult>.Provides support for creating and scheduling Task<TResult> objects.

generic <typename TResult>
public ref class TaskFactory
public class TaskFactory<TResult>
type TaskFactory<'Result> = class
Public Class TaskFactory(Of TResult)

Параметры типа

TResult

Возвращаемое значение объектов Task<TResult>, созданных методами этого класса.The return value of the Task<TResult> objects that the methods of this class create.

Наследование
TaskFactory<TResult>

Примеры

В следующем примере свойство static Factory используется для выполнения двух вызовов метода TaskFactory<TResult>.StartNew.The following example uses the static Factory property to make two calls to the TaskFactory<TResult>.StartNew method. Первая задача возвращает массив строк, который заполняется именами файлов в каталоге MyDocuments пользователя, а второй возвращает строковый массив, который заполняется именами подкаталогов каталога MyDocuments пользователя.The first task returns a string array that is populated with the names of files in the user's MyDocuments directory, while the second returns a string array that is populated with the names of subdirectories of the user's MyDocuments directory. Затем он вызывает метод TaskFactory.ContinueWhenAll(Task[], Action<Task[]>), который отображает сведения о количестве файлов и каталогов в массивах, возвращаемых двумя задачами после завершения выполнения.It then calls the TaskFactory.ContinueWhenAll(Task[], Action<Task[]>) method, which displays information about the number of files and directories in the arrays returned by the two tasks after they have completed execution.

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

public class Example
{
   public static void Main()
   {
      Task<string[]>[] tasks = new Task<string[]>[2];
      String docsDirectory = Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments);

      tasks[0] = Task<string[]>.Factory.StartNew( () => Directory.GetFiles(docsDirectory));
      tasks[1] = Task<string[]>.Factory.StartNew( () => Directory.GetDirectories(docsDirectory));

      Task.Factory.ContinueWhenAll(tasks, completedTasks => {
                                             Console.WriteLine("{0} contains: ", docsDirectory);
                                             Console.WriteLine("   {0} subdirectories", tasks[1].Result.Length);
                                             Console.WriteLine("   {0} files", tasks[0].Result.Length);
                                          } );
   }
}
// The example displays output like the following:
//       C:\Users\<username>\Documents contains:
//          24 subdirectories
//          16 files
Imports System.IO
Imports System.Threading.Tasks

Module Example
   Public Sub Main()
      Dim tasks(1) As Task(Of String())
      Dim docsDirectory As String = Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments)
      
      tasks(0) = Task(Of String()).Factory.StartNew( Function()Directory.GetFiles(docsDirectory) )
''                                        End Sub )
      tasks(1) = Task(Of String()).Factory.StartNew( Function() Directory.GetDirectories(docsDirectory) )
''                                        End Sub )
      Task.Factory.ContinueWhenAll(tasks, Sub(completedTasks)
                                             Console.WriteLine("{0} contains: ", docsDirectory)
                                             Console.WriteLine("   {0} subdirectories", tasks(1).Result.Length)
                                             Console.WriteLine("   {0} files", tasks(0).Result.Length)
                                          End Sub)
   End Sub
End Module
' The example displays output like the following:
'       C:\Users\<username>\Documents contains:
'          24 subdirectories
'          16 files

Комментарии

.NET Framework предоставляет две фабрики для создания и планирования задач:The .NET Framework provides two factories for creating and scheduling tasks:

Класс TaskFactory<TResult> позволяет выполнять следующие действия:The TaskFactory<TResult> class allows you to do the following:

  • Создайте задачу и запустите ее немедленно, вызвав метод StartNew.Create a task and start it immediately by calling the StartNew method. Перегрузки этого метода можно вызывать для создания и выполнения задачи, для которой требуются аргументы, отличные от аргументов по умолчанию.You can call the overloads of this method to create and execute a task that requires non-default arguments.

    Предупреждение

    Начиная с .NET Framework 4.5.NET Framework 4.5, метод Task.Run предоставляет самый простой способ создать задачу со значениями конфигурации по умолчанию и немедленно запустить ее.Starting with the .NET Framework 4.5.NET Framework 4.5, the Task.Run method provides the easiest way to create a task with default configuration values and start it immediately.

  • Создайте задачу, которая запускается при завершении одной из задач в массиве путем вызова метода ContinueWhenAny или ContinueWhenAny.Create a task that starts when any one of the tasks in an array has completed by calling the ContinueWhenAny or ContinueWhenAny method.

  • Создайте задачу, которая запускается после завершения всех задач в массиве путем вызова метода ContinueWhenAll или ContinueWhenAll.Create a task that starts when all the tasks in an array have completed by calling the ContinueWhenAll or ContinueWhenAll method.

Статическое свойство Task<TResult>.Factory возвращает объект TaskFactory<TResult> по умолчанию.The static Task<TResult>.Factory property returns a default TaskFactory<TResult> object. Можно также вызвать один из конструкторов класса TaskFactory<TResult>, чтобы настроить Task<TResult> объекты, создаваемые классом TaskFactory<TResult>.You can also call one of the TaskFactory<TResult> class constructors to configure the Task<TResult> objects that the TaskFactory<TResult> class creates. В следующем примере настраивается новый объект TaskFactory<TResult> для создания задач с указанным токеном отмены, параметрами создания задач, параметрами продолжения и настраиваемым планировщиком задач.The following example configures a new TaskFactory<TResult> object to create tasks that have a specified cancellation token, task creation options, continuation options, and a customized task scheduler.

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

public class Example
{
   static CancellationTokenSource cts = new CancellationTokenSource();

   static TaskFactory<int> factory = new TaskFactory<int>(
      cts.Token,
      TaskCreationOptions.PreferFairness,
      TaskContinuationOptions.ExecuteSynchronously,
      new CustomScheduler());

   static void Main()
   {
      var t2 = factory.StartNew(() => DoWork());
      cts.Dispose();
   }

   static int DoWork()
   {
       /*...*/
       return DateTime.Now.Hour <= 12 ?  1 : 2;
    }
}
Imports System.Collections.Generic
Imports System.Threading
Imports System.Threading.Tasks

Module Example
   Public Sub Main()
      Dim cts As New CancellationTokenSource()
      Dim factory As New TaskFactory(Of Integer)(
                         cts.Token,
                         TaskCreationOptions.PreferFairness,
                         TaskContinuationOptions.ExecuteSynchronously,
                         New CustomScheduler())

      Dim t2 = factory.StartNew(Function() DoWork())
      cts.Dispose()
   End Sub

   Function DoWork() As Integer
      Return If(Date.Now.Hour <= 12, 1, 2)
   End Function
End Module

В большинстве случаев не нужно создавать экземпляр нового TaskFactory<TResult>.In most cases, you do not have to instantiate a new TaskFactory<TResult> instance. Вместо этого можно использовать статическое свойство Task<TResult>.Factory, которое возвращает объект фабрики, который использует значения по умолчанию.Instead, you can use the static Task<TResult>.Factory property, which returns a factory object that uses default values. Затем можно вызвать его методы для запуска новых задач или определения продолжений задач.You can then call its methods to start new tasks or define task continuations. Иллюстрации см. в примере.For an illustration, see the example.

Конструкторы

TaskFactory<TResult>()

Инициализирует экземпляр TaskFactory<TResult> с конфигурацией по умолчанию.Initializes a TaskFactory<TResult> instance with the default configuration.

TaskFactory<TResult>(CancellationToken)

Инициализирует экземпляр TaskFactory<TResult> с конфигурацией по умолчанию.Initializes a TaskFactory<TResult> instance with the default configuration.

TaskFactory<TResult>(CancellationToken, TaskCreationOptions, TaskContinuationOptions, TaskScheduler)

Инициализирует экземпляр TaskFactory<TResult> с заданной конфигурацией.Initializes a TaskFactory<TResult> instance with the specified configuration.

TaskFactory<TResult>(TaskCreationOptions, TaskContinuationOptions)

Инициализирует экземпляр TaskFactory<TResult> с заданной конфигурацией.Initializes a TaskFactory<TResult> instance with the specified configuration.

TaskFactory<TResult>(TaskScheduler)

Инициализирует экземпляр TaskFactory<TResult> с заданной конфигурацией.Initializes a TaskFactory<TResult> instance with the specified configuration.

Свойства

CancellationToken

Возвращает токен отмены по умолчанию для этой фабрики задач.Gets the default cancellation token for this task factory.

ContinuationOptions

Возвращает значение перечисления TaskContinuationOptions для этой фабрики задач.Gets the TaskContinuationOptions enumeration value for this task factory.

CreationOptions

Возвращает значение перечисления TaskCreationOptions для этой фабрики задач.Gets the TaskCreationOptions enumeration value for this task factory.

Scheduler

Возвращает планировщик задач для этой фабрики задач.Gets the task scheduler for this task factory.

Методы

ContinueWhenAll(Task[], Func<Task[],TResult>)

Создает задачу продолжения, которая будет запущена после выполнения набора указанных задач.Creates a continuation task that will be started upon the completion of a set of provided tasks.

ContinueWhenAll(Task[], Func<Task[],TResult>, CancellationToken)

Создает задачу продолжения, которая будет запущена после выполнения набора указанных задач.Creates a continuation task that will be started upon the completion of a set of provided tasks.

ContinueWhenAll(Task[], Func<Task[],TResult>, CancellationToken, TaskContinuationOptions, TaskScheduler)

Создает задачу продолжения, которая будет запущена после выполнения набора указанных задач.Creates a continuation task that will be started upon the completion of a set of provided Tasks.

ContinueWhenAll(Task[], Func<Task[],TResult>, TaskContinuationOptions)

Создает задачу продолжения, которая будет запущена после выполнения набора указанных задач.Creates a continuation task that will be started upon the completion of a set of provided Tasks.

ContinueWhenAll<TAntecedentResult>(Task<TAntecedentResult>[], Func<Task<TAntecedentResult>[],TResult>)

Создает задачу продолжения, которая будет запущена после выполнения набора указанных задач.Creates a continuation task that will be started upon the completion of a set of provided tasks.

ContinueWhenAll<TAntecedentResult>(Task<TAntecedentResult>[], Func<Task<TAntecedentResult>[],TResult>, CancellationToken)

Создает задачу продолжения, которая будет запущена после выполнения набора указанных задач.Creates a continuation task that will be started upon the completion of a set of provided tasks.

ContinueWhenAll<TAntecedentResult>(Task<TAntecedentResult>[], Func<Task<TAntecedentResult>[],TResult>, CancellationToken, TaskContinuationOptions, TaskScheduler)

Создает задачу продолжения, которая будет запущена после выполнения набора указанных задач.Creates a continuation task that will be started upon the completion of a set of provided tasks.

ContinueWhenAll<TAntecedentResult>(Task<TAntecedentResult>[], Func<Task<TAntecedentResult>[],TResult>, TaskContinuationOptions)

Создает задачу продолжения, которая будет запущена после выполнения набора указанных задач.Creates a continuation task that will be started upon the completion of a set of provided tasks.

ContinueWhenAny(Task[], Func<Task,TResult>)

Создает задачу продолжения, которая будет запущена после выполнения любой задачи в указанном наборе.Creates a continuation task that will be started upon the completion of any task in the provided set.

ContinueWhenAny(Task[], Func<Task,TResult>, CancellationToken)

Создает задачу продолжения, которая будет запущена после выполнения любой задачи в указанном наборе.Creates a continuation task that will be started upon the completion of any task in the provided set.

ContinueWhenAny(Task[], Func<Task,TResult>, CancellationToken, TaskContinuationOptions, TaskScheduler)

Создает задачу продолжения, которая будет запущена после выполнения любой задачи в указанном наборе.Creates a continuation task that will be started upon the completion of any task in the provided set.

ContinueWhenAny(Task[], Func<Task,TResult>, TaskContinuationOptions)

Создает задачу продолжения, которая будет запущена после выполнения любой задачи в указанном наборе.Creates a continuation task that will be started upon the completion of any task in the provided set.

ContinueWhenAny<TAntecedentResult>(Task<TAntecedentResult>[], Func<Task<TAntecedentResult>,TResult>)

Создает задачу продолжения, которая будет запущена после выполнения любой задачи в указанном наборе.Creates a continuation task that will be started upon the completion of any task in the provided set.

ContinueWhenAny<TAntecedentResult>(Task<TAntecedentResult>[], Func<Task<TAntecedentResult>,TResult>, CancellationToken)

Создает задачу продолжения, которая будет запущена после выполнения любой задачи в указанном наборе.Creates a continuation task that will be started upon the completion of any task in the provided set.

ContinueWhenAny<TAntecedentResult>(Task<TAntecedentResult>[], Func<Task<TAntecedentResult>,TResult>, CancellationToken, TaskContinuationOptions, TaskScheduler)

Создает задачу продолжения, которая будет запущена после выполнения любой задачи в указанном наборе.Creates a continuation task that will be started upon the completion of any task in the provided set.

ContinueWhenAny<TAntecedentResult>(Task<TAntecedentResult>[], Func<Task<TAntecedentResult>,TResult>, TaskContinuationOptions)

Создает задачу продолжения, которая будет запущена после выполнения любой задачи в указанном наборе.Creates a continuation task that will be started upon the completion of any task in the provided set.

Equals(Object)

Определяет, равен ли указанный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Унаследовано от Object)
FromAsync(Func<AsyncCallback,Object,IAsyncResult>, Func<IAsyncResult,TResult>, Object)

Создает задачу, которая представляет пару методов Begin и End, соответствующих шаблону модели асинхронного программирования.Creates a task that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.

FromAsync(Func<AsyncCallback,Object,IAsyncResult>, Func<IAsyncResult,TResult>, Object, TaskCreationOptions)

Создает задачу, которая представляет пару методов Begin и End, соответствующих шаблону модели асинхронного программирования.Creates a task that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.

FromAsync(IAsyncResult, Func<IAsyncResult,TResult>)

Создает задачу, которая выполняет функцию метода End по завершении заданного объекта IAsyncResult.Creates a task that executes an end method function when a specified IAsyncResult completes.

FromAsync(IAsyncResult, Func<IAsyncResult,TResult>, TaskCreationOptions)

Создает задачу, которая выполняет функцию метода End по завершении заданного объекта IAsyncResult.Creates a task that executes an end method function when a specified IAsyncResult completes.

FromAsync(IAsyncResult, Func<IAsyncResult,TResult>, TaskCreationOptions, TaskScheduler)

Создает задачу, которая выполняет функцию метода End по завершении заданного объекта IAsyncResult.Creates a task that executes an end method function when a specified IAsyncResult completes.

FromAsync<TArg1,TArg2,TArg3>(Func<TArg1,TArg2,TArg3,AsyncCallback,Object,IAsyncResult>, Func<IAsyncResult,TResult>, TArg1, TArg2, TArg3, Object)

Создает задачу, которая представляет пару методов Begin и End, соответствующих шаблону модели асинхронного программирования.Creates a task that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.

FromAsync<TArg1,TArg2,TArg3>(Func<TArg1,TArg2,TArg3,AsyncCallback,Object,IAsyncResult>, Func<IAsyncResult,TResult>, TArg1, TArg2, TArg3, Object, TaskCreationOptions)

Создает задачу, которая представляет пару методов Begin и End, соответствующих шаблону модели асинхронного программирования.Creates a task that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.

FromAsync<TArg1,TArg2>(Func<TArg1,TArg2,AsyncCallback,Object,IAsyncResult>, Func<IAsyncResult,TResult>, TArg1, TArg2, Object)

Создает задачу, которая представляет пару методов Begin и End, соответствующих шаблону модели асинхронного программирования.Creates a task that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.

FromAsync<TArg1,TArg2>(Func<TArg1,TArg2,AsyncCallback,Object,IAsyncResult>, Func<IAsyncResult,TResult>, TArg1, TArg2, Object, TaskCreationOptions)

Создает задачу, которая представляет пару методов Begin и End, соответствующих шаблону модели асинхронного программирования.Creates a task that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.

FromAsync<TArg1>(Func<TArg1,AsyncCallback,Object,IAsyncResult>, Func<IAsyncResult,TResult>, TArg1, Object)

Создает задачу, которая представляет пару методов Begin и End, соответствующих шаблону модели асинхронного программирования.Creates a task that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.

FromAsync<TArg1>(Func<TArg1,AsyncCallback,Object,IAsyncResult>, Func<IAsyncResult,TResult>, TArg1, Object, TaskCreationOptions)

Создает задачу, которая представляет пару методов Begin и End, соответствующих шаблону модели асинхронного программирования.Creates a task that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.

GetHashCode()

Служит в качестве хэш-функции по умолчанию.Serves as the default hash function.

(Унаследовано от Object)
GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
StartNew(Func<Object,TResult>, Object)

Создает и запускает задачу.Creates and starts a task.

StartNew(Func<Object,TResult>, Object, CancellationToken)

Создает и запускает задачу.Creates and starts a task.

StartNew(Func<Object,TResult>, Object, CancellationToken, TaskCreationOptions, TaskScheduler)

Создает и запускает задачу.Creates and starts a task.

StartNew(Func<Object,TResult>, Object, TaskCreationOptions)

Создает и запускает задачу.Creates and starts a task.

StartNew(Func<TResult>)

Создает и запускает задачу.Creates and starts a task.

StartNew(Func<TResult>, CancellationToken)

Создает и запускает задачу.Creates and starts a task.

StartNew(Func<TResult>, CancellationToken, TaskCreationOptions, TaskScheduler)

Создает и запускает задачу.Creates and starts a task.

StartNew(Func<TResult>, TaskCreationOptions)

Создает и запускает задачу.Creates and starts a task.

ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Унаследовано от Object)

Применяется к

Потокобезопасность

Все открытые и защищенные члены TaskFactory<TResult> являются потокобезопасными и могут использоваться одновременно из нескольких потоков.All public and protected members of TaskFactory<TResult> are thread-safe and may be used concurrently from multiple threads.

Дополнительно