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.

77
132

Related

Primary constructors, introduced in C# 12, offer a more concise way to define class parameters and initialize fields.

This feature reduces boilerplate code and makes classes more readable.

Traditional Approach vs Primary Constructor

Before primary constructors, you would likely write something like the following:

public class UserService
{
    private readonly ILogger _logger;
    private readonly IUserRepository _repository;

    public UserService(ILogger logger, IUserRepository repository)
    {
        _logger = logger;
        _repository = repository;
    }

    public async Task<User> GetUserById(int id)
    {
        _logger.LogInformation("Fetching user {Id}", id);
        return await _repository.GetByIdAsync(id);
    }
}

With primary constructors, this becomes:

public class UserService(ILogger logger, IUserRepository repository)
{
    public async Task<User> GetUserById(int id)
    {
        logger.LogInformation("Fetching user {Id}", id);
        return await repository.GetByIdAsync(id);
    }
}

Key Benefits

  1. Reduced Boilerplate: No need to declare private fields and write constructor assignments
  2. Parameters Available Throughout: Constructor parameters are accessible in all instance methods
  3. Immutability by Default: Parameters are effectively readonly without explicit declaration

Real-World Example

Here's a practical example using primary constructors with dependency injection:

public class OrderProcessor(
    IOrderRepository orderRepo,
    IPaymentService paymentService,
    ILogger<OrderProcessor> logger)
{
    public async Task<OrderResult> ProcessOrder(Order order)
    {
        try
        {
            logger.LogInformation("Processing order {OrderId}", order.Id);
            
            var paymentResult = await paymentService.ProcessPayment(order.Payment);
            if (!paymentResult.Success)
            {
                return new OrderResult(false, "Payment failed");
            }

            await orderRepo.SaveOrder(order);
            return new OrderResult(true, "Order processed successfully");
        }
        catch (Exception ex)
        {
            logger.LogError(ex, "Failed to process order {OrderId}", order.Id);
            throw;
        }
    }
}

Tips and Best Practices

  1. Use primary constructors when the class primarily needs dependencies for its methods
  2. Combine with records for immutable data types:
public record Customer(string Name, string Email)
{
    public string FormattedEmail => $"{Name} <{Email}>";
}
  1. Consider traditional constructors for complex initialization logic

Primary constructors provide a cleaner, more maintainable way to write C# classes, especially when working with dependency injection and simple data objects.

3
75

String interpolation, introduced in C# 6.0, provides a more readable and concise way to format strings compared to traditional concatenation (+) or string.Format(). Instead of manually inserting variables or placeholders, you can use the $ symbol before a string to directly embed expressions inside brackets.

string name = "Walt";
string job = 'Software Engineer';

string message = $"Hello, my name is {name} and I am a {job}";
Console.WriteLine(message);

This would produce the final output of:

Hello, my name is Walt and I am a Software Engineer

String interpolation can also be chained together into a multiline string (@) for even cleaner more concise results:

string name = "Walt";
string html = $@"
    <div>
        <h1>Welcome, {name}!</h1>
    </div>";
39
159

When working with relational databases, JOIN operations allow you to retrieve data from multiple tables based on a common column.

SQL Server supports different types of joins, each serving a specific purpose. Let’s break them down with examples.

1. INNER JOIN

The INNER JOIN returns only the rows where there is a match in both tables.

SELECT A.id, A.name, B.order_id
FROM Customers A
INNER JOIN Orders B ON A.id = B.customer_id;
  • If a customer has no matching order, they won’t appear in the result.

2. LEFT JOIN (or LEFT OUTER JOIN)

The LEFT JOIN returns all rows from the left table (Customers), and only matching rows from the right table (Orders). If there’s no match, NULL values are returned for the right table columns.

SELECT A.id, A.name, B.order_id
FROM Customers A
LEFT JOIN Orders B ON A.id = B.customer_id;
  • Customers without orders will still appear, but order_id will be NULL.

3. RIGHT JOIN (or RIGHT OUTER JOIN)

The RIGHT JOIN works the opposite of LEFT JOIN, returning all rows from the right table (Orders) and only matching rows from the left table (Customers).

SELECT A.id, A.name, B.order_id
FROM Customers A
RIGHT JOIN Orders B ON A.id = B.customer_id;
  • Orders without a matching customer will still appear, but name will be NULL.

4. FULL JOIN (or FULL OUTER JOIN)

The FULL JOIN returns all records from both tables. If there’s no match, NULL values will be shown in the missing columns.

SELECT A.id, A.name, B.order_id
FROM Customers A
FULL JOIN Orders B ON A.id = B.customer_id;
  • This ensures that all customers and all orders appear in the results, even if there’s no match.

Quick Summary:

Join Type Includes Matching Rows Includes Non-Matching Rows (Left Table) Includes Non-Matching Rows (Right Table)
INNER JOIN ✅ ❌ ❌
LEFT JOIN ✅ ✅ ❌
RIGHT JOIN ✅ ❌ ✅
FULL JOIN ✅ ✅ ✅

Understanding these joins can help you extract data efficiently and ensure that your queries return the expected results. Happy querying!

3
67