다음을 통해 공유


CancellationToken 구조체

정의

작업을 취소하지 않아야 함을 전파합니다.

public value class CancellationToken
public value class CancellationToken : IEquatable<System::Threading::CancellationToken>
public struct CancellationToken
public readonly struct CancellationToken
public readonly struct CancellationToken : IEquatable<System.Threading.CancellationToken>
[System.Runtime.InteropServices.ComVisible(false)]
public struct CancellationToken
type CancellationToken = struct
[<System.Runtime.InteropServices.ComVisible(false)>]
type CancellationToken = struct
Public Structure CancellationToken
Public Structure CancellationToken
Implements IEquatable(Of CancellationToken)
상속
CancellationToken
특성
구현

예제

다음 예제에서는 정수 값 10 11 개의 다양 한 계측에서 읽는 데이터 컬렉션 애플리케이션을 에뮬레이트 하려면 난수 생성기를 사용 합니다. 값이 0이면 하나의 계측에 대해 측정이 실패했음을 나타냅니다. 이 경우 작업을 취소해야 하며 전체 평균을 계산하지 않아야 합니다.

작업의 가능한 취소를 처리하기 위해 예제에서는 개체에 전달되는 취소 토큰을 생성하는 개체를 TaskFactory 인스턴스화 CancellationTokenSource 합니다. 그러면 개체가 TaskFactory 취소 토큰을 특정 계측에 대한 판독값 수집을 담당하는 각 작업에 전달합니다. 메서드 TaskFactory.ContinueWhenAll<TAntecedentResult,TResult>(Task<TAntecedentResult>[], Func<Task<TAntecedentResult>[],TResult>, CancellationToken) 는 모든 판독값이 성공적으로 수집된 후에만 평균이 계산되도록 호출됩니다. 작업이 취소되어 완료되지 않은 경우 메서드는 TaskFactory.ContinueWhenAll 예외를 throw합니다.

using System;
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;

public class Example
{
   public static void Main()
   {
      // Define the cancellation token.
      CancellationTokenSource source = new CancellationTokenSource();
      CancellationToken token = source.Token;

      Random rnd = new Random();
      Object lockObj = new Object();
      
      List<Task<int[]>> tasks = new List<Task<int[]>>();
      TaskFactory factory = new TaskFactory(token);
      for (int taskCtr = 0; taskCtr <= 10; taskCtr++) {
         int iteration = taskCtr + 1;
         tasks.Add(factory.StartNew( () => {
           int value;
           int[] values = new int[10];
           for (int ctr = 1; ctr <= 10; ctr++) {
              lock (lockObj) {
                 value = rnd.Next(0,101);
              }
              if (value == 0) { 
                 source.Cancel();
                 Console.WriteLine("Cancelling at task {0}", iteration);
                 break;
              }   
              values[ctr-1] = value; 
           }
           return values;
        }, token));   
      }
      try {
         Task<double> fTask = factory.ContinueWhenAll(tasks.ToArray(), 
         (results) => {
            Console.WriteLine("Calculating overall mean...");
            long sum = 0;
            int n = 0; 
            foreach (var t in results) {
               foreach (var r in t.Result) {
                  sum += r;
                  n++;
               }
            }
            return sum/(double) n;
         } , token);
         Console.WriteLine("The mean is {0}.", fTask.Result);
      }   
      catch (AggregateException ae) {
         foreach (Exception e in ae.InnerExceptions) {
            if (e is TaskCanceledException)
               Console.WriteLine("Unable to compute mean: {0}", 
                  ((TaskCanceledException) e).Message);
            else
               Console.WriteLine("Exception: " + e.GetType().Name);
         }
      }
      finally {
         source.Dispose();
      }
   }
}
// Repeated execution of the example produces output like the following:
//       Cancelling at task 5
//       Unable to compute mean: A task was canceled.
//       
//       Cancelling at task 10
//       Unable to compute mean: A task was canceled.
//       
//       Calculating overall mean...
//       The mean is 5.29545454545455.
//       
//       Cancelling at task 4
//       Unable to compute mean: A task was canceled.
//       
//       Cancelling at task 5
//       Unable to compute mean: A task was canceled.
//       
//       Cancelling at task 6
//       Unable to compute mean: A task was canceled.
//       
//       Calculating overall mean...
//       The mean is 4.97363636363636.
//       
//       Cancelling at task 4
//       Unable to compute mean: A task was canceled.
//       
//       Cancelling at task 5
//       Unable to compute mean: A task was canceled.
//       
//       Cancelling at task 4
//       Unable to compute mean: A task was canceled.
//       
//       Calculating overall mean...
//       The mean is 4.86545454545455.
Imports System.Collections.Generic
Imports System.Threading
Imports System.Threading.Tasks

Module Example
   Public Sub Main()
      ' Define the cancellation token.
      Dim source As New CancellationTokenSource()
      Dim token As CancellationToken = source.Token

      Dim lockObj As New Object()
      Dim rnd As New Random

      Dim tasks As New List(Of Task(Of Integer()))
      Dim factory As New TaskFactory(token)
      For taskCtr As Integer = 0 To 10
         Dim iteration As Integer = taskCtr + 1
         tasks.Add(factory.StartNew(Function()
                                       Dim value, values(9) As Integer
                                       For ctr As Integer = 1 To 10
                                          SyncLock lockObj
                                             value = rnd.Next(0,101)
                                          End SyncLock
                                          If value = 0 Then 
                                             source.Cancel
                                             Console.WriteLine("Cancelling at task {0}", iteration)
                                             Exit For
                                          End If   
                                          values(ctr-1) = value 
                                       Next
                                       Return values
                                    End Function, token))   
         
      Next
      Try
         Dim fTask As Task(Of Double) = factory.ContinueWhenAll(tasks.ToArray(), 
                                                         Function(results)
                                                            Console.WriteLine("Calculating overall mean...")
                                                            Dim sum As Long
                                                            Dim n As Integer 
                                                            For Each t In results
                                                               For Each r In t.Result
                                                                  sum += r
                                                                  n+= 1
                                                               Next
                                                            Next
                                                            Return sum/n
                                                         End Function, token)
         Console.WriteLine("The mean is {0}.", fTask.Result)
      Catch ae As AggregateException
         For Each e In ae.InnerExceptions
            If TypeOf e Is TaskCanceledException
               Console.WriteLine("Unable to compute mean: {0}", 
                                 CType(e, TaskCanceledException).Message)
            Else
               Console.WriteLine("Exception: " + e.GetType().Name)
            End If   
         Next
      Finally
         source.Dispose()
      End Try                                                          
   End Sub
End Module
' Repeated execution of the example produces output like the following:
'       Cancelling at task 5
'       Unable to compute mean: A task was canceled.
'       
'       Cancelling at task 10
'       Unable to compute mean: A task was canceled.
'       
'       Calculating overall mean...
'       The mean is 5.29545454545455.
'       
'       Cancelling at task 4
'       Unable to compute mean: A task was canceled.
'       
'       Cancelling at task 5
'       Unable to compute mean: A task was canceled.
'       
'       Cancelling at task 6
'       Unable to compute mean: A task was canceled.
'       
'       Calculating overall mean...
'       The mean is 4.97363636363636.
'       
'       Cancelling at task 4
'       Unable to compute mean: A task was canceled.
'       
'       Cancelling at task 5
'       Unable to compute mean: A task was canceled.
'       
'       Cancelling at task 4
'       Unable to compute mean: A task was canceled.
'       
'       Calculating overall mean...
'       The mean is 4.86545454545455.

설명

A CancellationToken 를 사용하면 스레드, 스레드 풀 작업 항목 또는 Task 개체 간에 협조적 취소가 가능합니다. 속성에서 검색된 취소 토큰을 CancellationTokenSource 관리하는 개체를 인스턴스화하여 취소 토큰을 CancellationTokenSource.Token 만듭니다. 그런 다음 취소 알림을 받아야 하는 스레드, 작업 또는 작업 수에 취소 토큰을 전달합니다. 토큰을 사용하여 취소를 시작할 수 없습니다. 소유 개체가 호출 CancellationTokenSource.CancelIsCancellationRequested 되면 취소 토큰의 모든 복사본에 있는 속성이 로 설정true됩니다. 알림을 받는 개체는 적절한 방식으로 응답할 수 있습니다.

자세한 내용 및 코드 예제는 Managed Threads의 취소를 참조하세요.

생성자

CancellationToken(Boolean)

CancellationToken을 초기화합니다.

속성

CanBeCanceled

이 토큰이 취소된 상태로 있을 수 있는지 여부를 가져옵니다.

IsCancellationRequested

이 토큰의 취소가 요청되었는지 여부를 가져옵니다.

None

CancellationToken 값을 반환합니다.

WaitHandle

토큰이 취소될 때 신호를 받는 WaitHandle을 가져옵니다.

메서드

Equals(CancellationToken)

현재 CancellationToken 인스턴스와 지정한 토큰이 같은지 여부를 확인합니다.

Equals(Object)

현재 CancellationToken 인스턴스와 지정한 Object가 같은지 여부를 확인합니다.

GetHashCode()

CancellationToken의 해시 함수 역할을 수행합니다.

Register(Action)

CancellationToken이 취소될 때 호출할 대리자를 등록합니다.

Register(Action, Boolean)

CancellationToken이 취소될 때 호출할 대리자를 등록합니다.

Register(Action<Object,CancellationToken>, Object)

CancellationToken 이 취소될 때 호출될 대리자를 등록합니다.

Register(Action<Object>, Object)

CancellationToken이 취소될 때 호출할 대리자를 등록합니다.

Register(Action<Object>, Object, Boolean)

CancellationToken이 취소될 때 호출할 대리자를 등록합니다.

ThrowIfCancellationRequested()

이 토큰의 취소가 요청된 경우 OperationCanceledException이 발생합니다.

UnsafeRegister(Action<Object,CancellationToken>, Object)

CancellationToken 이 취소될 때 호출될 대리자를 등록합니다.

UnsafeRegister(Action<Object>, Object)

CancellationToken이 취소될 때 호출되는 대리자를 등록합니다.

연산자

Equality(CancellationToken, CancellationToken)

두 개의 CancellationToken 인스턴스가 같은지 여부를 확인합니다.

Inequality(CancellationToken, CancellationToken)

CancellationToken 인스턴스가 서로 다른지 여부를 확인합니다.

적용 대상

스레드 보안

모든 공용 및 보호된 멤버 CancellationToken 는 스레드로부터 안전하며 여러 스레드에서 동시에 사용할 수 있습니다.

추가 정보