Home > Articles > Programming > Windows Programming

  • Print
  • + Share This
Like this article? We recommend

Asynchronous Programming

The final design pattern that I'll discuss in this article is the asynchronous pattern used throughout the framework. Obviously, calling methods on a class asynchronously executes them on a separate thread that frees up the main thread, allowing it to respond to user input or go on to do other work. The .NET Framework makes calling methods asynchronously easy by handling the thread management and providing the underlying infrastructure through delegates.

The interesting aspect of this model is that it is client-driven. This means that clients determine whether to call a method synchronously or asynchronously, either using methods provided by the server class (with the class doing the work) or through an asynchronous delegate. For example, classes in the framework such as FileStream provide Begin and End methods inherited from Stream that are used on either end of an asynchronous call in addition to the standard methods that provide the functionality. In the case of FileStream, this means that it supports both BeginRead and BeginWrite methods that can be used asynchronously, in addition to Read and Write methods that are used synchronously. Typical examples of where Begin and End methods already exist in the framework include the proxy class created when an XML Web Service is referenced in VS .NET and when dealing with network IO, remoting, and messaging. It should be noted that calling XML Web Services asynchronously can be particularly effective because network problems or problems with the Web service may prevent a quick turnaround so that the client code can continue execution.

However, if the server class does not support Begin and End methods, you can still call one of its methods asynchronously by simply creating and invoking a delegate. Although a complete discussion of delegates is beyond the scope of this article, delegates are simply type-safe function pointers used to call a method on another object. Delegates also form the basis for events in .NET. It turns out that delegates expose an Invoke method that is used to call the function that the delegate points to, in addition to calling BeginInvoke and EndInvoke to transparently support invoking delegates asynchronously.

Whether you're using server classes that expose Begin and End methods or calling a method asynchronously through a delegate, the pattern is basically the same. First, the caller creates a delegate of type AsyncCallback that points to the method that will be called when the asynchronous operations finishes. For example, if you want to write data to a file on a separate thread using the FileStream class, you would create an asynchronous delegate in VB .NET like this:

Dim writePhoto As New AsyncCallback(AddressOf WritePhotoCallback)

Note that, in VB .NET, you would use the AddressOf operator to reference the method, whereas, in C#, you would simply pass the name of the method to the constructor.

Next, the client code invokes the asynchronous operation and passes it the delegate either through the Begin method exposed by the server class or through the BeginInvoke method if you're working with a class that does not expose them. In this case, the FileStream class exposes a BeginWrite method that can be called directly:

Dim fs As New FileStream("myfile.gif")
fs.BeginWrite(byteBuffer, 0, byteBuffer.Length, writePhoto, fs)

In this case, the byteBuffer variable is simply an array of type Byte that holds binary data that represents a photo. At this point, the thread that called BeginWrite is free to perform other operations as the execution of the Write method continues on a separate thread managed by the CLR. When the operation completes, the WritePhotoCallback method is called through the delegate, as shown in Listing 3.

Listing 3: Using a Callback

Public Sub WritePhotoCallback(ByVal ar As IAsyncResult)
 Dim fs As FileStream

 ' Used to get the current thread ID
 ' Dim ThreadID As Integer = Thread.CurrentThread.GetHashCode()
 ' Console.WriteLine(ar.CompletedSynchronously)

 ' Get the FileStream
 fs = CType(ar.AsyncState(), FileStream)

 ' Finish the writing and close the stream
 fs.EndWrite(ar)
 fs.Close()

End Sub

In Listing 3, you'll notice that the WritePhotoCallback method must accept one parameter of type IAsyncResult. The IAsyncResult interface exposes several methods that can be called to determine whether the operation completed asynchronously, to retrieve the state passed to the Begin method, and even to poll or wait for the completion of the operation. In this case, the CompletedSynchronously property is called to determine whether the operation actually completed synchronously because the server class can make the decision to run the operation synchronously if it will complete very quickly (for example, the FileStream class will complete all IO operations of less than 64KB synchronously). The AsyncState property is used to retrieve the original FileStream to which the data was written. After the FileStream has been retrieved, the EndWrite method is called to end the operation. Note that the ID of the thread on which the operation completes can be determined using the static CurrentThread method of the Thread class.

Although the pattern discussed so far is the one that you'll most often use with asynchronous operations, the Begin methods can be called without the AsyncCallback delegate by passing in a null value (Nothing in VB .NET). In this case, you'll need to either poll for the completion of the operation using the IsCompleted method of the IAsyncResult interface returned from the Begin method, simply call the End method that will block the current thread until the operation completes, or use the WaitHandle returned from the AsyncWaitHandle property of the IAsyncResult interface to wait for completion. In the first and third cases, you'll then need to explicitly call the End method.

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020