Зачем нужен метод CreateLinkedTokenSource(CancellationToken)?

Question

[oleg_ods]

Зачем нужен метод CreateLinkedTokenSource(CancellationToken)? Вопрос именно по поводу перегрузки метода с одним параметром CancellationToken. Я понимаю, что это возможность создать цепочку методов которая должна прерваться полностью при запросе отмены у одного токена. Но почему тогда не передать один токен во все методы цепочки?

Вот например,

static void Main(string[] args)
        {
            var ctx = new CancellationTokenSource();

            var task = FirstMethodAsync(ctx.Token);
            //var task = FirstMethodLinkedAsync(ctx.Token); // Результат идентичен вызову метода FirstMethodAsync.

            ConsoleKeyInfo key;

            while (!task.IsCompleted)
            {                
                key = Console.ReadKey();

                if (key.KeyChar == 'e')
                {
                    ctx.Cancel();                    
                }
            }

            Console.WriteLine("Good buy!");
        }

        static async Task FirstMethodAsync(CancellationToken cancellationToken)
        {
            var secondTask = SecondMethodAsync(cancellationToken);
            while (true)
            {
                if (cancellationToken.IsCancellationRequested)
                {
                    Console.WriteLine("First method cancelled");
                    return;
                }
                Console.WriteLine("First method: {0}", DateTime.Now.ToLongTimeString());
                await Task.Delay(500);
            }
        }

        static async Task FirstMethodLinkedAsync(CancellationToken cancellationToken)
        {
            var cts = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken);
            var secondTask = SecondMethodAsync(cts.Token);
            while (true)
            {
                if (cancellationToken.IsCancellationRequested)
                {
                    Console.WriteLine("First method cancelled");
                    return;
                }
                Console.WriteLine("First method: {0}", DateTime.Now.ToLongTimeString());
                await Task.Delay(500);
            }
        }

        static async Task SecondMethodAsync(CancellationToken cancellationToken)
        {
            while (true)
            {
                if (cancellationToken.IsCancellationRequested)
                {
                    Console.WriteLine("Second method cancelled");
                    return;
                }
                Console.WriteLine("Second method: {0}", DateTime.Now.ToLongTimeString());
                await Task.Delay(750);
            }
        }

Результаты обоих вызовов, на мой взгляд, идентичны. Зачем тогда создавать еще один CancellationTokenSource если можно просто передать готовый CancellationToken в следующий метод?

Answer 1

[Василий Банников]

Не уверен, когда именно это может понадобится в реальной жизни (у самого не было такой потребности), но например:
1. Тебе пришёл CancellationToken, но ты хочешь добавить новую причину, по которой может отметиться выполнение, в дополнение к той, по которой сработает первый CancellationToken
2. Ты создаёшь свой CTS и прилинковываешь его к первому токену.
Профит, задача решена - твой метод может отмениться как извне, так и по каким-то своим внутренним причинам.

Comments

[oleg_ods]

То есть, если я правильно понял, при использовании LinkedTokenSource

var cts = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken);

теперь если cancellationToken.IsCancellationRequested == true, то остановятся оба метода, а также через cts.Cancel() можно остановить выполнение SecondMethod не затрагивая работу FirstMethod. Правильно?

[Василий Банников]

oleg_ods, не уверен, надо потестить. В доке не написано?

[Василий Банников]

oleg_ods, в общем запустил код. Действительно - отмена вложенного токена не отменяет внешний.

Код для roslynpad

{
    var cts0 = new CancellationTokenSource();
    var token0 = cts0.Token;

    var cts1 = CancellationTokenSource.CreateLinkedTokenSource(token0);

    var token1 = cts1.Token;

    token0.IsCancellationRequested.Dump("token0 before cancelling cts0"); // false
    token1.IsCancellationRequested.Dump("token1 before cancelling cts0"); // false

    cts0.Cancel();

    token0.IsCancellationRequested.Dump("token0 after cancelling cts0"); // true
    token1.IsCancellationRequested.Dump("token1 after cancelling cts0"); // true
}

{
    var cts0 = new CancellationTokenSource();

    var token0 = cts0.Token;


    var cts1 = CancellationTokenSource.CreateLinkedTokenSource(token0);
    var token1 = cts1.Token;


    token0.IsCancellationRequested.Dump("token0 before cancelling cts1"); // false
    token1.IsCancellationRequested.Dump("token1 before cancelling cts1"); // false

    cts1.Cancel();

    token0.IsCancellationRequested.Dump("token0 after cancelling cts1"); // false
    token1.IsCancellationRequested.Dump("token1 after cancelling cts1"); // true
}

[oleg_ods]

Василий Банников, Спасибо)

[Александр Юдаков]

Василий Банников, спасибо за исследование! Не знал ничего про LinkedTokenSource.