Menu

How to Safely Cancel an Async Operation in C#

Asynchronous programming is essential for building responsive applications, but it comes with challenges - particularly when you need to cancel operations.

Here's how to safely implement cancellation in C#.

Using CancellationTokenSource

The key to proper cancellation is the CancellationTokenSource class. This provides a token that can be passed to async methods and monitored for cancellation requests.

// Create a cancellation source with timeout
var cts = new CancellationTokenSource(TimeSpan.FromSeconds(10));
var token = cts.Token;

try
{
    // Pass token to async operations
    await DoLongRunningTaskAsync(token);
}
catch (OperationCanceledException)
{
    // Handle cancellation gracefully
    Console.WriteLine("Operation was canceled");
}
finally
{
    // Always dispose the CancellationTokenSource
    cts.Dispose();
}

Implementing Cancellation in Your Methods

When writing cancellable async methods, check for cancellation at appropriate points:

async Task DoLongRunningTaskAsync(CancellationToken token)
{
    // Check before starting expensive work
    token.ThrowIfCancellationRequested();
    
    for (int i = 0; i < 100; i++)
    {
        // Periodically check during loops
        if (token.IsCancellationRequested)
        {
            // Clean up resources if needed
            CleanupResources();
            
            // Then throw the standard exception
            throw new OperationCanceledException(token);
        }
        
        await Task.Delay(100, token); // Built-in methods accept tokens
    }
}

Best Practices

  1. Always dispose of CancellationTokenSource objects
  2. Use token.ThrowIfCancellationRequested() for cleaner code
  3. Check for cancellation before expensive operations
  4. Pass the token to all nested async calls
  5. Handle OperationCanceledException appropriately in your calling code

By following these patterns, you can ensure your async operations respond promptly to cancellation requests while maintaining clean, resource-efficient code.

28
82

Related

When working with URLs in C#, encoding is essential to ensure that special characters (like spaces, ?, &, and =) don’t break the URL structure. The recommended way to encode a string for a URL is by using Uri.EscapeDataString(), which converts unsafe characters into their percent-encoded equivalents.

string rawText = "hello world!";
string encodedText = Uri.EscapeDataString(rawText);

Console.WriteLine(encodedText); // Output: hello%20world%21

This method encodes spaces as %20, making it ideal for query parameters.

For ASP.NET applications, you can also use HttpUtility.UrlEncode() (from System.Web), which encodes spaces as +:

using System.Web;

string encodedText = HttpUtility.UrlEncode("hello world!");
Console.WriteLine(encodedText); // Output: hello+world%21

For .NET Core and later, Uri.EscapeDataString() is the preferred choice.

28
1315

Enums are a great way to define a set of named constants in C#, but what if you need to iterate over all values dynamically? You can use** Enum.GetValues()** to loop through an enum without hardcoding values.

enum Days { Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday }

foreach (Days day in Enum.GetValues(typeof(Days)))
{
    Console.WriteLine(day);
}

This would output the following:

Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday

Alternative: Using Enum.GetNames() If you only need the string names, use Enum.GetNames() instead:

foreach (string name in Enum.GetNames(typeof(Days)))
{
    Console.WriteLine(name);
}
2
174

Working with CSV files in C# can be accomplished through several approaches, with the most straightforward being the built-in File class methods combined with string manipulation.

For basic CSV operations, you can use File.ReadAllLines() to read the entire file into an array of strings, and File.WriteAllLines() to write data back to a CSV file.

However, for more robust CSV handling, it's recommended to use a dedicated CSV library like CsvHelper, which properly handles edge cases such as commas within quoted fields, escaped characters, and different cultural formats.

This library provides strongly-typed reading and writing capabilities, making it easier to map CSV data to C# objects.

For optimal performance and memory efficiency when dealing with large CSV files, you should consider using StreamReader and StreamWriter classes, which allow you to process the file line by line rather than loading it entirely into memory.

Remember to always properly dispose of these resources using using statements. When writing CSV data, be mindful of proper escaping and quoting rules – fields containing commas, quotes, or newlines should be enclosed in quotes and any embedded quotes should be doubled.

Example

// Basic CSV reading
string[] lines = File.ReadAllLines("data.csv");
foreach (string line in lines)
{
    string[] values = line.Split(',');
    // Process values
}

// Basic CSV writing
var data = new List<string[]>
{
    new[] { "Name", "Age", "City" },
    new[] { "John Doe", "30", "New York" }
};
File.WriteAllLines("output.csv", data.Select(line => string.Join(",", line)));

// Using StreamReader for large files
using (var reader = new StreamReader("data.csv"))
{
    while (!reader.EndOfStream)
    {
        string line = reader.ReadLine();
        // Process line
    }
}

// Using CsvHelper (requires NuGet package)
using (var reader = new StreamReader("data.csv"))
using (var csv = new CsvReader(reader, CultureInfo.InvariantCulture))
{
    var records = csv.GetRecords<MyClass>().ToList();
}
1
575