Asynchronous Method Progress Reporting [C#]

Sponsorlu Bağlantılar

This example demonstrates how to report progress information and intermediate results from an asynchronous method. It builds on a previous example, Create an Asynchronous Method.

This example is part of asynchronous method implementation series.

We do the following modifications in the code from the example mentioned above:

• modify the MyTaskWorker to report progress every second
• implement the MyTaskProgres­sChanged event with event data of typeMyTaskProgres­sChangedEventAr­gs.

MyTaskWorker

This is MyTaskWorker as it is defined in the Create Asynchronous Method example.

[C#]

private void MyTaskWorker(string[] files)
{
  foreach (string file in files)
  {
    // a time consuming operation with a file (compression, encryption etc.)
    Thread.Sleep(1000);
  }
}

Now, we modify it so it notifies the client code of progress percentage and an already processed file. Notice the AsyncOperation added to method's para­meters.

[C#]

private void MyTaskWorker(string[] files, AsyncOperation async)
{
  for (int i = 0; i < files.Length; i++)
  {
    // a time consuming operation with a file (compression, encryption etc.)
    Thread.Sleep(1000);

    // compute progress
    int progressPercentage = 100 * (i + 1) / files.Length;

    // raise the progress changed event
    MyTaskProgressChangedEventArgs eArgs = new MyTaskProgressChangedEventArgs(
      progressPercentage, files[i], null);
    async.Post(delegate(object e)
      { OnMyTaskProgressChanged((MyTaskProgressChangedEventArgs)e); },
      eArgs);
  }
}

After „processing“ a file (the Thread.Sleep(1000) statement), we compute the progress in percents and store it to MyTaskProgres­sChangedEventAr­gs together with the current file name, which is an example of an intermediate result sent to the client code. Then, we fire theProgressChanged event using the AsyncOperation object.

We also have to add the AsyncOperation async parameter to the MyTaskWorkerDe­legateand update the BeginInvoke statement in the MyTaskAsync method.

[C#]

private delegate void MyTaskWorkerDelegate(string[] files, AsyncOperation async);

public void MyTaskAsync(string[] files)
{
  // ...
  worker.BeginInvoke(files, async, completedCallback, async);
  // ...
}

You might ask if two asyncs in BeginInvoke parameters are correct. Yes, they are. The first async is passed to MyTaskWorker as its second parameter. The second async is stored into IAsyncResult instance that is passed to MyTaskCompleted­Callback.

MyTaskProgres­sChanged event

This event is raised whenever the asynchronous method wants to report progress to the client code.

[C#]

public event EventHandler<MyTaskProgressChangedEventArgs> MyTaskProgressChanged;

protected virtual void OnMyTaskProgressChanged(MyTaskProgressChangedEventArgs e)
{
  if (MyTaskProgressChanged != null)
    MyTaskProgressChanged(this, e);
}

The MyTaskProgres­sChangedEventAr­gs used by the event handler define a data member for storing the name of the last processed file. If you don't need to report such results, useProgressChange­dEventHandler as the event data type.

Here comes the definition of MyTaskProgres­sChangedEventAr­gs:

[C#]

public class MyTaskProgressChangedEventArgs : ProgressChangedEventArgs
{
  private string _currentFile;

  public string CurrentFile
  {
    get { return _currentFile; }
  }

  public MyTaskProgressChangedEventArgs(int progressPercentage, string currentFile,
    object userState)
    : base(progressPercentage, userState)
  {
    _currentFile = currentFile;
  }
}

Notice that MyTaskProgres­sChangedEventAr­gs inherits from ProgressChange­dEventArgs and that the CurrentFile data member is declared as read-only.

Handling the MyTaskProgres­sChanged event

Register and implement a handler of the MyTaskProgres­sChanged even­t:

[C#]

myObj.MyTaskProgressChanged +=
  new EventHandler<MyTaskProgressChangedEventArgs>(myObj_MethodProgressChanged);

void myObj_MethodProgressChanged(object sender, MyTaskProgressChangedEventArgs e)
{
    Console.WriteLine("[MyTask] Progress: {0} %, Current file: {1}",
        e.ProgressPercentage, e.CurrentFile);
}

In this series

1. [C#] Create an Asynchronous Method – how to create an asynchronous method
2. [C#] Asynchronous Method Progress Reporting – how to report progress
3. [C#] Cancel an Asynchronous Method – implement cancellation support

Sponsorlu Bağlantılar