👁 Image
ThunderPropagator.Application 1.0.1-beta.162

ThunderPropagator

ThunderPropagator is a cutting-edge software solution designed to redefine real-time data streaming. Our mission is to provide effortless, blazingly fast, and cloud-native streaming capabilities for maximum impact. This repository contains the foundational libraries, ThunderPropagator.Application and ThunderPropagator.Infrastructure, which empower developers to build scalable, high-performance streaming applications with ease.

These libraries support .NET 9 and .NET 8, and are configured to work across multiple platforms, including ARM64, x64, x86, and AnyCPU. They are available as NuGet packages and can be installed from GitHub Packages: https://nuget.pkg.github.com/KiarashMinoo/index.json.

Table of Contents

• Overview
• Features
• Supported Platforms
• Installation
• License Enforcement
• Documentation
• License

Overview

ThunderPropagator is designed to revolutionize real-time data streaming by providing:

• Effortless Integration: Simple and intuitive APIs for seamless integration into your applications.
• Blazingly Fast Performance: Optimized for low-latency, high-throughput streaming.
• Cloud-Native Architecture: Built for modern cloud environments, enabling scalability and resilience.
• Cross-Platform Support: Compatible with ARM64, x64, x86, and AnyCPU platforms.

Whether you're building real-time analytics, live event processing, or IoT data pipelines, ThunderPropagator empowers you to deliver maximum impact with minimal effort.

Features

• Multi-Protocol Support: WebSockets, MQTT 5.0, QUIC, WebTransport, and custom streaming protocols
• Cross-Platform Support: Works seamlessly on ARM64, x64, x86, and AnyCPU platforms
• .NET Compatibility: Fully compatible with .NET 9 and .NET 8
• High Performance: Optimized for low-latency, high-throughput streaming with backpressure control
• Cloud-Native Architecture: Built for modern cloud environments with built-in scalability and resilience
• Real-time Channels: Advanced channel management with subscription handling and message distribution
• Comprehensive Documentation: 100% coverage with 60+ documented modules
• GitHub Packages: Easily installable via GitHub Packages repository

Supported Platforms

The projects support the following platforms:

• ARM64
• x64
• x86
• AnyCPU

Both Debug and Release configurations are available for all platforms.

Installation

Step 1: Add GitHub Packages NuGet Repository

To install the libraries as NuGet packages, you need to add the GitHub Packages repository to your NuGet configuration.

Using Visual Studio:

1. Open Visual Studio
2. Go to Tools > NuGet Package Manager > Package Manager Settings
3. Under Package Sources, click the + button to add a new source
4. Enter the following details:
   • Name: GitHub-KiarashMinoo
   • Source: https://nuget.pkg.github.com/KiarashMinoo/index.json
5. Click Update and then OK

Using the Command Line:

Add the NuGet source using the following command:

dotnet nuget add source --name GitHub-KiarashMinoo --source https://nuget.pkg.github.com/KiarashMinoo/index.json

Create or Update nuget.config

The repository includes a nuget.config file configured for GitHub Packages. If you need to create your own, here's the configuration:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
 <packageSources>
 
 <add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
 
 <add key="github" value="https://nuget.pkg.github.com/KiarashMinoo/index.json" />
 </packageSources>

 
 <packageSourceCredentials>
 <github>
 <add key="Username" value="KiarashMinoo" />
 <add key="ClearTextPassword" value="your-github-token" />
 </github>
 </packageSourceCredentials>

 
 <packageSourceMapping>
 <packageSource key="github">
 <package pattern="ThunderPropagator.*" />
 </packageSource>
 <packageSource key="nuget.org">
 <package pattern="*" />
 </packageSource>
 </packageSourceMapping>
</configuration>

Place the nuget.config file in the root of your solution or project directory. This ensures that all projects in the solution can access the GitHub Packages repository.

Step 2: Verify the Configuration

To verify that the GitHub Packages repository is correctly configured, you can use the following command in the terminal:

dotnet nuget list source

This will list all configured NuGet sources. You should see something like this in the output:

Registered Sources:
 1. nuget.org [Enabled]
 https://api.nuget.org/v3/index.json
 2. github [Enabled]
 https://nuget.pkg.github.com/KiarashMinoo/index.json

Step 3: Install the NuGet Packages

You can now install the packages using the following commands:

For ThunderPropagator.Application:

dotnet add package ThunderPropagator.Application

For ThunderPropagator.Infrastructure:

dotnet add package ThunderPropagator.Infrastructure

Alternatively, you can install the packages via the NuGet Package Manager in Visual Studio.

License Enforcement

ThunderPropagator uses a native licenseManager library (LicenseManager.dll / libLicenseManager.so / libLicenseManager.dylib) to enforce feature licensing at runtime. Feature checks are cached in-process and survive hot-reload — no application restart is needed when a license changes.

Provider Types

Registration Flow

Your server Vendor portal
 │ │
 │ 1. Get hardware ID │
 │ IHardwareIdProvider │
 │ .GetHardwareId() ─────────────► │
 │ │ 2. Issue cloud key
 │ ◄── cloud key or .lic file ──── │ or activation file
 │ │
 │ 3. Place .lic in config path │
 │ or supply cloud key │
 │ │
 │ 4. UseThunderPropagator() │
 │ calls Initialize() │
 │ → LoadLicense(path) │

Step 1 — Retrieve the hardware ID at application startup:

// In Program.cs / Startup.cs after building the host:
var hardwareId = app.Services
 .GetRequiredService<IHardwareIdProvider>()
 .GetHardwareId();

Console.WriteLine($"Register this hardware ID with the vendor portal: {hardwareId}");

Alternatively query the built-in endpoint (requires UseThunderPropagator() to be called):

GET /thunderpropagator/v{version}/license/features

Step 2 — Submit the hardware ID to the vendor portal to obtain a cloud key or a .lic activation file.

Step 3 — Configure the license path in appsettings.json:

{
 "LicenseManager": {
 "LicensePath": "license.lic"
 }
}

Or via environment variable:

LicenseManager__LicensePath=/app/licenses/license.lic

Step 4 — Start the application. UseThunderPropagator() calls LicenseManagerInterop.Initialize() automatically, which loads the license and populates the in-process feature cache.

Hot-Reload Without Restart

The background LicenseRefreshService re-queries the native library on a configurable interval (default: every 15 minutes). To trigger an immediate reload, inject ILicenseRefreshService and call RefreshAsync():

await app.Services
 .GetRequiredService<ILicenseRefreshService>()
 .RefreshAsync();

To change the refresh interval:

services.Configure<LicenseRefreshOptions>(opts =>
 opts.RefreshInterval = TimeSpan.FromMinutes(5));

Licensed Features

All 18 features are enforced at runtime via LicenseManagerInterop.IsAllowed<T>(). The feature key used in license files is the fully-qualified class name shown below.

Subscription Capacity

Message Throughput

Recovery Storage

Protocol Extensions

Pipeline Infrastructure

Note: Community-tier pipeline features are required for basic operation and are expected to be licensed in all deployments.

Graceful Degradation

Documentation

Comprehensive documentation is available in the directory. The documentation is auto-generated from source code with complete API references, architecture diagrams, usage examples, and best practices.

— Main entry point with quick start guide and architecture overview

Documentation Catalog

The following areas are fully documented with types, files, diagrams, and examples:

Application Layer Types:80+ Files:112 Diagrams:✓

— Core abstractions for channels, feeders, pipelines, and subscriptions

• Types:8 Files:13 Diagrams:✓ — Real-time channel management with subscriptions and snapshots
  • Types:11 Files:13 Diagrams:✓ — Field schema definitions and type descriptors
    • Types:13 Files:13 Diagrams:✗ — Type-specific descriptor implementations
  • Types:4 Files:4 Diagrams:✓ — Request/response/push context objects
  • Types:6 Files:6 Diagrams:✗ — Channel-specific exception types
  • Types:5 Files:8 Diagrams:✓ — Authentication, authorization, snapshot configuration
  • Types:3 Files:6 Diagrams:✓ — State persistence and recovery handlers
    • Types:2 Files:2 Diagrams:✗ — Recovery handler abstractions
  • Types:8 Files:8 Diagrams:✓ — Subscription filtering and management
• Types:6 Files:6 Diagrams:✗ — Specialized collections for routing and forms
• Types:1 Files:1 Diagrams:✓ — Event interfaces and implementations
  • Types:2 Files:2 Diagrams:✗ — Push event abstractions
  • Types:2 Files:2 Diagrams:✗ — Receive event abstractions
• Types:10 Files:12 Diagrams:✓ — Data source abstractions feeding channels
• Types:2 Files:2 Diagrams:✗ — Health monitoring interfaces
• Types:3 Files:3 Diagrams:✗ — Utility classes (C# scripting, request context)
• Types:1 Files:1 Diagrams:✗ — License validation interop
• Types:1 Files:1 Diagrams:✗ — Logging utilities
• Types:3 Files:3 Diagrams:✗ — Telemetry and observability
• Types:1 Files:1 Diagrams:✓ — Middleware for request/response processing
  • Types:2 Files:3 Diagrams:✗ — Push pipeline abstractions
  • Types:4 Files:7 Diagrams:✓ — Receive pipeline abstractions
    • Types:3 Files:3 Diagrams:✗ — Pipeline attribute decorators

Infrastructure Layer Types:45+ Files:68 Diagrams:✓

— Protocol implementations and connection management

• Types:7 Files:11 Diagrams:✓ — Infrastructure channel coordination
  • Types:5 Files:5 Diagrams:✓ — Concrete recovery implementations (Redis, MongoDB, PostgreSQL)
• Types:4 Files:4 Diagrams:✓ — Client request/response contexts
• Types:2 Files:2 Diagrams:✓ — Infrastructure event handlers
• Types:1 Files:1 Diagrams:✗ — Infrastructure-specific exceptions
• Types:12 Files:13 Diagrams:✓ — DI and service registration
• Types:5 Files:5 Diagrams:✓ — Infrastructure-level feeders
• Types:2 Files:2 Diagrams:✓ — Pipeline hierarchy invokers
• Types:13 Files:13 Diagrams:✓ — Protocol handlers and containers
  • Types:3 Files:3 Diagrams:✗ — Custom binary streaming
  • Types:3 Files:3 Diagrams:✓ — MQTT 5.0 broker integration
  • Types:3 Files:3 Diagrams:✓ — QUIC protocol support
  • Types:3 Files:3 Diagrams:✓ — WebSocket connection handling
  • Types:3 Files:3 Diagrams:✓ — WebTransport over HTTP/3
• Types:2 Files:2 Diagrams:✗ — Push pipeline implementations
• — Receive pipeline implementations
  • — Pipeline catalog and routing
    • Types:1 Files:1 Diagrams:✓ — Authentication handlers (Basic, OAuth2)
    • Types:1 Files:1 Diagrams:✓ — Authorization handlers (Role, Policy)
    • Types:1 Files:1 Diagrams:✗ — Health check ping/pong
    • Types:1 Files:1 Diagrams:✓ — Channel metadata retrieval
    • Types:1 Files:1 Diagrams:✓ — Subscription management
    • Types:1 Files:1 Diagrams:✓ — Unsubscription handling

Automation & Tooling

Scripts:8 Diagrams:✓ — PowerShell automation

• CI/CD Scripts — Automated versioning, building, and publishing
  • Delete-GitHubPackages.ps1 — Package cleanup with wildcard filtering
  • Generate-Changelog.ps1 — Keep-a-Changelog format generator
  • Generate-ReleaseNotes.ps1 — Advanced release notes with diff analysis
  • pack-all-platforms.ps1 — Parallel multi-platform builds
  • pack-solution.ps1 — Core .NET pack worker
  • publish-packages.ps1 — NuGet publishing with visibility control
  • update-version.ps1 — Beta/release version management

Package Documentation

Documentation Features

• ✅ Complete API Coverage — All public types documented with signatures, descriptions, and usage
• ✅ Architecture Diagrams — Mermaid diagrams for flows, sequences, and class structures
• ✅ Realistic Examples — Production-ready code samples (no test code)
• ✅ Cross-References — Extensive linking between related documentation
• ✅ Performance Notes — Optimization tips and scalability guidance
• ✅ Protocol Guides — WebSocket, MQTT 5.0, QUIC, WebTransport details
• ✅ Dependency Tracking — ThunderPropagator package usage documented per area

Last generated: December 28, 2025

License

This project is licensed under the MIT License.

© 2024-2025 ThunderPropagator. All rights reserved.