CancellationToken.IsCancellationRequested プロパティ

定義

このトークンに対して取り消しが要求されたかどうかを取得します。

public:
 property bool IsCancellationRequested { bool get(); };
public bool IsCancellationRequested { get; }
member this.IsCancellationRequested : bool
Public ReadOnly Property IsCancellationRequested As Boolean

プロパティ値

Boolean

このトークンに対して取り消しが要求されている場合は true。それ以外の場合は false

プロパティが を返すまでサーバー プロセスを実行する簡単な例を次に IsCancellationRequested 示します true

using System;
using System.Threading;

public class ServerClass
{
   public static void StaticMethod(object obj)
   {
      CancellationToken ct = (CancellationToken)obj;
      Console.WriteLine("ServerClass.StaticMethod is running on another thread.");

      // Simulate work that can be canceled.
      while (!ct.IsCancellationRequested) {
         Thread.SpinWait(50000);
      }
      Console.WriteLine("The worker thread has been canceled. Press any key to exit.");
      Console.ReadKey(true);
   }
}

public class Simple
{
   public static void Main()
   {
      // The Simple class controls access to the token source.
      CancellationTokenSource cts = new CancellationTokenSource();

      Console.WriteLine("Press 'C' to terminate the application...\n");
      // Allow the UI thread to capture the token source, so that it
      // can issue the cancel command.
      Thread t1 = new Thread(() => { if (Console.ReadKey(true).KeyChar.ToString().ToUpperInvariant() == "C")
                                     cts.Cancel(); } );

      // ServerClass sees only the token, not the token source.
      Thread t2 = new Thread(new ParameterizedThreadStart(ServerClass.StaticMethod));
      // Start the UI thread.

      t1.Start();

      // Start the worker thread and pass it the token.
      t2.Start(cts.Token);

      t2.Join();
      cts.Dispose();
   }
}
// The example displays the following output:
//       Press 'C' to terminate the application...
//
//       ServerClass.StaticMethod is running on another thread.
//       The worker thread has been canceled. Press any key to exit.
Imports System.Threading

Public Class ServerClass
   Public Shared Sub StaticMethod(obj As Object)
      Dim ct AS CancellationToken = CType(obj, CancellationToken)
      Console.WriteLine("ServerClass.StaticMethod is running on another thread.")

      ' Simulate work that can be canceled.
      While Not ct.IsCancellationRequested
         Thread.SpinWait(50000)
      End While
      Console.WriteLine("The worker thread has been canceled. Press any key to exit.")
      Console.ReadKey(True)
   End Sub
End Class

Public Class Simple
   Public Shared Sub Main()
      ' The Simple class controls access to the token source.
      Dim cts As New CancellationTokenSource()

      Console.WriteLine("Press 'C' to terminate the application..." + vbCrLf)
      ' Allow the UI thread to capture the token source, so that it
      ' can issue the cancel command.
      Dim t1 As New Thread( Sub()
                               If Console.ReadKey(true).KeyChar.ToString().ToUpperInvariant() = "C" Then
                                  cts.Cancel()
                               End If
                            End Sub)

      ' ServerClass sees only the token, not the token source.
      Dim t2 As New Thread(New ParameterizedThreadStart(AddressOf ServerClass.StaticMethod))

      ' Start the UI thread.
      t1.Start()

      ' Start the worker thread and pass it the token.
      t2.Start(cts.Token)

      t2.Join()
      cts.Dispose()
   End Sub
End Class
' The example displays the following output:
'       Press 'C' to terminate the application...
'
'       ServerClass.StaticMethod is running on another thread.
'       The worker thread has been canceled. Press any key to exit.

この例では、キャンセル トークンへのアクセスを CancellationTokenSource 制御する オブジェクトをインスタンス化します。 次に、2 つのスレッド プロシージャを定義します。 1 つ目は、キーボードをプールするラムダ式として定義され、"C" キーが押されると、 を呼び出 CancellationTokenSource.Cancel してキャンセル トークンを取り消された状態に設定します。 2 つ目は、 ServerClass.StaticMethodプロパティが になるまで IsCancellationRequested ループを実行するパラメーター化メソッド です true

その後、メイン スレッドは 2 つのスレッドを開始し、メソッドを実行 ServerClass.StaticMethod するスレッドが終了するまでブロックします。

注釈

このプロパティは、取り消された状態で最初に構築されたトークンを使用するか、トークンに関連付けられている CancellationTokenSourceを呼び出すことによって、このトークンに対して取り消しCancelが要求されたかどうかを示します。

このプロパティが の場合、 true取り消しが要求されたことのみが保証されます。 すべての登録済みハンドラーの実行が完了したわけではありません。また、キャンセル要求が登録されているすべてのハンドラーへの伝達を完了したわけではありません。 特に、関連オブジェクトが同時に取り消される状況では、追加の同期が必要になる場合があります。

適用対象

こちらもご覧ください