# V3167. Parameter of 'CancellationToken' type is not used inside function's body.

Анализатор обнаружил, что принимаемый методом параметр типа 'CancellationToken' не используется.

Объекты этого типа обычно применяются в случаях, когда может возникнуть необходимость прерывания операции, выполняемой в параллельном потоке. Метод, принимающий 'CancellationToken' в качестве параметра, может обращаться к нему во время выполнения, чтобы при необходимости завершить работу досрочно. Иногда токен также передаётся в качестве аргумента при вызове других методов, чтобы предоставить возможность досрочного завершения их работы.

Случаи, когда метод принимает 'CancellationToken', но не использует, выглядят подозрительно. Возможно, при разработке предполагалось использование этого параметра для обеспечения возможности отмены операции, но была допущена ошибка, из-за которой параметр оказался "лишним". Из-за этого может, к примеру, возникнуть ситуация, когда приложение не реагирует на запросы отмены от пользователя своевременно.

Рассмотрим пример:

    public List<SomeStruct> LoadInfo(string[] keys, CancellationToken token)
    {
      List<SomeStruct> result = new List<SomeStruct>();

      foreach (string key in keys)
      {
        SomeStruct item = LoadHugeData(key);
        result.Add(item);
      }

      return result;
    }

Данный метод производит последовательную загрузку данных большого размера. Реализация возможности прерывания такой операции имеет смысл, однако, несмотря на это, параметр 'token' не используется. Такой код выглядит подозрительно и помечается анализатором как место потенциальной ошибки. В качестве исправления можно предложить следующий вариант:

    public List<SomeStruct> LoadInfo(string[] keys, CancellationToken token)
    {
      List<SomeStruct> result = new List<SomeStruct>();

      foreach (string key in keys)
      {
        if(token.IsCancellationRequested)
           break;

        SomeStruct item = LoadHugeData(key);
        result.Add(item);
      }

      return result;
    }

Теперь последовательная загрузка данных может быть прервана. В случае получения запроса отмены операции метод 'LoadInfo' прекратит загрузку элементов и вернёт то, что было загружено до отмены операции.

Рассмотрим другой пример:

    void ExecuteQuery(CancellationToken token = default)
    { .... }

    public void ExecuteSomeActions(CancellationToken token)
    {
      ....
      ExecuteQuery();
      ....
    }

Метод 'ExecuteQuery' в качестве аргумента может принимать значение типа 'CancellationToken'. Однако при вызове в методе 'ExecuteSomeActions' параметр 'token' не передаётся в метод 'ExecuteQuery'. Как следствие, такой код может несвоевременно реагировать на действия отмены.

Для исправления проблемы необходимо передавать 'token' в качестве аргумента метода 'ExecuteQuery':

    ExecuteQuery(token);

Стоит отметить, что анализатор не будет выдавать предупреждения в случаях, когда метод помечен модификатором 'override' или является частью реализации интерфейса. Это исключение связано с тем, что при наследовании и переопределении сигнатура метода обязана содержать параметр типа 'CancellationToken' вне зависимости от того, предусматривает ли конкретная реализация его использование. Похожее исключение связано с virtual-методами: 'CancellationToken' в объявлении может быть предназначен не для стандартной реализации, а для наследников, которые будут данный метод переопределять.

Также предупреждение не будет выдаваться на лямбда-выражения, так как они достаточно часто используются в качестве обработчиков событий или передаются в качестве аргументов. В этих случаях функция будет вынуждена принимать определённый набор параметров даже в случаях, когда для её работы они не требуются.

Выявляемые диагностикой ошибки классифицируются согласно ГОСТ Р 71207–2024 как критические и относятся к типу: Ошибки при работе с многопоточными примитивами (интерфейсами запуска потоков на выполнение, синхронизации и обмена данными между потоками и пр.).

Данная диагностика классифицируется как:

CWE-821