Герберт Шилдт - C# 4.0 - полное руководство

' Признак отмены является экземпляром объекта типа CancellationToken, т.е. структуры, определенной в пространстве имен System.Threading. В структуре CancellationTokenопределено несколько свойств и методов, но мы воспользуемся двумя из них. Во-первых, это доступное только для чтения свойство IsCancellationRequested, которое объявляется следующим образом.

public bool IsCancellationRequested { get; }

Оно возвращает логическое значение true, если отмена задачи была запрошена для вызывающего признака, а иначе — логическое значение false. И во-вторых, это метод ThrowIfCancellationRequested(), который объявляется следующим образом.

public void ThrowIfCancellationRequested()

Если признак отмены, для которого вызывается этот метод, получил запрос на отмену, то в данном методе генерируется исключение OperationCanceledException. В противном случае никаких действий не выполняется. В отменяющем коде можно организовать отслеживание упомянутого исключения с целью убедиться в том, что отмена задачи действительно произошла. Как правило, с этой целью сначала перехватывается исключение AggregateException, а затем его внутреннее исключение анализируется с помощью свойства InnerExceptionили InnerExceptions. (Свойство InnerExceptionsпредставляет собой коллекцию исключений. Подробнее о коллекциях речь пойдет в главе 25.)

Признак отмены получается из источника признаков отмены, который представляет собой объект класса CancellationTokenSource, определенного в пространстве имен System.Threading. Для того чтобы получить данный признак, нужно создать сначала экземпляр объекта типа CancellationTokenSource. (С этой целью можно воспользоваться вызываемым по умолчанию конструктором класса CancellationTokenSource.) Признак отмены, связанный сданным источником, оказывается доступным через используемое только для чтения свойство Token, которое объявляется следующим образом.

public CancellationToken Token { get; }

Это и есть тот признак, который должен быть передан отменяемой задаче.

Для отмены в задаче должна быть получена копия признака отмены и организован контроль этого признака с целью отслеживать саму отмену. Такое отслеживание можно организовать тремя способами: опросом, методом обратного вызова и с помощью дескриптора ожидания. Проще всего организовать опрос, и поэтому здесь будет рассмотрен именно этот способ. С целью опроса в задаче проверяется упомянутое выше свойство IsCancellationRequestedпризнака отмены. Если это свойство содержит логическое значение true, значит, отмена была запрошена, и задача должна быть завершена. Опрос может оказаться весьма эффективным, если организовать его правильно. Так, если задача содержит вложенные циклы, то проверка свойства IsCancellationRequestedво внешнем цикле зачастую дает лучший результат, чем его проверка на каждом шаге внутреннего цикла.

Для создания задачи, из которой вызывается метод ThrowIfCancellationRequested(), когда она отменяется, обычно требуется передать признак отмены как самой задаче, так и конструктору класса Task, будь то непосредственно или же косвенно через метод StartNew(). Передача признака отмены самой задаче позволяет изменить состояние отменяемой задачи в запросе на отмену из внешнего кода. Далее будет использована следующая форма метода StartNew().

public Task StartNew(Action action, Object состояние,

CancellationToken признак_отмены)

В этой форме признак отмены передается через параметры, обозначаемые как состояние и признак_отмены. Это означает, что признак отмены будет передан как делегату, реализующему задачу, так и самому экземпляру объекта типа Task. Ниже приведена форма, поддерживающая делегат Action.

public delegate void Actioncin T>(T obj)

В данном случае обобщенный параметр Т обозначает тип Object. В силу этого объект obj должен быть приведен внутри задачи к типу CancellationToken.

И еще одно замечание: по завершении работы с источником признаков отмены следует освободить его ресурсы, вызвав метод Dispose().

Факт отмены задачи может быть проверен самыми разными способами. Здесь применяется следующий подход: проверка значения свойства IsCanceledдля экземпляра объекта типа Task. Если это логическое значение true, то задача была отменена.

В приведенной ниже программе демонстрируется отмена задачи. В ней применяется опрос для контроля состояния признака отмены. Обратите внимание на то, что метод ThrowIfCancellationRequested()вызывается после входа в метод MyTask(). Это дает возможность завершить задачу, если она была отмена еще до ее запуска. Внутри цикла проверяется свойство IsCancellationRequested. Если это свойство содержит логическое значение true, а оно устанавливается после вызова метода Cancel()для экземпляра источника признаков отмены, то на экран выводится сообщение об отмене и далее вызывается метод ThrowIfCancellationRequested()для отмены задачи.