Downloader 1.9.1

Downloader

🚀 Fast and reliable multipart downloader with .Net Core 3.1+ supprting 🚀

Downloader is a modern, fluent, asynchronous, testable and portable library for .NET. This is a multipart downloader with asynchronous progress events. This library written in .Net Standard 2 and you can add that in your .Net Core or .Net Framework projects.

Sample Console Application

How to use

Get it on NuGet:

PM> Install-Package Downloader

Or via the .NET Core command line interface:

dotnet add package Downloader

Create your custom configuration:

var downloadOpt = new DownloadConfiguration()
{
    MaxTryAgainOnFailover = int.MaxValue, // the maximum number of times to fail.
    ParallelDownload = true, // download parts of file as parallel or notm default value is false
    ChunkCount = 8, // file parts to download, default value is 1
    Timeout = 1000, // timeout (millisecond) per stream block reader, default valuse is 1000
    OnTheFlyDownload = false, // caching in-memory or not? default valuse is true
    BufferBlockSize = 10240, // usually, hosts support max to 8000 bytes, default valuse is 8000
    MaximumBytesPerSecond = 1024 * 1024, // download speed limited to 1MB/s, default valuse is zero or unlimited
    TempDirectory = "C:\\temp", // Set the temp path for buffering chunk files, the default path is Path.GetTempPath().
    RequestConfiguration = // config and customize request headers
    {
        Accept = "*/*",
        UserAgent = $"DownloaderSample/{Assembly.GetExecutingAssembly().GetName().Version.ToString(3)}",
        ProtocolVersion = HttpVersion.Version11,
        AutomaticDecompression = DecompressionMethods.GZip | DecompressionMethods.Deflate,
        KeepAlive = false,
        UseDefaultCredentials = false
    }
};

So, declare download service instance per download and pass config:

var downloader = new DownloadService(downloadOpt);

Then handle download progress and completed events:

downloader.DownloadProgressChanged += OnDownloadProgressChanged;
downloader.ChunkDownloadProgressChanged += OnChunkDownloadProgressChanged;
downloader.DownloadFileCompleted += OnDownloadFileCompleted;    

Finally, start the download asynchronously. For example, download a .zip file:

var file = @"Your_Path\fileName.zip";
var url = @"https://file-examples.com/fileName.zip";
await downloader.DownloadFileAsync(url, file);

For resume from last download, store downloader.Package object and execute like this: (For more detail see StopResumeOnTheFlyDownloadTest test method)

var pack = downloader.Package;
download.CancelAsync(); // Stopping after some second from the start of downloading.
await downloader.DownloadFileAsync(pack); // Resume download from stopped point.

Note: for complete sample see Downloader.Sample project from this repository.

Features at a glance

• Download files async and non-blocking.
• Cross-platform library to download any files with any size.
• Get real-time progress info of each block.
• Download file multipart as parallel.
• Handle any client-side or server-side exception none-stopping the downloads.
• Config your ChunkCount to define the parts count of the download file.
• Download file multipart as in-memory or in-temp files cache mode.
• Store download package object to resume the download when you want.
• Get download speed or progress percentage in each progress event.
• Get download progress events per chunk downloads
• Stop and Resume your downloads with package object
• Set a speed limit on downloads