Как мгновенно завершить Task?

Question

[Nikolay Khablenko]

Всем привет. Может кто то откликнется на мой вопрос. В общем разрабатываю приложение, WPF, в окне есть три элемента IMAGE. Есть флаг анимаций. Если флаг выключен - то в Image вывожу обычные файлы PNG.
Так же на картинки есть анимации, но не на все. Например на 1 и 3 есть анимация а на 2 нету.
Если флаг включен, то я вывожу обратно все PNG, а после, с помощью Task(поскольку wpf не поддерживает GIF, вывожу в отдельном потоке через перерисовку каждого фрейма), запускаю анимацию. Вся соль заключается в том, что, иногда поток остается, и при выборе других картинок и анимаций, в элементе подвисает фрейм предыдущей анимации.
Вопрос - как можно полностью, и желательно, мгновенно, завершить TASKи чтобы он не висел в памяти

Вот код самого Вывода

static CancellationTokenSource cancelTokenSource3 = new CancellationTokenSource();
        CancellationToken token3 = cancelTokenSource3.Token;
        public Task th_Image3;

        volatile bool volatileComplette1 = false;
        volatile bool volatileComplette2 = false;
        volatile bool volatileComplette3 = false;

                GifBitmapDecoder decoder3;
                BitmapSource bitmapSource3;
                int frameCount3;


                            th_Image3 = new Task(() =>
                            {
                                while (!volatileComplette3)
                                {
                                   
                                    if (token3.IsCancellationRequested)
                                    {
                                        return;
                                    }
                                    for (int c = 0; ((c < frameCount3)&& (!volatileComplette3)); c++)
                                    {
                                       
                                        this.Dispatcher.Invoke(new Action(delegate ()
                                        {
                                            bitmapSource3 = decoder3.Frames[c];
                                            Image_Right.Source = bitmapSource3;
                                            
                                            if (token3.IsCancellationRequested)
                                            {
                                                return;
                                            }
                                        }));
                                        System.Threading.Thread.Sleep(30);
                                        if (token3.IsCancellationRequested)
                                        {
                                            return;
                                        }

                                    }
                                
                              
                                    if (token3.IsCancellationRequested)
                                    {
                                        return;
                                    }
                                }
                         
                            }, token3);
                            th_Image3.Start();

Answer 1

[Алексей Березников]

Извините, что не отвечаю на ваш вопрос - а почему не используете https://github.com/XamlAnimatedGif/XamlAnimatedGif ?

По делу - если мне не изменяет память, нет простого способа прибить Task, для этого нужно использовать CancellationTokenSource, что вы и делаете в приведенном примере. Если отмена через CancellationTokenSource не срабатывает по какой-то причине - поставьте брейкпоинты или навтыкайте логов через каждую строку, найдите проблемное место, и уже исходя из этой информации решайте.
Исходя из вашей проблемы, для начала после отмены можно просто подождать завершения таска:

// Метод в котором останавливаете анимацию
cancellationTokenSource3.Cancel();
await th_Image3;

или

// Метод в котором останавливаете анимацию
cancellationTokenSource3.Cancel();
th_Image3.GetAwaiter().GetResult();

Так вы по-крайней мере должны избавиться от наложения тасков друг на друга.

Далее, таски можно чуть-чуть проще запускать, вот так:

th_Image3 = Task.Run(() => 
{ 
    // ......
});

Кроме того, если вам действительно нужно, чтобы код внутри Task.Run всегда выполнялся только в единственном экземпляре - это значит, что вам нужна критическая секция. В данном случае можно сделать при помощи семафоров:

// ......................
Semaphore _semaphore = new Semaphore(1, 1);
// ......................
th_Image3 = Task.Run(() =>
{
    _semaphore.WaitOne();

    try
    {
        // Показ GIF
    }
    finally
    {
        _semaphore.Release();
    }
});

Или же можно использовать метод ContinueWith, чтобы организовать какое-то подобие очереди задач:

// .................................................
Task th_Image3 = Task.FromResult(0);
// .................................................
th_Image3 = th_Image3.ContinueWith(() => 
{
    // Отображение GIF
});

В общем много чего можно сделать, проще всего не изобретать велосипед и взять готовое решение.

Comments

[Nikolay Khablenko]

Добрый день. Спасибо за ответ. Мне наоборот, не нужно дожидаться завершение TASK. У меня, по кнопке, берется другая информация, и другие файлы Png, GIF, и иногда просто остается кадр прошлой анимации. Мне не нужно дожидаться завершения.
По поводу https://github.com/XamlAnimatedGif/XamlAnimatedGif - а в него можно пихать, так как я пихаю в image и картинки и анимации?

[Алексей Березников]

NikolayKhablenko,
Я не уверен, однако он использует AttachedProperty для указания исходной анимации, т. е. выводит в ваш Image, который по идее всё остальное умеет сам показывать

[Алексей Березников]

NikolayKhablenko,
Скачайте репозиторий, соберите демо-проект, посмотрите есть ли то что вам нужно

[Петр]

Очень плохой подход помещать обьекты синхронизации, как в вашем случае Semaphore, в тело Task-а.
Также и у автора вопроса System.Threading.Thread.Sleep(30);

[Алексей Березников]

Петр, Как раз семафор можно помещать внутри Task, т. к. этот примитив синхронизации не обладает thread affinity - а значит, отработает, как и ожидается.

[Петр]

Алексей Березников, У вас поток Task-а будет на _semaphore.WaitOne(); заблокирован, пока захваченый семафор не будет освобожден. А так как Task-и запускаются в пуле потоков, а в .net пул потоков ограничен максимум 1000 потоков, то в определенные моменты это может привести к снижению производительности приложения, то есть в точности как и использование Thread.Sleep

[Алексей Березников]

Петр, Верно, есть и получше способы, семафоры при определенном желании можно ждать и асинхронно (WaitHandle/ThreadPool.RegisterWaitForSingleObject), или взять SemaphoreSlim, который умеет ждать асинхронно из коробки. Дело в том что это мало отношения имеет непосредственно к отображению GIF.

[Nikolay Khablenko]

Петр, Sleep(30) фреймы в анимации выводяться каждый кадр с задержкой в 30 мс, если убрать задержку, они тупо пролистаются и вместо визуального отображения анимации - получиться быстрый перебор кадров и все, а не анимация...

[Nikolay Khablenko]

Алексей Березников, Кроме https://github.com/XamlAnimatedGif/XamlAnimatedGif..., есть еще варианты, как пихать в один компонент Image как .png так и gif?

[Алексей Березников]

NikolayKhablenko,
Имеется ввиду, что Task.Delay там смотрелся бы куда лучше.

[Nikolay Khablenko]

Алексей Березников, Вот полный пример метода. Может так будет понятнее... как решить задачу. Изначально, я нашел решения на Thread но потом узнал, что из нельзя сразу остановить, типа когда хотят тогда и освобождают ресурсы... Поэтому перешел на Task стало лучше, но все равно лагает.

private void FillImages_byTAB2(int _TabpageSelected)
{
if (StructureGroupQues.Count < 1)
{
return;
}
if (StructureGroupQues[_TabpageSelected].QuestionDetail.Count < 1)
{
return;
}
cancelTokenSource1.Cancel();

volatileComplette1 = true;



cancelTokenSource1 = new CancellationTokenSource();
CancellationToken token1 = cancelTokenSource1.Token;


token1.Register(() => {
volatileComplette1 = true;
Thread.Sleep(1);
Image_Left.Source = null;
return;
});

Image_Left.Visibility = Visibility.Visible;
Image_Left.Source = null;

string[] PathDir_Image;
string[] PathDir_Animation;
string sql_command1 = string.Empty;
sql_command1 = "SELECT PathDir FROM Spravochnik_Image where ((ID_Question_Detail=" + StructureGroupQues[_TabpageSelected].QuestionDetail[0].QDet_ID + ") AND (ISAnimation=0))";
int row_count_Pathdir = 0;
req.con.Open();
SQLiteCommand exeSql1 = new SQLiteCommand(sql_command1, req.con);
SQLiteDataReader dr1 = exeSql1.ExecuteReader();
while (dr1.Read())
{
row_count_Pathdir++;
}
PathDir_Image = new string[row_count_Pathdir];
dr1.Close();
int i = 0;
if (row_count_Pathdir > 0)
{
dr1 = exeSql1.ExecuteReader(CommandBehavior.CloseConnection);
while (dr1.Read())
{
PathDir_Image[i] = dr1[0].ToString();
i++;
}
dr1.Close();
req.con.Close();
}

dr1.Close();
req.con.Close();

Image_Left.Visibility = Visibility.Visible;
Image_Center.Visibility = Visibility.Visible;
Image_Right.Visibility = Visibility.Visible;
Image_Left.Source = null;
Image_Center.Source = null;
Image_Right.Source = null;
switch (PathDir_Image.Length)
{
case 0:

break;
case 1:
Image_Center.Visibility = Visibility.Collapsed;
Image_Right.Visibility = Visibility.Collapsed;

Image_Left.Source = new BitmapImage(new Uri(PathDir_Image[0], UriKind.RelativeOrAbsolute));
break;
}

if (GLOBAL_Check_Animation7_3 == true)
{
string sql_command_Anim = "SELECT PathDir FROM Spravochnik_Image where ((ID_Question_Detail=" + StructureGroupQues[_TabpageSelected].QuestionDetail[0].QDet_ID + ") AND (ISAnimation=1))";
int row_count_Pathdir_Anim = 0;
req.con.Open();
SQLiteCommand exeSqlAnim = new SQLiteCommand(sql_command_Anim, req.con);
SQLiteDataReader dr_Anim = exeSqlAnim.ExecuteReader();
while (dr_Anim.Read())
{
row_count_Pathdir_Anim++;
}
PathDir_Animation = new string[row_count_Pathdir_Anim];
dr_Anim.Close();
int ii = 0;
if (row_count_Pathdir_Anim > 0)
{

dr_Anim = exeSqlAnim.ExecuteReader(CommandBehavior.CloseConnection);
while (dr_Anim.Read())
{
PathDir_Animation[ii] = dr_Anim[0].ToString();
ii++;
}
dr_Anim.Close();
req.con.Close();
}

dr_Anim.Close();
req.con.Close();



GifBitmapDecoder decoder1;
BitmapSource bitmapSource1;
int frameCount1;

GifBitmapDecoder decoder2;
BitmapSource bitmapSource2;
int frameCount2;

GifBitmapDecoder decoder3;
BitmapSource bitmapSource3;
int frameCount3;
switch (PathDir_Animation.Length)
{
case 0:

break;
case 1:
if (!(String.IsNullOrEmpty(PathDir_Animation[0])))
{

volatileComplette1 = false;

decoder1 = new GifBitmapDecoder((new Uri(PathDir_Animation[0], UriKind.RelativeOrAbsolute)), BitmapCreateOptions.PreservePixelFormat, BitmapCacheOption.Default);
frameCount1 = decoder1.Frames.Count;



th_Image1 = new Task(() =>
{
Thread.Sleep(1);
if (token1.IsCancellationRequested)
{
return;
}
while (!volatileComplette1)
{
Thread.Sleep(1);
if (token1.IsCancellationRequested)
{
return;
}

for (int b = 0; ((b < frameCount1) && (!volatileComplette1)); b++)
{


this.Dispatcher.Invoke(new Action(delegate ()
{
bitmapSource1 = decoder1.Frames[b];
Image_Left.Source = bitmapSource1;
Thread.Sleep(1);
if (token1.IsCancellationRequested)
{
return;
}
}));
Thread.Sleep(1);
if (token1.IsCancellationRequested)
{
return;
}
System.Threading.Thread.Sleep(30);
if (token1.IsCancellationRequested)
{
return;
}
}

System.Threading.Thread.Sleep(5000);
if (token1.IsCancellationRequested)
{
return;
}
}

}, token1);
th_Image1.Start();
}
break;
}

[Петр]

Алексей Березников, SemaphoreSlim не применяет обьекты ядра windows и его Release не проверяет каким потоком был захвачен семафор. Поэтому его и можно использовать. Все что использует обьекты ядра windows тут нежелательно, а то может возникнуть интересная ситуация в случае если код таска будет таким (как вы указали в ответе):

_semaphore.WaitOne();

    try
    {
        . . . 
        await Task.Delay(10);
    }
    finally
    {
        _semaphore.Release();
    }

[Nikolay Khablenko]

Петр, Проанализировав Выше мой код, и учитывая вопрос, который был задан, есть вариант, как мне помочь в решении проблемы?

[Алексей Березников]

NikolayKhablenko,
Смотрите, в Dispatcher.Invoke делать Thread.Sleep ни в коем случае нельзя - это приводит к задержкам в UI. Оборачивайте в Dispatcher.Invoke только то, что требует UI потока.
Отвечая на ваш предыдущий вопрос - вы можете сделать два контрола на одном и том же месте, и показывать один из них в зависимости от того, что вам нужно - gif или не gif. Также есть небольшая возможность, что можно одновременно и то и то показывать - но это нужно пробовать. Имею ввиду, для обычных картинок задавать Source и опустошать gif:AnimationBehavior.SourceUri, и наоборот, для gif-картинок задавать gif:AnimationBehavior.SourceUri и опустошать Source.

[Алексей Березников]

Если в code-behind писать как у вас, тогда для задания gif:AnimationBehavior.SourceUri нужно будет писать что-то вроде

AnimationBehavior.SetSourceUri(image_Left, "Source URI gif анимации");

[Петр]

NikolayKhablenko, У вас вопрос "Как мгновенно завершить Task" и Task.Sleep(30) просто заблокирует поток, ему ядро не будет выделять кванты времени. И из других потоков вы не сможете в этот момент повлять.
Вместо Task.Sleep можно применить и ManualResetEvent и ждать на нем теже 30 мс. Но уже при таком решении из других потоков этот event можно перевести в сигнальное состояние и при его наличии завершить задачу.
В вашей задаче Task.Sleep(30) не сильно критично, вы просто используете поток пока не выполните задачу, но вот в ответе вам написали иной сценарий, при котором может быть запущено одновременно множество тасков в своих потоках, что приведет к проблемам производительности.

[Алексей Березников]

Петр, Я не стал углубляться в тонкости, если там действительно на ваш взгляд есть проблема - легким движением руки Semaphore превращается в SemaphoreSlim, а WaitOne() - в WaitOneAsync(), проблема надуманная я бы сказал

[Nikolay Khablenko]

Петр, То есть, мне достаточно, убрать все Thread.Sleep() и заменить их ManualResetEvent(n милисекунд) и моя проблема должна решиться?

[Петр]

Алексей Березников, Проблема реальная. Уже на втором вызове может не отображаться лоадер в ситуации
_semaphore.WaitOne();
await Task.Delay(10);
_semaphore.Release();
так как освобождение семафора никогда не произойдет.

[Алексей Березников]

Петр, Интересно а почему освобождение семафора никогда не произойдет?

[Алексей Березников]

NikolayKhablenko,
Лично я вот так вижу самое простое решение вашей проблемы - https://drive.google.com/file/d/1omiGMwm5WL9ppljSU...

[Nikolay Khablenko]

Алексей Березников, Спасибо за наглядный пример. Но не хотелось бы использовать два компонента, да еще и стороннюю библиотеку. Но за пример, спасибо, буду использовать его , если не смогу найти решение... Просто и это все рботает на ура, просто иногда, при смене картинок, task не завершается, в методе устанавливается картинка .png, а потом с этого же таска выерается кадр и перезаписывается. мне всего то нужно убить таск, до установки source=*.png

[Алексей Березников]

NikolayKhablenko, Можно и одним сделать, было бы желание. Тогда вам нужно:
1. Сделать вашу лямбду асинхронной (добавить async перед ())
2. Заменить Thread.Sleep на await Task.Delay, передать туда ваш токен отмены
3. Там, где показываете следущее изображание, отменяете токен и ждете таск, и только после этого запускаете следующий

[Алексей Березников]

Петр,
Мне действительно интересно, почему вы так считаете, потому что вот этот маленький dotnetfiddle доказывает обратное

Answer 2

[Nikolay Khablenko]

И еще, по поводу анимации, она должна запуститься и выполняться, пока я не нажму кнопку к след анимации, поэтому зациклено while