OctaneEngineCore 8.3.5

Experience a powerful, piecewise file downloader for C#, designed to asynchronously fetch files in segments. It’s built to outperform Microsoft’s WebClient with greater speed and efficiency. Curious to see it in action? Check out the 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
• Headers

Usage

Program.cs

const string url = "https://plugins.jetbrains.com/files/7973/281233/sonarlint-intellij-7.4.0.60471.zip?updateId=281233&pluginId=7973&family=INTELLIJ";

// Create engine directly without builder - no DI required (if you don't want it!)
var engine = EngineBuilder.Create().WithConfiguration(config => {
        config.Parts = 8;
        config.BufferSize = 8192;
        config.ShowProgress = true;
        config.NumRetries = 10;
        config.BytesPerSecond = 1;
        config.UseProxy = false;
        config.LowMemoryMode = false;
        config.RetryCap = 30;
}).Build();
        
// Setup download
var pauseTokenSource = new PauseTokenSource();
using var cancelTokenSource = new CancellationTokenSource();
        
// Download the file
engine.DownloadFile(new OctaneRequest(url, null), pauseTokenSource, cancelTokenSource.Token).Wait();  

If you want to use Dependency Injection

Program.cs

await Host.CreateDefaultBuilder(args).UseSerilog((context, configuration) =>
{
        configuration
                .Enrich.FromLogContext()
                .MinimumLevel.Fatal()
                .WriteTo.Async(a => a.File("./OctaneLog.txt"))
                .WriteTo.Async(a => a.Console(theme: AnsiConsoleTheme.Sixteen));
}).ConfigureAppConfiguration(configurationBuilder =>
{
        configurationBuilder.AddJsonFile("appsettings.json");
}).UseOctaneEngine().ConfigureServices(collection =>
{
        collection.AddHostedService<DownloadService>();
}).RunConsoleAsync();

DownloadService

using System.Threading;
using System.Threading.Tasks;
using Microsoft.Extensions.Hosting;
using OctaneEngineCore;

namespace OctaneTester;

public class DownloadService(IEngine engine, IHostApplicationLifetime lifetime, ILogger<DownloadService> logger) : BackgroundService
{
    private const string Url = "https://plugins.jetbrains.com/files/7973/281233/sonarlint-intellij-7.4.0.60471.zip?updateId=281233&pluginId=7973&family=INTELLIJ";

    protected override async Task ExecuteAsync(CancellationToken stoppingToken)
    {
        var pauseTokenSource = new PauseTokenSource();
        logger.LogInformation("Current Latency: {latency}", await engine.GetCurrentNetworkLatency());
        logger.LogInformation("Current Network speed: {speed}", await engine.GetCurrentNetworkSpeed());
        await engine.DownloadFile(new OctaneRequest(Url, null), pauseTokenSource, stoppingToken);
        lifetime.StopApplication();
    }
}

appsettings.json

"Octane": {
    "Parts": 8,
    "BufferSize": 8196,
    "ShowProgress": true,
    "NumRetries": 10,
    "RetryCap": 30,
    "BytesPerSecond": 1,
    "UseProxy": false,
    "LowMemoryMode": false
  }

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

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