タスクで使用されているキャンセルトークンをキャンセルする正しい方法はありますか?


10

キャンセルトークンを作成するコードがあります

public partial class CardsTabViewModel : BaseViewModel
{
   public CancellationTokenSource cts;

public async Task OnAppearing()
{
   cts = new CancellationTokenSource(); // << runs as part of OnAppearing()

それを使用するコード:

await GetCards(cts.Token);


public async Task GetCards(CancellationToken ct)
{
    while (!ct.IsCancellationRequested)
    {
        App.viewablePhrases = App.DB.GetViewablePhrases(Settings.Mode, Settings.Pts);
        await CheckAvailability();
    }
}

上記のコードが実行されている画面からユーザーが離れた場合、このキャンセルトークンを後でキャンセルするコード:

public void OnDisappearing()
{
   cts.Cancel();

キャンセルに関して、これがタスクで使用されているときにトークンをキャンセルする正しい方法ですか?

特に私はこの質問をチェックしました:

IsCancellationRequestedプロパティの使用?

そして、私はキャンセルを正しい方法で、またはおそらく例外を引き起こす可能性のある方法で行っていないと私に思わせています。

また、この場合、キャンセルした後、cts.Dispose()を実行する必要がありますか?


通常、Cancelメソッドを使用してキャンセルの要求を通知し、Disposeメソッドを使用してメモリを解放します。リンクでサンプルを確認できます。docs.microsoft.com/en-us/dotnet/api/...
ウェンディのZang - MSFT

回答:


2

CancellationTokenSource.Cancel() キャンセルを開始する有効な方法です。

ポーリングct.IsCancellationRequestedはスローを回避しOperationCanceledExceptionます。ポーリングであるため、キャンセル要求に応答する前に、ループを繰り返す必要があります。

もしGetViewablePhrases()およびCheckAvailability()を受け入れてを受け入れるように変更できるCancellationToken、これにより、OperationCanceledExceptionスローを犠牲にしてキャンセルの応答が速くなるます。

「cts.Dispose()を実行する必要がありますか?」それほど簡単ではありません...

「IDisposablesは常にできるだけ早く破棄してください」

ルールというよりもガイドラインです。 Taskそれ自体は使い捨てですが、コードに直接配置されることはほとんどありません。

場合があります( WaitHandle破棄ctsリソースが解放されるか、GCルートが削除される場合があります(それ以外の場合はファイナライザによってのみ解放されます)。現状ではこれらはコードには適用されませんが、将来的には適用される可能性があります。

への通話の追加 Disposeキャンセル後に、これらのリソースが将来のバージョンのコードですぐに解放されることが保証されます。

ただし、を使用ctsするコードが完了するのを待ってからdisposeを呼び出すか、またはコードを変更して、disposeのObjectDisposedException使用cts(またはそのトークン)を処理する必要があります。


「OnDisappearingをフックしてctsを破棄する」別のタスク内でまだ使用されているため、非常に悪い考えのようです。特に、後で誰かが設計を変更した場合(CancellationTokenパラメーターを受け入れるようにサブタスクを変更した場合)、WaitHandle別のスレッドがアクティブに待機している間にを破棄する可能性があります:(
Ben Voigt

1
あなたは「処分として行い、同じクリーンアップを取り消す」という主張をしたので、特に、呼び出すことが無意味だろうDisposeからOnDisappearing
Ben Voigt

おっと、私は答えのコードがすでに呼び出しているのを逃しましたCancel...
Peter Wishart

同じクリーンアップ(他の場所で読みました)のキャンセルについての主張を削除しました。クリーンアップCancelが行うのは内部タイマー(使用する場合)だけであることがわかる限りです。
Peter Wishart

3

一般に、コードでキャンセルトークンを公正に使用しているようですが、タスク非同期パターンによると、コードはすぐにはキャンセルされない可能性があります。

while (!ct.IsCancellationRequested)
{
   App.viewablePhrases = App.DB.GetViewablePhrases(Settings.Mode, Settings.Pts);
   await CheckAvailability();   //Your Code could be blocked here, unable to cancel
}

すぐに応答するには、ブロックコードもキャンセルする必要があります

await CheckAvailability(ct);   //Your blocking code in the loop also should be stoped

破棄する必要があるかどうかはあなた次第です。中断されたコードで予約されているメモリリソースが多い場合は、破棄する必要があります。


1
実際、これはGetViewablePhrasesの呼び出しにも適用されます。理想的には、これも非同期呼び出しであり、オプションとしてキャンセルトークンを受け取ります。
Paddy

1

CanncelationTokenで待機メソッドを処理する方法を完全に理解するには、.netクラスの1つを調べることをお勧めします。SeamaphoreSlim.csを取得しました

    public bool Wait(int millisecondsTimeout, CancellationToken cancellationToken)
    {
        CheckDispose();

        // Validate input
        if (millisecondsTimeout < -1)
        {
            throw new ArgumentOutOfRangeException(
                "totalMilliSeconds", millisecondsTimeout, GetResourceString("SemaphoreSlim_Wait_TimeoutWrong"));
        }

        cancellationToken.ThrowIfCancellationRequested();

        uint startTime = 0;
        if (millisecondsTimeout != Timeout.Infinite && millisecondsTimeout > 0)
        {
            startTime = TimeoutHelper.GetTime();
        }

        bool waitSuccessful = false;
        Task<bool> asyncWaitTask = null;
        bool lockTaken = false;

        //Register for cancellation outside of the main lock.
        //NOTE: Register/deregister inside the lock can deadlock as different lock acquisition orders could
        //      occur for (1)this.m_lockObj and (2)cts.internalLock
        CancellationTokenRegistration cancellationTokenRegistration = cancellationToken.InternalRegisterWithoutEC(s_cancellationTokenCanceledEventHandler, this);
        try
        {
            // Perf: first spin wait for the count to be positive, but only up to the first planned yield.
            //       This additional amount of spinwaiting in addition
            //       to Monitor.Enter()’s spinwaiting has shown measurable perf gains in test scenarios.
            //
            SpinWait spin = new SpinWait();
            while (m_currentCount == 0 && !spin.NextSpinWillYield)
            {
                spin.SpinOnce();
            }
            // entering the lock and incrementing waiters must not suffer a thread-abort, else we cannot
            // clean up m_waitCount correctly, which may lead to deadlock due to non-woken waiters.
            try { }
            finally
            {
                Monitor.Enter(m_lockObj, ref lockTaken);
                if (lockTaken)
                {
                    m_waitCount++;
                }
            }

            // If there are any async waiters, for fairness we'll get in line behind
            // then by translating our synchronous wait into an asynchronous one that we 
            // then block on (once we've released the lock).
            if (m_asyncHead != null)
            {
                Contract.Assert(m_asyncTail != null, "tail should not be null if head isn't");
                asyncWaitTask = WaitAsync(millisecondsTimeout, cancellationToken);
            }
                // There are no async waiters, so we can proceed with normal synchronous waiting.
            else
            {
                // If the count > 0 we are good to move on.
                // If not, then wait if we were given allowed some wait duration

                OperationCanceledException oce = null;

                if (m_currentCount == 0)
                {
                    if (millisecondsTimeout == 0)
                    {
                        return false;
                    }

                    // Prepare for the main wait...
                    // wait until the count become greater than zero or the timeout is expired
                    try
                    {
                        waitSuccessful = WaitUntilCountOrTimeout(millisecondsTimeout, startTime, cancellationToken);
                    }
                    catch (OperationCanceledException e) { oce = e; }
                }

                // Now try to acquire.  We prioritize acquisition over cancellation/timeout so that we don't
                // lose any counts when there are asynchronous waiters in the mix.  Asynchronous waiters
                // defer to synchronous waiters in priority, which means that if it's possible an asynchronous
                // waiter didn't get released because a synchronous waiter was present, we need to ensure
                // that synchronous waiter succeeds so that they have a chance to release.
                Contract.Assert(!waitSuccessful || m_currentCount > 0, 
                    "If the wait was successful, there should be count available.");
                if (m_currentCount > 0)
                {
                    waitSuccessful = true;
                    m_currentCount--;
                }
                else if (oce != null)
                {
                    throw oce;
                }

                // Exposing wait handle which is lazily initialized if needed
                if (m_waitHandle != null && m_currentCount == 0)
                {
                    m_waitHandle.Reset();
                }
            }
        }
        finally
        {
            // Release the lock
            if (lockTaken)
            {
                m_waitCount--;
                Monitor.Exit(m_lockObj);
            }

            // Unregister the cancellation callback.
            cancellationTokenRegistration.Dispose();
        }

        // If we had to fall back to asynchronous waiting, block on it
        // here now that we've released the lock, and return its
        // result when available.  Otherwise, this was a synchronous
        // wait, and whether we successfully acquired the semaphore is
        // stored in waitSuccessful.

        return (asyncWaitTask != null) ? asyncWaitTask.GetAwaiter().GetResult() : waitSuccessful;
    }

ここでクラス全体を表示することもできます。https://referencesource.microsoft.com/#mscorlib/system/threading/SemaphoreSlim.cs,6095d9030263f169

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.