AsyncOperation Class
Tracks the lifetime of an asynchronous operation.
Namespace: System.ComponentModel
Assembly: System (in System.dll)
The AsyncOperation type exposes the following members.
| Name | Description | |
|---|---|---|
![]() ![]() ![]() | SynchronizationContext | Gets the SynchronizationContext object that was passed to the constructor when the object was created by AsyncOperationManager. |
![]() ![]() ![]() | UserSuppliedState | Gets an object that is used to uniquely identify an asynchronous operation. |
| Name | Description | |
|---|---|---|
![]() ![]() ![]() | Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() ![]() ![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
![]() ![]() ![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() ![]() ![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() ![]() ![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() ![]() ![]() | OperationCompleted | Ends the lifetime of an asynchronous operation. |
![]() ![]() ![]() | Post | Invokes a delegate on the thread or context appropriate for the application model. |
![]() ![]() ![]() | PostOperationCompleted | Ends the lifetime of an asynchronous operation. |
![]() ![]() ![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
When you implement a class according to the Event-based Asynchronous Pattern Overview topic in the .NET Framework documentation, you may want to track the lifetime of each asynchronous operation invoked on an instance of your class. The AsyncOperation class provides ways to track and report the progress of an asynchronous task.
The following list identifies ways to use an AsyncOperation object:
To report progress and interim results to the client, call Post from your asynchronous worker code.
To indicate that an asynchronous task has completed, or to cancel a pending asynchronous task, call PostOperationCompleted.
Your class should get an AsyncOperation object for each asynchronous task by calling AsyncOperationManager.CreateOperation when each task starts. To enable the client to distinguish separate asynchronous tasks, AsyncOperationManager.CreateOperation takes a parameter for a unique client-provided token, which becomes the UserSuppliedState property. It can then be used by client code to identify the particular asynchronous task that is raising progress or completion events.
Note: |
|---|
The BackgroundWorker class provides a simpler programming model for handling asynchronous behavior. Implementing the event-based asynchronous pattern by using AsyncOperation is more complex, but also more flexible, and is necessary if you must be able to communicate between the parent class and the worker class by using custom events. By using BackgroundWorker, you are limited to its ProgressChanged and RunWorkerCompleted events. Depending on the scenario, the AsyncOperation pattern may have less overhead than using BackgroundWorker because it is delegate-based and not event-based. |
Implementers must make sure that the PostOperationCompleted and Post invocations are asynchronous, so that class library providers do not need to concern themselves with potential stack overflows if they assume asynchronous behavior in a particular application model that happens to be synchronous.
For more information about how to implement asynchronous classes, see Implementing the Event-based Asynchronous Pattern in the .NET Framework documentation.
The following code example demonstrates how to use an AsyncOperation object to track the lifetime of asynchronous operations. This code example is part of a larger example provided for the System.ComponentModel.AsyncOperationManager class.
' Start GetPersons as an asynchronous process.
Public Sub GetPersonsAsync(ByVal itemsCount As Integer, _
ByVal name As String, _
ByVal taskId As Object)
Dim asyncOp As AsyncOperation
' First make sure this is not an attempt to start the
' same thread twice. Multiple threads will access the
' taskID Dictionary, so it must be locked to serialize
' access.
SyncLock Me
If taskIDs.ContainsKey(taskId) Then
Throw New ArgumentException _
("Task ID already exists", "taskID")
End If
' Create a new AsyncOperation object
' and put it in the taskID Dictionary.
asyncOp = AsyncOperationManager.CreateOperation(taskId)
taskIDs(taskId) = asyncOp
End SyncLock
' Start the asynchronous process.
Dim myThread As New Thread(AddressOf StartThread)
myThread.Start(New ThreadStartParms With _
{.ItemsCount = itemsCount, .Name = name, .AsyncOp = asyncOp})
End Sub
Private Sub StartThread(ByVal parms As ThreadStartParms)
GetPersons(parms.ItemsCount, parms.Name, parms.AsyncOp)
End Sub
' The worker process for data retrieval. Simulates a ' time-consuming operation by using Thread.Sleep. Public Sub GetPersons(ByVal itemsCount As Integer, _ ByVal Name As String, _ ByVal asyncOperation As AsyncOperation) Dim canceled As Boolean = False Dim exception As Exception = Nothing Dim personList As New List(Of Person)() Dim i As Integer = 1 While i <= itemsCount OrElse itemsCount = 0 Dim currentName As String = Name + CStr(i) personList.Add(New Person() With { _ .Name = currentName, _ .Age = i, _ .Birthday = DateTime.Today.AddYears(-i), _ .Available = (i Mod 2 = 0) _ }) ' Delay 1 second for each person. Thread.Sleep(1000) ' Report progress by using AsyncOperation to raise ' the ProgressChanged event. Pass in itemsCount of ' zero to see effect of catching an exception. Dim percentComplete As Integer Try percentComplete = Convert.ToInt32(i * 100 / itemsCount) Catch ex As Exception exception = ex Exit While End Try Dim progressChangedEventArgs As _ New GetPersonsProgressChangedEventArgs _ (currentName, _ percentComplete, _ asyncOperation.UserSuppliedState) asyncOperation.Post _ (AsyncOpProgressReportHandler, progressChangedEventArgs) If GetPersonsCheckForCancellation _ (asyncOperation.UserSuppliedState) Then canceled = True Exit While End If i += 1 End While ' Report completion by raising the Completed event. Dim completedEventArgs As _ New GetPersonsCompletedEventArgs _ (personList, _ exception, _ canceled, _ asyncOperation.UserSuppliedState) asyncOperation.PostOperationCompleted _ (AsyncOpCompletedHandler, completedEventArgs) End Sub
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.





Note: