Click here to Skip to main content
15,897,718 members
Articles / Desktop Programming / Windows Forms
Article

Windows Communication, Web Client Asynchronous File Downloader

Rate me:
Please Sign up or sign in to vote.
3.00/5 (3 votes)
27 May 2008CPOL2 min read 40.5K   994   26   3
The simplest way to download a resource using WebClient class

Introduction

This project is intended to show how simple it is to implement an asynchronous downloader of an unlimited number of files, using the WebClient class. The key features are implemented using DownloadFileAsync and few callback functions which report progress information about active download.

The project does not use any additional threads. Everything is implemented using asynchronous callback methods which are called by the WebClient object when the internal state of the downloader changes.

Some Screen Shots

First of all, look at the program window when some parallel downloads are in progress. It’s possible to add as many download tasks as you want.

figure1.jpg
Figure 1. Multiple asynchronous download in progress.


figure2.jpg
Figure 2. Multiple asynchronous downloads finished. One has been cancelled and the second is completed.

Functional Concepts

figure3.jpg
Figure 3. Interaction diagram.

Initially, a main process is created which brings up to the user the main window with a input field for URI, an add button which starts the download process, and listview which is used to display status (in real time) of each WebClient (Figure 3). After the user presses the Add button ([+]), the DownloaderTask object creates a new downloader and assigns to it Progress Callback and End Callback events.

The download is started in the same turn. The resource is saved to the current folder and the name is automatically extracted from the last segment of the URI:

C#
fileName = this.uriData.Segments[this.uriData.Segments.Length - 1];

Logical Structure

figure4.jpg
Figure 4. Class diagram.

When the user presses the add button, a DownloaderTask object is created and added to the dwnTasks list (Figure 4):

C#
dwnTasks.Add(new DownloaderTask(tbUri.Text, lvDownloads)); 

The first parameter represents the URI and the second is a listview, where the download task object itself creates an informational group for the downloaded file and continuously updates it. The DownloaderTask constructor will create a WebClient() object, then will assign callbacks:

C#
    webClient.DownloadProgressChanged +=
        new DownloadProgressChangedEventHandler(webClient_DownloadProgressChanged);
webClient.DownloadFileCompleted += new System.ComponentModel.AsyncCompletedEventHandler
    (webClient_DownloadFileCompleted);

Also the constructor of the DownloaderTask object creates a group in passed listview (if not null) which will describe the current status of the downloadable file and the operation result at the end (See figure 2).

Conclusion

There are, of course, some TO DO items like:

  • Remove incomplete downloaded files (after failure or cancellation)
  • Allow a user to select destination folder and file name, etc.

History

  • 27th May, 2008: Initial version

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


Written By
Software Developer (Senior)
Moldova (Republic of) Moldova (Republic of)
He has Master degree in computer science. Started with microcontrollers programming from 2002 and do windows and linux programming till now.


Comments and Discussions

 
GeneralType casting in "GetHumanReadableFileSize" causing small problem (not rounding to specified precision) Pin
amattice2-Nov-10 19:13
amattice2-Nov-10 19:13 
GeneralScrolling issue Pin
andrewtheart17-Aug-08 11:41
andrewtheart17-Aug-08 11:41 
Ooh, I really wished that could be fixed. It's prefect otherwise
GeneralI think I'll use this in my project Pin
andrewtheart17-Aug-08 11:26
andrewtheart17-Aug-08 11:26 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.