Saveliy Bondini.NET Developer

Task cancellation in C# and things you should know about it


The task mechanism in C# is a powerful beast in the area of parallel and concurrent programming. Controlling this beast may take lots of effort and pain. .NET Framework 4 introduces a convenient approach for cancellation of asynchronous operations.

How do we control

Why should we control the execution flow of the tasks? One reason is business logic or algorithm requirements. Another reason comes from an idea, that there should be no unobserved tasks. Such tasks may hold thread pool and CPU resources and therefore be dangerous. Last but not least is the ability to differentiate being canceled by manually thrown exception or failing by any other exception.

Just for this .NET provides us with two classes:

  • CancellationTokenSource – an object responsible for creating a cancellation token and sending a cancellation request to all copies of that token.
  • CancellationToken – a structure used by listeners to monitor token current state.

How do we pass token

Firstly, we should somehow make a task use created token. One way is to pass it as an argument to the method responsible for creating the task.

With such an approach, the token is only checked at the very beginning, before starting the execution of lambda expression. If token canceled then the task is also put in canceled mode. In the example above message won’t be printed because token had been canceled before the task was created.

But what if we want to stop task execution in a particular moment? Then you should observe the cancellation token state manually inside the task delegate. There are generally two ways for passing token inside task delegate.

The first way is to make the token variable visible by task delegate. It can be accomplished by using class field, property or even capturing variable within a method.

The second way is to pass the token as state object and downcast it inside task delegate.

 

How do we observe token

Now when we know how to access token inside a task, it is time to become acquainted with how we can observe token state. You can observe it in three ways: by polling, using callback registration and via wait handle.

1. By polling – periodically check IsCancellationRequested property

2. Callback registration – provide a callback that would be executed right after cancellation is requested

3. Waiting for the wait handle provided by CancellationToken

You can also observe multiple tokens simultaneously, by creating a linked token source that can join multiple tokens into one

 

 

How do we cancel

We already know how to pass and observe tokens. What is left is how we send the cancellation request. For canceling, we use CancellationTokenSource object. Cancellation request may be direct or deferred.

When we use the Cancel method directly, it implicitly calls all registered callbacks on the current thread. If callbacks throw exceptions, they are wrapped in AggregateException object that will be propagated then to the caller.

Since callbacks are called one by one, optional boolean argument for Cancel method lets you specify behavior upon encountering an exception in any of the registered callbacks.

If the argument is true then the exception will immediately propagate out of the call to Cancel, preventing the remaining callbacks from executing.

If the argument is false, all registered callbacks will be executed with all thrown exceptions wrapped into the AggregateException.

After detecting cancellation request inside a task, common approach is to do some cleanup and throw OperationCanceledException object, to put the task in a canceled state.

 

Conclusion

The task cancellation mechanism is an easy and useful tool for controlling task execution flow. It is a part of big .NET Framework ecosystem, therefore its usage in most cases is more preferable than some custom solutions. Even if you don’t want to implement your own cancellation logic you still have to pass CancellationToken to all async methods that support cancellation (i.e HttpClient.GetAsync() or DbSet.FindAsync()).

 

  • Lais Gomes

    Hi! Very helpful, explained clearly and objectively, thank’s. =)

  • very helpful!

  • Emran Hussain

    If you would call the ThrowIfCancellationRequested() then you should need to check if (token.IsCancellationRequested). Because, notice that, there is an ‘if’ in the method name ThrowIfCancellationRequested(). Therefore, cancellation exception will be thrown ONLY IF the cancellation is requested. checking if (token.IsCancellationRequested) is redundant in this case.

    • Emran Hussain

      Sorry, I missed the “NOT” word in my comment. I meant “you should NOT need to check if (token.IsCancellationRequested)

  • Bang

    Good article. Two examples are missing a space: “newCancellationTokenSource”

  • Genie

    Let me ask a dumb question. Why can’t I just use a simple global boolean variable as a flag as the token? and do something like while(!globalVariable) in the task?

    • Jey

      I guess, it will work 🙂