OctaneEngineCore 8.0.3

dotnet add package OctaneEngineCore --version 8.0.3                
NuGet\Install-Package OctaneEngineCore -Version 8.0.3                
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="OctaneEngineCore" Version="8.0.3" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add OctaneEngineCore --version 8.0.3                
#r "nuget: OctaneEngineCore, 8.0.3"                
#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 OctaneEngineCore as a Cake Addin
#addin nuget:?package=OctaneEngineCore&version=8.0.3

// Install OctaneEngineCore as a Cake Tool
#tool nuget:?package=OctaneEngineCore&version=8.0.3                

C# CodeQL CodeFactor NuGet latest version Nuget

A high Performance C# file downloader that asyncrounously downloads files as pieces. Made as a faster, more efficent replacement to Microsoft's WebClient.Want to see the library in action? Check out Octane YouTube Extractor

Installation

dotnet add package OctaneEngineCore

Features

  • Multipart Downloading
  • Download Retry
  • Progress
  • Throttling
  • Logging
  • Proxy Support
  • Pause/Resume Support
  • JSON/Microsoft.Extensions.Configuration Support

Usage

private const string Url = "https://plugins.jetbrains.com/files/7973/281233/sonarlint-intellij-7.4.0.60471.zip?updateId=281233&pluginId=7973&family=INTELLIJ";
private static void Main()
{
     //Logging Setup
     var seriLog = new LoggerConfiguration()
          .Enrich.FromLogContext()
          .MinimumLevel.Verbose()
          .WriteTo.File("./OctaneLog.txt")
          .WriteTo.Console(theme: AnsiConsoleTheme.Sixteen)
          .CreateLogger();
     var factory = LoggerFactory.Create(logging => {
          logging.AddSerilog(seriLog);
     });

     //JSON Config Loading
     var builder = new ConfigurationBuilder();
     builder.SetBasePath(Directory.GetCurrentDirectory())
          .AddJsonFile("appsettings.json", true, true);
     var configRoot = builder.Build();
     var config = new OctaneConfiguration(configRoot, factory);
            
     //Find Optimal number of parts
     var optimalNumberOfParts = Engine.GetOptimalNumberOfParts(Url).Result;
     seriLog.Information("Optimal number of parts to download file: {OptimalNumberOfParts}", optimalNumberOfParts);
            
     seriLog.Information("Speed: {Result}", NetworkAnalyzer.GetCurrentNetworkSpeed().Result);
     seriLog.Information("Latency: {Result}", NetworkAnalyzer.GetCurrentNetworkLatency().Result);
     var pauseTokenSource = new PauseTokenSource();
     var cancelTokenSource = new CancellationTokenSource();
            
     var octaneEngine = new Engine(factory, config);
     octaneEngine.DownloadFile(Url, null, pauseTokenSource, cancelTokenSource).Wait(cancelTokenSource.Token);
        

Benchmark

BenchmarkDotNet v0.13.12, Windows 10 (10.0.19045.3803/22H2/2022Update)
12th Gen Intel Core i7-12700K, 1 CPU, 20 logical and 12 physical cores
.NET SDK 8.0.100
[Host] : .NET 6.0.25 (6.0.2523.51912), X64 RyuJIT AVX2 [AttachedDebugger]
Job-GUGLRW : .NET 6.0.25 (6.0.2523.51912), X64 RyuJIT AVX2
Platform=X64 IterationCount=5 WarmupCount=0
Method Url Mean Error StdDev
BenchmarkOctane http:(...)150MB [30] 8.773 s 1.321 s 0.3430 s
BenchmarkOctaneLowMemory http:(...)150MB [30] 8.999 s 0.5978 s 0.0925 s
BenchmarkHttpClient http:(...)150MB [30] 8.648 s 0.7375 s 0.1915 s
BenchmarkOctane https(...)250MB [31] 14.335 s 2.095 s 0.5440 s
BenchmarkOctaneLowMemory https(...)250MB [31] 14.159 s 1.7879 s 0.4643 s
BenchmarkHttpClient https(...)250MB [31] 15.775 s 2.2267 s 0.3446 s
BenchmarkOctane https(...)500MB [31] 28.262 s 1.876 s 0.2904 s
BenchmarkOctaneLowMemory https(...)500MB [31] 27.303 s 1.0371 s 0.2693 s
BenchmarkHttpClient https(...)500MB [31] 31.325 s 1.7619 s 0.2727 s

License

The MIT License (MIT)

Copyright (c) 2015 Greg James

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Contributors

GitHub Contributors Image

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
8.0.3 445 6/14/2024
8.0.2 110 6/11/2024
8.0.1 68 6/11/2024
8.0.0 479 1/23/2024
7.0.2 309 1/7/2024
7.0.1 209 1/7/2024
7.0.0 220 1/7/2024
6.0.4 272 1/6/2024
6.0.1 291 12/29/2023
6.0.0 962 4/2/2023
5.0.0 626 2/21/2023
4.4.1 592 2/19/2023
4.4.0 540 2/18/2023
4.3.1 553 2/18/2023
4.3.0 605 2/18/2023
4.2.0 631 2/5/2023
4.1.0 547 2/5/2023
4.0.0 623 1/19/2023
3.2.0 650 12/17/2022
3.1.0 667 11/19/2022
2.1.0 876 12/8/2021
2.0.0 613 12/7/2021
1.0.0 1,512 7/10/2020