How to cancel await Task.Delay()?

ONLINECAST

2 min read

·

07-10-2024

6

0

Share

Escaping the Delay: How to Cancel await Task.Delay() in C#

Problem: You're using await Task.Delay() in your C# code to introduce a pause. But sometimes you need to escape this delay early, perhaps due to user input or changing conditions. How do you cancel the delay and proceed with your code?

Scenario: Imagine you have a function that displays a loading animation while waiting for some data. The function uses Task.Delay() to simulate the loading process.

public async Task ShowLoadingAnimation()
{
    Console.WriteLine("Loading...");
    await Task.Delay(5000); // Wait for 5 seconds
    Console.WriteLine("Data loaded!");
}

The problem is that await Task.Delay() blocks the execution thread until the delay is complete. If you need to cancel the delay before the 5 seconds are up, how can you do it?

Solution: The key is that Task.Delay() doesn't inherently support cancellation. You need to use a cancellation token.

Code Example:

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

public async Task ShowLoadingAnimation(CancellationToken cancellationToken)
{
    Console.WriteLine("Loading...");

    try
    {
        await Task.Delay(5000, cancellationToken); // Wait for 5 seconds or cancellation
        Console.WriteLine("Data loaded!");
    }
    catch (OperationCanceledException)
    {
        Console.WriteLine("Loading cancelled.");
    }
}

public async Task Main()
{
    // Create a cancellation token source
    using CancellationTokenSource cts = new CancellationTokenSource();
    CancellationToken token = cts.Token;

    // Start the loading animation task
    Task loadingTask = ShowLoadingAnimation(token);

    // Simulate a user action to cancel the loading
    Console.WriteLine("Press any key to cancel loading...");
    Console.ReadKey();

    // Cancel the task
    cts.Cancel();

    // Wait for the loading task to complete (or be canceled)
    await loadingTask;
}

Explanation:

1. Cancellation Token: We introduce a CancellationTokenSource and CancellationToken. The token represents a signal to cancel operations.
2. Passing the Token: The ShowLoadingAnimation method now accepts a CancellationToken parameter.
3. Task.Delay with Cancellation: We pass the cancellationToken to Task.Delay(). This allows Task.Delay() to monitor for cancellation requests.
4. Handling Cancellation: We wrap the await statement in a try...catch block. If Task.Delay() is cancelled, an OperationCanceledException is thrown, and we can handle it accordingly.
5. Cancellation Request: In the Main method, we simulate user interaction by reading a key press. This triggers a cancellation request using cts.Cancel().
6. Waiting for Completion: We use await loadingTask to wait for the task to complete, even if it was cancelled.

Additional Notes:

• Multiple Cancellation Points: You can have multiple cancellation points throughout your application, as long as you pass the same CancellationToken to all relevant functions.
• Cancellation Propagation: Cancellation tokens effectively propagate through method calls, allowing you to cancel operations even if they're nested within other functions.
• Cancellation and Resources: It's crucial to ensure you properly handle cancellation and release any resources being held. For example, if you have a database connection or a file handle, you should dispose of them when the task is cancelled.

By incorporating cancellation tokens, you gain a robust mechanism to escape delays and control the flow of your asynchronous operations effectively.