[C#] Task Cancellation

 

.NET Documentation의 Task Cancellation 번역 및 내용 추가하여 정리한 글

---

작업 취소하기

Task와 Task<TResult> 클래스에서 취소 토큰을 사용하여 Task를 취소할 수 있습니다. (관리되는 스레드 취소하기 참고) Task 클래스에서 Cancellation은 실행 중 취소될 delegate(Task로 등록된 실행 함수의 참조)와 취소를 요청한 코드의 상호 작용으로 진행됩니다. 취소 요청 코드에서 CancellationTokenSource.Cancel() 메서드를 호출한 뒤 사용자 delegate가 원하는 시점에 종료되었다면, 작업이 성공적으로 취소된 것입니다. 

 

작업 종료하기는 다음과 같은 두 가지 방법이 있습니다.

대부분의 경우 delegate가 return에 도달해 종료되는 일반적인 방식을 사용합니다. 그러나 이렇게 종료된 작업 인스턴스는 Canceled(취소)가 아니라 RanToCompletion(성공적으로 종료) 상태로 전환됩니다.

delegate를 취소 상태로 만들기 위해서는 실행 취소 예외를 발생시켜 취소가 요청된 토큰을 delegate에 전달하면 됩니다. 보통 ThrowIfCancellationRequested() 메서드를 사용합니다. 이후, 취소 요청(실행 취소 예외)을 보낸 코드에서 delegate의 상태가 취소가 될때까지 모니터링하는 구조입니다.

 

 

아래는 실행 취소 예외를 사용하는 Task 취소 방식의 기본적인 예제입니다. 토큰은 delegate와 작업 인스턴스에 전달됩니다.

using System;
using System.Threading;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        var tokenSource2 = new CancellationTokenSource();
        CancellationToken ct = tokenSource2.Token;

        var task = Task.Run(() =>
        // Task로 실행할 delegate 정의
        {
            // 이미 취소된 작업인지 확인
            ct.ThrowIfCancellationRequested();

            bool moreToDo = true;
            while (moreToDo)
            {
                // 예외처리 전 진행해야하는 초기화 작업이 있다면
                // IsCancellationRequested 값을 체크하는 If문 추가
                if (ct.IsCancellationRequested)
                {
                    // 초기화 작업을 진행한 뒤...
                    ct.ThrowIfCancellationRequested();
                }
            }
        }, tokenSource2.Token); // Task에도 같은 토큰을 전달


        // 코드에서 취소 요청 실행!
        tokenSource2.Cancel();

        // 해당 스레드에서 계속 진행해도 되고,
        // try-catch문에서 작업(task)을 대기해도 된다.
        try
        {
            await task;
        }
        catch (OperationCanceledException e)
        {
            Console.WriteLine($"{nameof(OperationCanceledException)} thrown with message: {e.Message}");
        }
        finally
        {
            tokenSource2.Dispose();
        }

        Console.ReadKey();
    }
}

Task와 child Task를 취소하는 방법이라는 글에서 자세한 예제를 확인할 수 있습니다.

 

작업 인스턴스는 사용자 코드가 실행 취소 예외를 보내면 받은 토큰과 자신이 연결되어 있는(작업 생성 시 인자로 받은) 토큰을 비교합니다. 만약 두 토큰이 서로 같고 토큰의 IsCancellationRequested 값이 true이면, 유효한 요청으로 해석하고 Task를 취소 상태로 전환합니다.

 

그러나 Wait이나 WaitAll 때문에 작업 대기가 진행된다면, 작업 취소 예외가 실행됩니다. 이 예외는 문제가 생겼다는 것을 의미하는 것이 아니라 취소가 성공적으로 완수되었다는 것을 의미합니다. 따라서 Task의 예외 값은 null입니다.

 

만약 예외가 감지된 토큰과 Task의 토큰이 서로 다르거나 토큰의 IsCancellationRequested값이 false라면,  예외는 일반적인 예외로 취급됩니다. 따라서 Task는 실패 상태로 전환됩니다. 완수된 Task의 상태는 Status 프로퍼티에서 확인할 수 있습니다.

 

취소 요청을 받을지라도 Task가 일부 항목을 계속 처리하는 경우가 있을 수 있습니다.

 

 

4줄 요약

1. TokenSource에서 취소 토큰을 생성하고, 이 토큰을 Task와 이 Task에서 실행할 delegate에 전달한다.

2. delegate에는 발급받은 취소 토큰의 상태를 모니터링하는 구문을 추가한다.

3. delegate가 종료되기 원하는 시점에서 취소 토큰 예외를 던지는 구문을 추가한다.

4. Task가 실행되는 Level(3이 있는 레벨)의 코드에서는 (try-catch문 등으로) 토큰의 예외를 체크하다가, 예외가 생기면 TokenSource를 폐기하도록 한다.

 

 

Dispose  vs  Cancel

취소 토큰 소스를 Dispose 하거나 Cancel 하거나, 둘 다 Task를 종료하고 Cancel 상태로 전환시킨다. 그런데 굳이 토큰 소스를 Cancel 하는 이유가 뭘까.

 

한번 토큰을 만든 뒤 TokenSource를 더 사용하지 않는다면 크게 상관이 없다. 그러나 Source가 토큰을 계속 만들 수도 있는 상황에서 Dispose로 Source를 폐기한다면, Dispose 실행과 토큰 생성 작업 간 Race Condition이 발생할 수 있다. 이런 경우를 방지하기 위한 전처리 확인 수단으로 Cancel 작업이 존재한다. (이 문단의 내용은 틀릴 수도 있음)

 

 

---

참고자료

• Docs: Task(작업) 취소하기
• Docs: Task와 Child Task 취소하기
• 취소 토큰 소스 Cancel과 Dispose 순서
• Dispose를 직접 사용할 경우 생기는 문제