Package Selection

SimpleMessageBus is distributed as multiple NuGet packages based on the provider you want to use. Choose the packages that match your infrastructure and requirements.

Core Packages

SimpleMessageBus.Core

Core interfaces and base classes. Required by all other packages.

SimpleMessageBus.Hosting

Hosting extensions for background services and message processing.

Publishing Packages

Dispatching Packages

Testing Package

SimpleMessageBus.Breakdance

Testing utilities and mocks for unit testing message handlers.
dotnet add package SimpleMessageBus.Breakdance --version 1.0.0-preview

Installation by Scenario

Web Application with Azure Storage

For ASP.NET Core applications using Azure Storage Queues:
dotnet add package SimpleMessageBus.Publish.Azure
dotnet add package SimpleMessageBus.Dispatch.Azure
dotnet add package SimpleMessageBus.Hosting

Console Application with Amazon SQS

For console applications using Amazon SQS:
dotnet add package SimpleMessageBus.Publish.Amazon
dotnet add package SimpleMessageBus.Dispatch.Amazon
dotnet add package SimpleMessageBus.Hosting
dotnet add package Microsoft.Extensions.Hosting

Azure Functions

For Azure Functions with file system triggers:
dotnet add package SimpleMessageBus.Publish
dotnet add package SimpleMessageBus.Dispatch.FileSystem
dotnet add package Microsoft.Azure.WebJobs.Extensions

Blazor WebAssembly

For client-side Blazor applications:
dotnet add package SimpleMessageBus.Publish.IndexedDb
dotnet add package SimpleMessageBus.Dispatch.IndexedDb

Development and Testing

For development and testing scenarios:
dotnet add package SimpleMessageBus.Publish
dotnet add package SimpleMessageBus.Dispatch.FileSystem
dotnet add package SimpleMessageBus.Breakdance

Framework Requirements

SimpleMessageBus requires .NET 8.0 or later. It supports .NET 8, 9, and 10.

Supported Platforms

  • Windows: Full support for all providers
  • Linux: Full support for all providers
  • macOS: Full support for all providers
  • Browser (Blazor WebAssembly): IndexedDB provider only

Target Frameworks

All packages multi-target the following frameworks:
  • net8.0
  • net9.0
  • net10.0

Package Manager Commands

Package Manager Console

# Azure Storage Queue
Install-Package SimpleMessageBus.Publish.Azure
Install-Package SimpleMessageBus.Dispatch.Azure

# Amazon SQS
Install-Package SimpleMessageBus.Publish.Amazon
Install-Package SimpleMessageBus.Dispatch.Amazon

# File System
Install-Package SimpleMessageBus.Publish
Install-Package SimpleMessageBus.Dispatch.FileSystem

# IndexedDB (Blazor WebAssembly)
Install-Package SimpleMessageBus.Publish.IndexedDb
Install-Package SimpleMessageBus.Dispatch.IndexedDb

PackageReference

Add to your .csproj file:
<PackageReference Include="SimpleMessageBus.Publish.Azure" Version="6.0.0" />
<PackageReference Include="SimpleMessageBus.Dispatch.Azure" Version="6.0.0" />

Verification

After installation, verify the packages are correctly installed:
dotnet list package
You should see the SimpleMessageBus packages listed with their version numbers.

Next Steps

After installation, proceed to:

Troubleshooting

Common Issues

For additional help, visit our GitHub Issues page.