How to cancel a Task in await?

by

Read up on Cancellation (which was introduced in .NET 4.0 and is largely unchanged since then) and the Task-Based Asynchronous Pattern, which provides guidelines on how to use CancellationToken with async methods.

To summarize, you pass a CancellationToken into each method that supports cancellation, and that method must check it periodically.

private async Task TryTask()
{
  CancellationTokenSource source = new CancellationTokenSource();
  source.CancelAfter(TimeSpan.FromSeconds(1));
  Task<int> task = Task.Run(() => slowFunc(1, 2, source.Token), source.Token);

  // (A canceled task will raise an exception when awaited).
  await task;
}

private int slowFunc(int a, int b, CancellationToken cancellationToken)
{
  string someString = string.Empty;
  for (int i = 0; i < 200000; i++)
  {
    someString += "a";
    if (i % 1000 == 0)
      cancellationToken.ThrowIfCancellationRequested();
  }

  return a + b;
}

More Related Contents:

  1. Async/await vs BackgroundWorker
  2. Awaiting multiple Tasks with different results
  3. Run two async tasks in parallel and collect results in .NET 4.5
  4. What’s the difference between Task.Start/Wait and Async/Await?
  5. Proper way to implement a never ending task. (Timers vs Task)
  6. Best practice to call ConfigureAwait for all server-side code
  7. Parallel.ForEach and async-await [duplicate]
  8. StaTaskScheduler and STA thread message pumping
  9. Execute task in background in WPF application
  10. When to dispose CancellationTokenSource?
  11. Does the use of async/await create a new thread?
  12. HttpClient – A task was cancelled?
  13. How to use non-thread-safe async/await APIs and patterns with ASP.NET Web API?
  14. Difference between await and ContinueWith
  15. Format A TimeSpan With Years
  16. Waiting for async/await inside a task
  17. What does MaxDegreeOfParallelism do?
  18. multiple awaits vs Task.WaitAll – equivalent?
  19. How can SynchronizationContext.Current of the main thread become null in a Windows Forms application?
  20. Using async without await?
  21. Executing tasks in parallel
  22. Difference between returning and awaiting a Task in an async method [duplicate]
  23. Use Task.Run() in synchronous method to avoid deadlock waiting on async method?
  24. A pattern for self-cancelling and restarting task
  25. SynchronizationLockException on Monitor.Exit when using await
  26. Thread parameters being changed
  27. How can I capture the value of an outer variable inside a lambda expression?
  28. Transform IEnumerable asynchronously by awaiting each task
  29. How to implement Task.WhenAny() with a predicate
  30. Create a completed Task

Leave a Comment