You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
480 lines
23 KiB
480 lines
23 KiB
#if NET40 || NET45 //|| !NET_4_6 |
|
|
|
using System.Collections.Generic; |
|
using System.Linq; |
|
using System.Runtime.CompilerServices; |
|
|
|
namespace System.Threading.Tasks |
|
{ |
|
/// <summary> |
|
/// Provides methods for creating and manipulating tasks. |
|
/// </summary> |
|
/// |
|
/// <remarks> |
|
/// TaskEx is a placeholder. |
|
/// </remarks> |
|
public static class TaskEx |
|
{ |
|
private const string ArgumentOutOfRange_TimeoutNonNegativeOrMinusOne = "The timeout must be non-negative or -1, and it must be less than or equal to Int32.MaxValue."; |
|
|
|
/// <summary> |
|
/// An already canceled task. |
|
/// </summary> |
|
private static readonly Task _preCanceledTask = ((Func<Task>)(() => |
|
{ |
|
var tcs = new TaskCompletionSource<bool>(); |
|
tcs.TrySetCanceled(); |
|
return tcs.Task; |
|
}))(); |
|
|
|
/// <summary> |
|
/// An already completed task. |
|
/// </summary> |
|
private static readonly Task _preCompletedTask = FromResult(false); |
|
|
|
static TaskEx() |
|
{ |
|
} |
|
|
|
/// <summary> |
|
/// Starts a Task that will complete after the specified due time. |
|
/// </summary> |
|
/// <param name="dueTime">The delay in milliseconds before the returned task completes.</param> |
|
/// <returns> |
|
/// The timed Task. |
|
/// </returns> |
|
/// <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="dueTime"/> argument must be non-negative or -1 and less than or equal to Int32.MaxValue. |
|
/// </exception> |
|
public static Task Delay(int dueTime) |
|
{ |
|
return Delay(dueTime, CancellationToken.None); |
|
} |
|
|
|
/// <summary> |
|
/// Starts a Task that will complete after the specified due time. |
|
/// </summary> |
|
/// <param name="dueTime">The delay before the returned task completes.</param> |
|
/// <returns> |
|
/// The timed Task. |
|
/// </returns> |
|
/// <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="dueTime"/> argument must be non-negative or -1 and less than or equal to Int32.MaxValue. |
|
/// </exception> |
|
public static Task Delay(TimeSpan dueTime) |
|
{ |
|
return Delay(dueTime, CancellationToken.None); |
|
} |
|
|
|
/// <summary> |
|
/// Starts a Task that will complete after the specified due time. |
|
/// </summary> |
|
/// <param name="dueTime">The delay before the returned task completes.</param><param name="cancellationToken">A CancellationToken that may be used to cancel the task before the due time occurs.</param> |
|
/// <returns> |
|
/// The timed Task. |
|
/// </returns> |
|
/// <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="dueTime"/> argument must be non-negative or -1 and less than or equal to Int32.MaxValue. |
|
/// </exception> |
|
public static Task Delay(TimeSpan dueTime, CancellationToken cancellationToken) |
|
{ |
|
var timeoutMs = (long)dueTime.TotalMilliseconds; |
|
if (timeoutMs < Timeout.Infinite || timeoutMs > int.MaxValue) |
|
throw new ArgumentOutOfRangeException("dueTime", ArgumentOutOfRange_TimeoutNonNegativeOrMinusOne); |
|
|
|
return Delay((int)timeoutMs, cancellationToken); |
|
} |
|
|
|
/// <summary> |
|
/// Starts a Task that will complete after the specified due time. |
|
/// </summary> |
|
/// <param name="dueTime">The delay in milliseconds before the returned task completes.</param><param name="cancellationToken">A CancellationToken that may be used to cancel the task before the due time occurs.</param> |
|
/// <returns> |
|
/// The timed Task. |
|
/// </returns> |
|
/// <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="dueTime"/> argument must be non-negative or -1 and less than or equal to Int32.MaxValue. |
|
/// </exception> |
|
public static Task Delay(int dueTime, CancellationToken cancellationToken) |
|
{ |
|
if (dueTime < -1) |
|
throw new ArgumentOutOfRangeException("dueTime", ArgumentOutOfRange_TimeoutNonNegativeOrMinusOne); |
|
if (cancellationToken.IsCancellationRequested) |
|
return _preCanceledTask; |
|
if (dueTime == 0) |
|
return _preCompletedTask; |
|
var tcs = new TaskCompletionSource<bool>(); |
|
var ctr = new CancellationTokenRegistration(); |
|
|
|
Timer timer = null; |
|
timer = new Timer(_ => |
|
{ |
|
ctr.Dispose(); |
|
timer.Dispose(); |
|
tcs.TrySetResult(true); |
|
}, null, Timeout.Infinite, Timeout.Infinite); |
|
|
|
if (cancellationToken.CanBeCanceled) |
|
{ |
|
ctr = cancellationToken.Register(() => |
|
{ |
|
timer.Dispose(); |
|
tcs.TrySetCanceled(); |
|
}); |
|
} |
|
|
|
timer.Change(dueTime, Timeout.Infinite); |
|
return tcs.Task; |
|
} |
|
|
|
/// <summary> |
|
/// Creates an already completed <see cref="T:System.Threading.Tasks.Task`1"/> from the specified result. |
|
/// </summary> |
|
/// <param name="result">The result from which to create the completed task.</param> |
|
/// <returns> |
|
/// The completed task. |
|
/// </returns> |
|
public static Task<TResult> FromResult<TResult>(TResult result) |
|
{ |
|
var completionSource = new TaskCompletionSource<TResult>(result); |
|
completionSource.TrySetResult(result); |
|
return completionSource.Task; |
|
} |
|
|
|
/// <summary> |
|
/// Creates a task that runs the specified action. |
|
/// </summary> |
|
/// <param name="action">The action to execute asynchronously.</param> |
|
/// <returns> |
|
/// A task that represents the completion of the action. |
|
/// </returns> |
|
/// <exception cref="T:System.ArgumentNullException">The <paramref name="action"/> argument is null.</exception> |
|
public static Task Run(Action action) |
|
{ |
|
return Run(action, CancellationToken.None); |
|
} |
|
|
|
/// <summary> |
|
/// Creates a task that runs the specified action. |
|
/// </summary> |
|
/// <param name="action">The action to execute.</param><param name="cancellationToken">The CancellationToken to use to request cancellation of this task.</param> |
|
/// <returns> |
|
/// A task that represents the completion of the action. |
|
/// </returns> |
|
/// <exception cref="T:System.ArgumentNullException">The <paramref name="action"/> argument is null.</exception> |
|
public static Task Run(Action action, CancellationToken cancellationToken) |
|
{ |
|
return Task.Factory.StartNew(action, cancellationToken, TaskCreationOptions.None, TaskScheduler.Default); |
|
} |
|
|
|
/// <summary> |
|
/// Creates a task that runs the specified function. |
|
/// </summary> |
|
/// <param name="function">The function to execute asynchronously.</param> |
|
/// <returns> |
|
/// A task that represents the completion of the action. |
|
/// </returns> |
|
/// <exception cref="T:System.ArgumentNullException">The <paramref name="function"/> argument is null.</exception> |
|
public static Task<TResult> Run<TResult>(Func<TResult> function) |
|
{ |
|
return Run(function, CancellationToken.None); |
|
} |
|
|
|
/// <summary> |
|
/// Creates a task that runs the specified function. |
|
/// </summary> |
|
/// <param name="function">The action to execute.</param><param name="cancellationToken">The CancellationToken to use to cancel the task.</param> |
|
/// <returns> |
|
/// A task that represents the completion of the action. |
|
/// </returns> |
|
/// <exception cref="T:System.ArgumentNullException">The <paramref name="function"/> argument is null.</exception> |
|
public static Task<TResult> Run<TResult>(Func<TResult> function, CancellationToken cancellationToken) |
|
{ |
|
return Task.Factory.StartNew(function, cancellationToken, TaskCreationOptions.None, TaskScheduler.Default); |
|
} |
|
|
|
/// <summary> |
|
/// Creates a task that runs the specified function. |
|
/// </summary> |
|
/// <param name="function">The action to execute asynchronously.</param> |
|
/// <returns> |
|
/// A task that represents the completion of the action. |
|
/// </returns> |
|
/// <exception cref="T:System.ArgumentNullException">The <paramref name="function"/> argument is null.</exception> |
|
public static Task Run(Func<Task> function) |
|
{ |
|
return Run(function, CancellationToken.None); |
|
} |
|
|
|
/// <summary> |
|
/// Creates a task that runs the specified function. |
|
/// </summary> |
|
/// <param name="function">The function to execute.</param><param name="cancellationToken">The CancellationToken to use to request cancellation of this task.</param> |
|
/// <returns> |
|
/// A task that represents the completion of the function. |
|
/// </returns> |
|
/// <exception cref="T:System.ArgumentNullException">The <paramref name="function"/> argument is null.</exception> |
|
public static Task Run(Func<Task> function, CancellationToken cancellationToken) |
|
{ |
|
return Run<Task>(function, cancellationToken).Unwrap(); |
|
} |
|
|
|
/// <summary> |
|
/// Creates a task that runs the specified function. |
|
/// </summary> |
|
/// <param name="function">The function to execute asynchronously.</param> |
|
/// <returns> |
|
/// A task that represents the completion of the action. |
|
/// </returns> |
|
/// <exception cref="T:System.ArgumentNullException">The <paramref name="function"/> argument is null.</exception> |
|
public static Task<TResult> Run<TResult>(Func<Task<TResult>> function) |
|
{ |
|
return Run(function, CancellationToken.None); |
|
} |
|
|
|
/// <summary> |
|
/// Creates a task that runs the specified function. |
|
/// </summary> |
|
/// <param name="function">The action to execute.</param><param name="cancellationToken">The CancellationToken to use to cancel the task.</param> |
|
/// <returns> |
|
/// A task that represents the completion of the action. |
|
/// </returns> |
|
/// <exception cref="T:System.ArgumentNullException">The <paramref name="function"/> argument is null.</exception> |
|
public static Task<TResult> Run<TResult>(Func<Task<TResult>> function, CancellationToken cancellationToken) |
|
{ |
|
return Run<Task<TResult>>(function, cancellationToken).Unwrap(); |
|
} |
|
|
|
/// <summary> |
|
/// Creates a Task that will complete only when all of the provided collection of Tasks has completed. |
|
/// </summary> |
|
/// <param name="tasks">The Tasks to monitor for completion.</param> |
|
/// <returns> |
|
/// A Task that represents the completion of all of the provided tasks. |
|
/// </returns> |
|
/// |
|
/// <remarks> |
|
/// If any of the provided Tasks faults, the returned Task will also fault, and its Exception will contain information |
|
/// about all of the faulted tasks. If no Tasks fault but one or more Tasks is canceled, the returned |
|
/// Task will also be canceled. |
|
/// |
|
/// </remarks> |
|
/// <exception cref="T:System.ArgumentNullException">The <paramref name="tasks"/> argument is null.</exception><exception cref="T:System.ArgumentException">The <paramref name="tasks"/> argument contains a null reference.</exception> |
|
public static Task WhenAll(params Task[] tasks) |
|
{ |
|
return WhenAll((IEnumerable<Task>)tasks); |
|
} |
|
|
|
/// <summary> |
|
/// Creates a Task that will complete only when all of the provided collection of Tasks has completed. |
|
/// </summary> |
|
/// <param name="tasks">The Tasks to monitor for completion.</param> |
|
/// <returns> |
|
/// A Task that represents the completion of all of the provided tasks. |
|
/// </returns> |
|
/// |
|
/// <remarks> |
|
/// If any of the provided Tasks faults, the returned Task will also fault, and its Exception will contain information |
|
/// about all of the faulted tasks. If no Tasks fault but one or more Tasks is canceled, the returned |
|
/// Task will also be canceled. |
|
/// |
|
/// </remarks> |
|
/// <exception cref="T:System.ArgumentNullException">The <paramref name="tasks"/> argument is null.</exception><exception cref="T:System.ArgumentException">The <paramref name="tasks"/> argument contains a null reference.</exception> |
|
public static Task<TResult[]> WhenAll<TResult>(params Task<TResult>[] tasks) |
|
{ |
|
return WhenAll((IEnumerable<Task<TResult>>)tasks); |
|
} |
|
|
|
/// <summary> |
|
/// Creates a Task that will complete only when all of the provided collection of Tasks has completed. |
|
/// </summary> |
|
/// <param name="tasks">The Tasks to monitor for completion.</param> |
|
/// <returns> |
|
/// A Task that represents the completion of all of the provided tasks. |
|
/// </returns> |
|
/// |
|
/// <remarks> |
|
/// If any of the provided Tasks faults, the returned Task will also fault, and its Exception will contain information |
|
/// about all of the faulted tasks. If no Tasks fault but one or more Tasks is canceled, the returned |
|
/// Task will also be canceled. |
|
/// |
|
/// </remarks> |
|
/// <exception cref="T:System.ArgumentNullException">The <paramref name="tasks"/> argument is null.</exception><exception cref="T:System.ArgumentException">The <paramref name="tasks"/> argument contains a null reference.</exception> |
|
public static Task WhenAll(IEnumerable<Task> tasks) |
|
{ |
|
return WhenAllCore(tasks, (Action<Task[], TaskCompletionSource<object>>)((completedTasks, tcs) => tcs.TrySetResult(null))); |
|
} |
|
|
|
/// <summary> |
|
/// Creates a Task that will complete only when all of the provided collection of Tasks has completed. |
|
/// </summary> |
|
/// <param name="tasks">The Tasks to monitor for completion.</param> |
|
/// <returns> |
|
/// A Task that represents the completion of all of the provided tasks. |
|
/// </returns> |
|
/// |
|
/// <remarks> |
|
/// If any of the provided Tasks faults, the returned Task will also fault, and its Exception will contain information |
|
/// about all of the faulted tasks. If no Tasks fault but one or more Tasks is canceled, the returned |
|
/// Task will also be canceled. |
|
/// |
|
/// </remarks> |
|
/// <exception cref="T:System.ArgumentNullException">The <paramref name="tasks"/> argument is null.</exception><exception cref="T:System.ArgumentException">The <paramref name="tasks"/> argument contains a null reference.</exception> |
|
public static Task<TResult[]> WhenAll<TResult>(IEnumerable<Task<TResult>> tasks) |
|
{ |
|
return WhenAllCore<TResult[]>(tasks.Cast<Task>(), (completedTasks, tcs) => |
|
tcs.TrySetResult(completedTasks |
|
.Cast<Task<TResult>>() |
|
.Select(t => t.Result) |
|
.ToArray())); |
|
} |
|
|
|
/// <summary> |
|
/// Creates a Task that will complete when any of the tasks in the provided collection completes. |
|
/// </summary> |
|
/// <param name="tasks">The Tasks to be monitored.</param> |
|
/// <returns> |
|
/// A Task that represents the completion of any of the provided Tasks. The completed Task is this Task's result. |
|
/// |
|
/// </returns> |
|
/// |
|
/// <remarks> |
|
/// Any Tasks that fault will need to have their exceptions observed elsewhere. |
|
/// </remarks> |
|
/// <exception cref="T:System.ArgumentNullException">The <paramref name="tasks"/> argument is null.</exception><exception cref="T:System.ArgumentException">The <paramref name="tasks"/> argument contains a null reference.</exception> |
|
public static Task<Task> WhenAny(params Task[] tasks) |
|
{ |
|
return WhenAny((IEnumerable<Task>)tasks); |
|
} |
|
|
|
/// <summary> |
|
/// Creates a Task that will complete when any of the tasks in the provided collection completes. |
|
/// </summary> |
|
/// <param name="tasks">The Tasks to be monitored.</param> |
|
/// <returns> |
|
/// A Task that represents the completion of any of the provided Tasks. The completed Task is this Task's result. |
|
/// |
|
/// </returns> |
|
/// |
|
/// <remarks> |
|
/// Any Tasks that fault will need to have their exceptions observed elsewhere. |
|
/// </remarks> |
|
/// <exception cref="T:System.ArgumentNullException">The <paramref name="tasks"/> argument is null.</exception><exception cref="T:System.ArgumentException">The <paramref name="tasks"/> argument contains a null reference.</exception> |
|
public static Task<Task> WhenAny(IEnumerable<Task> tasks) |
|
{ |
|
if (tasks == null) |
|
throw new ArgumentNullException("tasks"); |
|
var tcs = new TaskCompletionSource<Task>(); |
|
Task.Factory.ContinueWhenAny<bool>(tasks as Task[] ?? tasks.ToArray(), tcs.TrySetResult, CancellationToken.None, TaskContinuationOptions.ExecuteSynchronously, TaskScheduler.Default); |
|
return tcs.Task; |
|
} |
|
|
|
/// <summary> |
|
/// Creates a Task that will complete when any of the tasks in the provided collection completes. |
|
/// </summary> |
|
/// <param name="tasks">The Tasks to be monitored.</param> |
|
/// <returns> |
|
/// A Task that represents the completion of any of the provided Tasks. The completed Task is this Task's result. |
|
/// |
|
/// </returns> |
|
/// |
|
/// <remarks> |
|
/// Any Tasks that fault will need to have their exceptions observed elsewhere. |
|
/// </remarks> |
|
/// <exception cref="T:System.ArgumentNullException">The <paramref name="tasks"/> argument is null.</exception><exception cref="T:System.ArgumentException">The <paramref name="tasks"/> argument contains a null reference.</exception> |
|
public static Task<Task<TResult>> WhenAny<TResult>(params Task<TResult>[] tasks) |
|
{ |
|
return WhenAny((IEnumerable<Task<TResult>>)tasks); |
|
} |
|
|
|
/// <summary> |
|
/// Creates a Task that will complete when any of the tasks in the provided collection completes. |
|
/// </summary> |
|
/// <param name="tasks">The Tasks to be monitored.</param> |
|
/// <returns> |
|
/// A Task that represents the completion of any of the provided Tasks. The completed Task is this Task's result. |
|
/// |
|
/// </returns> |
|
/// |
|
/// <remarks> |
|
/// Any Tasks that fault will need to have their exceptions observed elsewhere. |
|
/// </remarks> |
|
/// <exception cref="T:System.ArgumentNullException">The <paramref name="tasks"/> argument is null.</exception><exception cref="T:System.ArgumentException">The <paramref name="tasks"/> argument contains a null reference.</exception> |
|
public static Task<Task<TResult>> WhenAny<TResult>(IEnumerable<Task<TResult>> tasks) |
|
{ |
|
if (tasks == null) |
|
throw new ArgumentNullException("tasks"); |
|
var tcs = new TaskCompletionSource<Task<TResult>>(); |
|
Task.Factory.ContinueWhenAny<TResult, bool>(tasks as Task<TResult>[] ?? tasks.ToArray(), tcs.TrySetResult, CancellationToken.None, TaskContinuationOptions.ExecuteSynchronously, TaskScheduler.Default); |
|
return tcs.Task; |
|
} |
|
|
|
/// <summary> |
|
/// Creates an awaitable that asynchronously yields back to the current context when awaited. |
|
/// </summary> |
|
/// |
|
/// <returns> |
|
/// A context that, when awaited, will asynchronously transition back into the current context. |
|
/// If SynchronizationContext.Current is non-null, that is treated as the current context. |
|
/// Otherwise, TaskScheduler.Current is treated as the current context. |
|
/// |
|
/// </returns> |
|
public static YieldAwaitable Yield() |
|
{ |
|
return new YieldAwaitable(); |
|
} |
|
|
|
/// <summary> |
|
/// Adds the target exception to the list, initializing the list if it's null. |
|
/// </summary> |
|
/// <param name="targetList">The list to which to add the exception and initialize if the list is null.</param><param name="exception">The exception to add, and unwrap if it's an aggregate.</param> |
|
private static void AddPotentiallyUnwrappedExceptions(ref List<Exception> targetList, Exception exception) |
|
{ |
|
var aggregateException = exception as AggregateException; |
|
if (targetList == null) |
|
targetList = new List<Exception>(); |
|
if (aggregateException != null) |
|
targetList.Add(aggregateException.InnerExceptions.Count == 1 ? exception.InnerException : exception); |
|
else |
|
targetList.Add(exception); |
|
} |
|
|
|
/// <summary> |
|
/// Creates a Task that will complete only when all of the provided collection of Tasks has completed. |
|
/// </summary> |
|
/// <param name="tasks">The Tasks to monitor for completion.</param><param name="setResultAction">A callback invoked when all of the tasks complete successfully in the RanToCompletion state. |
|
/// This callback is responsible for storing the results into the TaskCompletionSource. |
|
/// </param> |
|
/// <returns> |
|
/// A Task that represents the completion of all of the provided tasks. |
|
/// </returns> |
|
/// <exception cref="T:System.ArgumentNullException">The <paramref name="tasks"/> argument is null.</exception><exception cref="T:System.ArgumentException">The <paramref name="tasks"/> argument contains a null reference.</exception> |
|
private static Task<TResult> WhenAllCore<TResult>(IEnumerable<Task> tasks, Action<Task[], TaskCompletionSource<TResult>> setResultAction) |
|
{ |
|
if (tasks == null) |
|
throw new ArgumentNullException("tasks"); |
|
var tcs = new TaskCompletionSource<TResult>(); |
|
var taskArray = tasks as Task[] ?? tasks.ToArray(); |
|
if (taskArray.Length == 0) |
|
setResultAction(taskArray, tcs); |
|
else |
|
Task.Factory.ContinueWhenAll(taskArray, completedTasks => |
|
{ |
|
List<Exception> exceptions = null; |
|
var canceled = false; |
|
foreach (var task in completedTasks) |
|
{ |
|
if (task.IsFaulted) |
|
AddPotentiallyUnwrappedExceptions(ref exceptions, task.Exception); |
|
else if (task.IsCanceled) |
|
canceled = true; |
|
} |
|
if (exceptions != null && exceptions.Count > 0) |
|
tcs.TrySetException(exceptions); |
|
else if (canceled) |
|
tcs.TrySetCanceled(); |
|
else |
|
setResultAction(completedTasks, tcs); |
|
}, CancellationToken.None, TaskContinuationOptions.ExecuteSynchronously, TaskScheduler.Default); |
|
return tcs.Task; |
|
} |
|
} |
|
} |
|
|
|
#endif |