C# --- cancellation token

如何终止一个Task — cancellation token

• 由于超时, 耗费资源超额等原因, 有时可能需要终止一个长时间运行的Task
• 这是就可以用 cancellation token
• 注意 CancellationTokenSource 实现了IDsposable接口, 所以使用时必须要调用 Dispose() 方法或者using代码块释放资源

// initialize cancellation objects
CancellationTokenSource cancelTokenSource = new CancellationTokenSource();
CancellationToken token = cancelTokenSource.Token;

// execute a parallel operation
Task task = new Task(() => { some_operations }, token);
task.Start();

// cancel the operation
cancelTokenSource.Cancel();

// release resources
cancelTokenSource.Dispose();

Example — Complete Task via return Operator

• 使用return退出循环. In this case, the state of the task will be TaskStatus.RunToCompletion.

public static void Main(string[] args)
{
  CancellationTokenSource cancelTokenSource = new CancellationTokenSource();
  CancellationToken token = cancelTokenSource.Token;

  Task task = new Task(() =>
  {
    for (int i = 1; i < 100; i++)
    {
      if (token.IsCancellationRequested)
      {
        Console.WriteLine("Operation is canceled");
        return;
      }
      Console.WriteLine($"Count is equal to '{i}'");
      //add some timeout to emulate real-life execution
      Thread.Sleep(10);
    }
  }, token);
 
  task.Start();

  // add some timeout to emulate real-life execution
  Thread.Sleep(100);
  // cancel the parallel operation
  cancelTokenSource.Cancel();
  // wait till the operation is completed
  task.Wait();
  // check the operation status
  Console.WriteLine($"Task Status is equal to '{ task.Status }'");
  // release resources
  cancelTokenSource.Dispose();
}

Output:
Count is equal to '1'
Count is equal to '2'
Count is equal to '3'
Count is equal to '4'
Count is equal to '5'
Operation is canceled
Task Status is equal to 'RanToCompletion'

Example — Complete Task via ThrowIfCancellationRequested()

• Throw OperationCanceledException exception via ThrowIfCancellationRequested() method call. In this case, the state of the task will be TaskStatus.Canceled.
• The exception will be thrown only in case when Wait() or WaitAll() method is called for the task. Otherwise, no exception is thrown, just TaskStatus.Canceled is set.

public static void Main(string[] args)
{
  CancellationTokenSource cancelTokenSource = new CancellationTokenSource();
  CancellationToken token = cancelTokenSource.Token;

  Task task = new Task(() =>
  {
    for (int i = 1; i < 100; i++)
    {
      if (token.IsCancellationRequested)
        token.ThrowIfCancellationRequested();
        Console.WriteLine($"Count is equal to '{i}'");
        //add some timeout to emulate real-life execution
        Thread.Sleep(10);
    }
  }, token);

  try
  {
    task.Start();
    // add some timeout to emulate real-life execution
    Thread.Sleep(100);
    // cancel the parallel operation
    cancelTokenSource.Cancel();
    // wait till the operation is completed
    task.Wait();
  }
  catch (AggregateException ae)
  {
    foreach (Exception e in ae.InnerExceptions)
    {
      if (e is TaskCanceledException)
        Console.WriteLine("Operation is canceled");
      else
        Console.WriteLine(e.Message);
    }
  }
  finally
  {
    // release resources
    cancelTokenSource.Dispose();
  }

  // check the operation status
  Console.WriteLine($"Task Status is equal to '{ task.Status }'");
}

Output:
Count is equal to '1'
Count is equal to '2'
Count is equal to '3'
Count is equal to '4'
Count is equal to '5'
Operation is canceled
Task Status is equal to 'Canceled'

Example — Register Operation Cancellation Handler

• It registers an Action delegate that will be called when the CancellationToken is cancelled.

public static void Main(string[] args)
{
  CancellationTokenSource cancelTokenSource = new CancellationTokenSource();
  CancellationToken token = cancelTokenSource.Token;

  Task task = new Task(() =>
  {
    int i = 1;
    token.Register(() => 
    { 
      Console.WriteLine("Operation is canceled");
      i = 100;
      Console.WriteLine($"Count is equal to '{i}'");
    });
    for (; i < 100; i++)
    {
      Console.WriteLine($"Count is equal to '{i}'");
      //add some timeout to emulate real-life execution
      Thread.Sleep(10);
    }
  }, token);
  task.Start();

  // add some timeout to emulate real-life execution
  Thread.Sleep(100);
  // cancel the parallel operation
  cancelTokenSource.Cancel();
  // wait till the operation is completed
  task.Wait();
  // check the operation status
  Console.WriteLine($"Task Status is equal to '{ task.Status }'");
  // release resources
  cancelTokenSource.Dispose();
}

Output:
Count is equal to '1'
Count is equal to '2'
Count is equal to '3'
Count is equal to '4'
Count is equal to '5'
Operation is canceled
Count is equal to '100'
Task Status is equal to 'RanToCompletion'