برنامه نویسی Parallel در سی شارپ :: متوقف کردن Task ها در سی شارپ – کلاس CancellationToken
زمانی که عملیاتی را به عنوان یک Task اجرا می کنیم، ممکن است بخواهیم آن Task را در حین اجرا متوقف کنیم، برای مثال، Task ای داریم که در حال پردازش 1000 فایل است و کاربر باید این امکان را داشته باشد که Task در حال اجرا را متوقف کند. عملیات متوقف کردن Task ها هم برای متدهای کلاس Parallel امکان پذیر است و هم کلاس Task. برای اینکار می بایست از کلاس CancellationToken استفاده کنیم. برای مثال Task زیر را در نظر بگیرید که حاصل میانگین جمع اعداد 1 تا 100 را محاسبه می کند:
Task < int > averageTask = new Task < int > (() =>
{
Console.WriteLine("Calculating average...");
Console.WriteLine("Press Ctrl+C to cancel...");
var sum = 0;
for (int counter = 1; counter < = 100; counter++)
{
sum += counter;
Thread.Sleep(100);
}
Console.WriteLine("All done.");
return sum/100;
});
averageTask.Start();
Console.WriteLine(averageTask.Result);
قبلاً با این کد آشنا شدیم، اما کاری که در این قسمت می خواهیم انجام دهیم اضافه کردن قابلیتی است که کاربر بتواند با فشردن کلید های Ctrl+C عملیات را متوقف کند. برای اینکار ابتدا شئ ای از نوع کلاس CancellationTokenSource که در فضای نام System.Threading قرار دارد، در کلاس Program به صورت زیر تعریف می کنیم:
Task < int > averageTask = new Task < int > (() = >
{
Console.WriteLine("Calculating average...");
Console.WriteLine("Press q to cancel...");
var sum = 0;
for (int counter = 1; counter < = 100; counter++)
{
sum += counter;
Thread.Sleep(100);
}
Console.WriteLine("All done.");
return sum/100;
}, source.Token);
شئ source که در کلاس Program ایجاد کردیم متدی دارد با نام Cancel که این متد را زمانی که قصد داریم Task متوقف شود باید فراخوانی کنیم. فراخوانی این متد باید زمانی انجام شود که کاربر کلید های Ctrl+C را فشار داده است. در محیط Console، زمانی که کاربر کلید های Ctrl+C را فشار می دهد، event ای با نام CancelPressKey در کلاس Console فراخوانی می شود، پس باید این از این event برای فراخوانی متد Cancel به صورت زیر استفاده کنیم:
Console.CancelKeyPress += (sender, eventArgs) = >
{
source.Cancel();
eventArgs.Cancel = true;
};
به خط دوم داخل event دقت کنید، زمانی که کلید های Ctrl+C فشرده می شوند، به صورت پیش فرض کل برنامه Console متوقف می شود، برای جلوگیری از این کار مقدار خصوصیت Cancel را در شئ eventArgs به مقدار true ست می کنیم، یعنی عملیات متوقف کردن محیط کنسول به صورت دستی توسط ما انجام شده و خود سیستم نیاز به انجام کاری در این باره ندارد.
بعد از Subscribe کردن event بالا، باید به برنامه بگوییم تا زمانی که task به اتمام نرسیده یا کاربر کلید های Ctrl+C را فشار نداده نباید از برنامه خارج شویم، به همین خاطر یک حلقه while به صورت زیر ایجاد می کنیم:
while (!averageTask.IsCompleted && !source.IsCancellationRequested)
{
}
با خصوصیت IsCompleted در کلاس Task قبلاً آشنا شدیم، اما خصوصیت IsCancellationRequested در شئ source زمانی مقدارش true می شود که متد Cancel فراخوانی شود، پس تا زمانی که عملیات Task به اتمام نرسیده و زمانی که کاربر کلید های Ctrl+C را فشار نداده برنامه در حلقه while منتظر می ماند.
در ادامه باید Task ایجاد شده را به صورتی تغییر دهیم که داخل حلقه for بررسی شود که متد Cancel فراخوانی شده است یا خیر، اگر فراخوانی شده بود باید از Task خارج شویم، برای این کار نیز از خصوصیت IsCancellationRequested در شئ source استفاده می کنیم، Task ایجاد شده را به صورت زیر تغییر می دهیم:
Task < int > averageTask = new Task < int > (() = >
{
Console.WriteLine("Calculating average...");
Console.WriteLine("Press Ctrl+C to cancel...");
var sum = 0;
for (int counter = 1; counter < = 100; counter++)
{
if (source.IsCancellationRequested)
{
Console.WriteLine("Operation terminated!");
return 0;
}
sum += counter;
Thread.Sleep(100);
}
Console.WriteLine("All done.");
return sum/100;
}, source.Token);
همانطور که مشاهده می کنید داخل حلقه for گفتیم که اگر IsCancellationRequested برابر true بود پیغامی را نمایش بده و مقدار 0 را برگردان. کد نهایی ما به صورت زیر می باشد:
class Program
{
private static CancellationTokenSource source = new CancellationTokenSource();
static void Main(string[] args)
{
Task < int > averageTask = new Task < int >(() = >
{
Console.WriteLine("Calculating average...");
Console.WriteLine("Press Ctrl+C to cancel...");
var sum = 0;
for (int counter = 1; counter <= 100; counter++) { if (source.IsCancellationRequested) { Console.WriteLine("Operation terminated!"); return 0; } sum += counter; Thread.Sleep(100); } Console.WriteLine("All done."); return sum/100; }, source.Token); averageTask.Start(); Console.CancelKeyPress += (sender, eventArgs) = >
{
source.Cancel();
eventArgs.Cancel = true;
};
while (!averageTask.IsCompleted && !source.IsCancellationRequested)
{
}
Console.WriteLine(averageTask.Result);
}
}
در صورتی که برنامه بالا را اجرا کرده و کلید های Ctrl+C را فشار دهیم خروجی زیر برای ما نمایش داده می شود:
Calculating average... Press Ctrl+C to cancel... Operation terminated! 0 Press any key to continue . . .
استفاده از CancellationToken در کلاس Parallel
علاوه بر کلاس Task می توان از قابلیت CancellationToken در متدهای کلاس Parallel نیز استفاده کرد، برای آشنایی بیشتر فرض کنید کدی به صورت زیر تعریف شده که لیست فایل های jpg داخل یک پوشه را پردازش می کند:
var jpegFiles = System.IO.Directory.GetFiles("D:\\Images", "*.jpg");
Parallel.ForEach(jpegFiles, file = >
{
var fileInfo = new FileInfo(file);
// process file
});
برای متوقف کردن عملیات پردازش فایل ها، ابتدا شئ ای از نوع CancellationTokenSource مانند مثال قبل ایجاد می کنیم:
private static CancellationTokenSource source = new CancellationTokenSource();
در قدم بعدی کلاسی از نوع ParallelOptions به صورت زیر تعریف کرده، خصوصیت CancellationToken را برابر خصوصیت Token در شئ source قرار داده و این کلاس را به عنوان پارامتر ورودی به متد ForEach به صورت زیر ارسال می کنیم:
ParallelOptions options = new ParallelOptions();
options.CancellationToken = source.Token;
try
{
Parallel.ForEach(jpegFiles,options, file = >
{
options.CancellationToken.ThrowIfCancellationRequested();
var fileInfo = new FileInfo(file);
// process file
});
}
catch (OperationCanceledException ex)
{
Console.WriteLine(ex);
}
دقت کنید در قسمت ForEach متدی با نام ThrowIfCancellationRequested فراخوانی شده است، در حقیقت این متد بعد از فراخوانی بررسی می کند که آیا متد Cancel برای شئ source فراخوانی شده است یا خیر، اگر فراخوانی شده بود خطایی از نوع OperationCanceledException ایجاد می شود که در خارج از بدنه ForEach کلاس Parallel، بوسیله ساختار try..catch این خطا مدیریت شده است. دقت کنید که روند مدیریت Cancel کردن در کلاس Parallel با کلاس Task متفاوت است و دلیل این موضوع نوع برخورد برنامه با این کلاس ها است. در قسمت بعدی با مبحث Parallel LINQ آشنا خواهیم شد.