Downloader 1.9.6

There is a newer version of this package available.
See the version list below for details.
dotnet add package Downloader --version 1.9.6
NuGet\Install-Package Downloader -Version 1.9.6
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Downloader" Version="1.9.6" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Downloader --version 1.9.6
#r "nuget: Downloader, 1.9.6"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Downloader as a Cake Addin
#addin nuget:?package=Downloader&version=1.9.6

// Install Downloader as a Cake Tool
#tool nuget:?package=Downloader&version=1.9.6

Downloader Build and Test Build Status NuGet NuGet CodeFactor

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

sample-project

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()
{
    AllowedHeadRequest = false, // Can fetch file size by HEAD request or must be used GET method to support host
    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;    

The ‍DownloadService class has a property called Package that stores each step of the download. You must call the CancelAsync method to stop or pause the download, and if you continue again, you must call the same DownloadFileAsync function with the Package parameter to continue your download! For example:

Start the download asynchronously and keep package file:

var file = @"Your_Path\fileName.zip";
var url = @"https://file-examples.com/fileName.zip";
// To resume from last download, keep downloader.Package object
var pack = downloader.Package; 
await downloader.DownloadFileAsync(url, file);

Stop or Pause Download:

downloader.CancelAsync(); 

Resume Download:

await downloader.DownloadFileAsync(pack); 

So that you can even save your large downloads with a very small amount in the Package and after restarting the program, restore it again and start continuing your download. In fact, the packages are your instant download snapshots. If your download config has OnTheFlyDownload, the downloaded bytes ​​will be stored in the package itself, but otherwise, only the address of the downloaded files will be included and you can resume it whenever you like. For more detail see StopResumeOnTheFlyDownloadTest method

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
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETStandard 2.0

    • No dependencies.

NuGet packages (9)

Showing the top 5 NuGet packages that depend on Downloader:

Package Downloads
Wabbajack.Networking.Http

Package Description

SquareMinecraftLauncher.Core

BaiBaoStudio

EasyUpdate

Easy Update 提供简单的自动更新服务。

Dove.Avalonia.Extensions.WebView

WebView Extensions for Avalonia.

Orobouros

A fully-featured and modular online scraper tool. Yes we know the name is spelled wrong. Icon Credit: Hyliian @ DeviantArt

GitHub repositories (16)

Showing the top 5 popular GitHub repositories that depend on Downloader:

Repository Stars
2dust/v2rayN
A GUI client for Windows, support Xray core and v2fly core and others
rocksdanister/lively
Free and open-source software that allows users to set animated desktop wallpapers and screensavers powered by WinUI 3.
goatcorp/FFXIVQuickLauncher
Custom launcher for FFXIV
Paving-Base/APK-Installer
An Android Application Installer for Windows
CrazyZhang666/GTA5OnlineTools
GTA5线上小助手
Version Downloads Last updated
3.1.0-beta 260 1/2/2024
3.0.6 29,212 6/6/2023
3.0.5 345 6/3/2023
3.0.4 12,962 3/11/2023
3.0.3 4,098 1/29/2023
3.0.2 1,046 1/7/2023
3.0.1 4,453 11/2/2022
3.0.0-beta 163 10/12/2022
2.4.1 9,330 9/21/2022
2.4.0 865 9/16/2022
2.3.9 480 9/14/2022
2.3.8 837 9/5/2022
2.3.7 1,490 8/23/2022
2.3.6 599 8/20/2022
2.3.5 72,748 5/6/2022
2.3.4 1,165 5/3/2022
2.3.3 5,284 2/23/2022
2.3.2 1,273 1/24/2022
2.3.1 593 1/2/2022
2.3.0 4,806 11/15/2021
2.2.9 9,608 8/12/2021
2.2.8 24,343 4/1/2021
2.2.7 679 3/31/2021
2.2.6 3,752 3/26/2021
2.2.5 988 3/24/2021
2.2.4 638 3/19/2021
2.2.3 2,850 3/1/2021
2.2.2 764 2/24/2021
2.2.1 353 2/23/2021
2.2.0 386 2/22/2021
2.1.4 370 2/21/2021
2.1.3 342 2/19/2021
2.1.2 522 2/14/2021
2.1.1 381 2/14/2021
2.1.0 403 2/10/2021
2.0.9 432 2/4/2021
2.0.8 476 2/3/2021
2.0.7 570 1/24/2021
2.0.6 410 1/13/2021
2.0.5 460 1/10/2021
2.0.4 606 1/5/2021
2.0.3 407 1/2/2021
2.0.1 568 12/19/2020
2.0.0 590 12/6/2020
1.9.9 664 12/1/2020
1.9.8 407 12/1/2020
1.9.7 507 11/12/2020
1.9.6 451 11/11/2020
1.9.5 520 11/11/2020
1.9.4 527 10/24/2020
1.9.3 450 10/19/2020
1.9.2 432 10/12/2020
1.9.1 482 9/28/2020
1.9.0 523 9/27/2020
1.8.0 819 7/31/2020
1.7.0 732 7/17/2020
1.6.0 496 7/14/2020
1.5.0 492 7/6/2020
1.4.0 577 7/4/2020
1.3.0 922 6/21/2020
1.2.1 566 6/21/2020
1.2.0 543 6/16/2020
1.1.0 529 5/29/2020
1.0.9 550 5/16/2020
1.0.8 487 5/11/2020
1.0.7 538 5/3/2020
1.0.6 497 4/22/2020
1.0.5 489 4/21/2020
1.0.4 527 4/16/2020
1.0.3 618 3/28/2020
1.0.2 520 3/28/2020
1.0.1 1,057 3/28/2020

Fixed null data in downloaded chunks