Class ThreadingCancellationTokenExtensions

Provides extension methods for Coree.NETStandard.Extensions.Threading.CancellationToken to enhance asynchronous programming patterns.

Inheritance

object

ThreadingCancellationTokenExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Coree.NETStandard.Extensions.Threading.CancellationToken

Assembly: Coree.NETStandard.dll

Syntax

public static class ThreadingCancellationTokenExtensions

Methods

WaitForCancellationAsync(CancellationToken)

Creates a Task that completes when the specified Coree.NETStandard.Extensions.Threading.CancellationToken is cancelled. This method facilitates integrating cancellation tokens with asynchronous operations, enabling easy response to cancellation requests in a Task-based pattern.

Example usage (awaiting application start in a background service):

public class MyBackgroundService : BackgroundService
{
    private readonly IHostApplicationLifetime _appLifetime;

    public MyBackgroundService(IHostApplicationLifetime appLifetime)
    {
        _appLifetime = appLifetime;
    }

    protected override async Task ExecuteAsync(CancellationToken stoppingToken)
    {
        // Wait for the application to fully start
        await _appLifetime.ApplicationStarted.WaitForCancellationAsync();

        Console.WriteLine("Application has started. Background service is proceeding with its tasks.");

        // Now that the application has started, proceed with the background service's main logic
        while (!stoppingToken.IsCancellationRequested)
        {
            // Example operation: perform some work and wait
            Console.WriteLine("Background service is doing its work...");
            await Task.Delay(10000, stoppingToken); // Simulate some work by delaying
        }
    }
}

Note: This extension is particularly useful for synchronizing startup sequences in applications, such as ensuring background services wait for the entire application to start before proceeding with their tasks.

Declaration

public static Task WaitForCancellationAsync(this CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The Coree.NETStandard.Extensions.Threading.CancellationToken to monitor for cancellation.

Returns

Type	Description
Task	A Task that completes when the token is cancelled.