Home > Articles > Programming > Visual Basic

This chapter is from the book

This chapter is from the book

Asynchronous I/O File Operations in .NET 4.6

Before .NET Framework 4.5, you could perform asynchronous operations over files and streams by using the Asynchronous Programming Model and methods such as Stream.BeginRead and Stream.EndRead. This kind of approach can be good, but it has the limitations described in the section “Getting Started with Async/Await” in this chapter. With .NET Framework 4.5 and after, asynchronous I/O operations can be simplified by using the Async pattern and by implementing asynchronous versions of methods that work with files and stream to avoid blocking the main thread. Such methods are exposed by the Stream, FileStream, MemoryStream, TextReader, and TextWriter classes that you saw in action back in Chapter 18, “Manipulating Files and Streams.” Table 42.1 summarizes the available asynchronous methods.

TABLE 42.1 Asynchronous Methods for Stream Classes

Method

Description

Return Type

ReadAsync

Reads a sequence of bytes from a stream and advances the position by the number of bytes read, with an asynchronous approach

Task(Of Integer)

WriteAsync

Writes a sequence of bytes to a stream, with an asynchro-nous approach

Task

FlushAsync

Clears buffers associated with the stream sending buffered data to the stream, using asynchrony

Task

CopyToAsync

Asynchronously copies a number of bytes from a stream to another

Task

ReadLineAsync

Reads a line of characters using asynchrony and returns a string

Task(Of String)

ReadToEndAsync

Asynchronously reads all characters from the current posi-tion to the end of the stream, and returns one string

Task(Of String)

To see some of these methods in action, create a new WPF project. The user interface of this sample application will have to look like Figure 42.7.

FIGURE 42.7

FIGURE 42.7 The user interface of the new sample application.

That said, add the following controls in the designer:

  1. Three buttons, named ReadTextButton, CopyButton, and WriteButton. Then, set their Content properties with Read text, Copy files, and Write Something, respectively.
  2. Four TextBox controls, named ReadTextBox, SourceTextBox, DestinationTextBox, and StatusTextBox.
  3. Three TextBlock controls. You do not need to specify a name, but make sure their Text property is set with Source folder, Destination folder, and Status, respectively.

The first example uses the StreamReader class to read a text file asynchronously. The event handler for the ReadTextButton.Click event looks like this:

Private Async Sub ReadTextButton_Click(sender As Object,
                                       e As RoutedEventArgs) _
                                       Handles ReadTextButton.Click
    Using reader As New StreamReader("TextFile1.txt")
        Me.ReadTextBox.Text = Await reader.ReadToEndAsync
    End Using

End Sub

You mark the event handler with Async, and because this method will not be awaited by any other methods, it does not need to return a Task. Therefore, it can be defined as a Sub. Notice how you use Await together with the ReadToEndAsync method, while the rest of the implementation is made the usual way. The next example is about copying streams asynchronously. The following code shows the implementation of the CopyButton.Click event handler:

Private Async Sub CopyButton_Click(sender As Object,
                                   e As RoutedEventArgs) _
                                   Handles CopyButton.Click
    If Me.SourceTextBox.Text = "" Then
        MessageBox.Show("Please specify the source folder")
        Exit Sub
    End If

    If Me.DestinationTextBox.Text = "" Then
        MessageBox.Show("Please specify the target folder")
        Exit Sub
    End If

    For Each fileName As String In Directory.
        EnumerateFiles(Me.SourceTextBox.Text)

        Using SourceStream As FileStream = File.Open(fileName, FileMode.Open)
            Using DestinationStream As FileStream =
                File.Create(String.Concat(Me.DestinationTextBox.Text,
                                          fileName.
                                          Substring(fileName.LastIndexOf("\"c))))
                Await SourceStream.CopyToAsync(DestinationStream)
                Me.StatusTextBox.Text = "Copied " + DestinationStream.Name
            End Using
        End Using
    Next

End Sub

In particular, the code enumerates the content of the source folder and for each file it opens a stream for reading and another one for writing into the target folder. Await enables you to execute asynchronously the operation with the asynchronous method called CopyToAsync. It is worth mentioning that, with this approach, you can refresh the user interface with useful information, like showing the name of the last copied file. In a synchronous approach, this would not be possible because the UI would be blocked until the completion of the operation. The last example demonstrates how to write some text into a file asynchronously. This is the event handler for the WriteButton.Click event:

Private Async Sub WriteButton_Click(sender As Object,
                              e As RoutedEventArgs) Handles WriteButton.Click
    Dim uniencoding As UnicodeEncoding = New UnicodeEncoding()
    Dim filename As String =
        "c:\temp\AsyncWriteDemo.txt"

    Dim result As Byte() = uniencoding.GetBytes("Demo for Async I/O")

    Using SourceStream As FileStream = File.Open(filename, FileMode.OpenOrCreate)
        SourceStream.Seek(0, SeekOrigin.End)
        Await SourceStream.WriteAsync(result, 0, result.Length)
    End Using

End Sub

In this particular example, the code is written exactly like in the synchronous counterpart, except for the Async modifier and the Await statement that invokes the WriteAsync method (instead of running Write). By using the Async pattern, writing applications that work with streams and remain responsive has become dramatically simpler.

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