KnightBus is a fast, lightweight and extensible messaging framework that supports multiple active message transports
Find the official KnightBus documentation here
| Package | NuGet |
|---|---|
| KnightBus.ApplicationInsights | |
| KnightBus.NewRelic |
| Package | NuGet |
|---|---|
| KnightBus.ProtobufNet | |
| KnightBus.Newtonsoft | |
| KnightBus.MessagePack |
| Package | NuGet |
|---|---|
| KnightBus.Host | |
| KnightBus.Core | |
| KnightBus.Core.Management | |
| KnightBus.Messages | |
| KnightBus.SqlServer | |
| KnightBus.Schedule |
public class CommandProcessor : IProcessCommand<SampleCommand, SampleSettings>,
{
public CommandProcessor(ISomeDependency dependency)
{
//You can use your own container for dependency injection
}
public Task ProcessAsync(SampleCommand message, CancellationToken cancellationToken)
{
//Your code goes here
return Task.CompletedTask;
}
}class Program
{
static async Task Main(string[] args)
{
var host = Microsoft.Extensions.Hosting.Host.CreateDefaultBuilder(args)
.ConfigureServices(services =>
{
//Multiple active transports
services.UseServiceBus(config => config.ConnectionString = "sb-connection")
.UseTransport<ServiceBusTransport>()
.UseBlobStorage(config => config.ConnectionString = "storage-connection")
.UseTransport<StorageTransport>()
.RegisterProcessors();
})
.UseKnightBus().Build();
await host.StartAsync(CancellationToken.None);
}
}KnightBus supports inserting your own middleware into the execution pipeline.
public class CustomThrottlingMiddleware : IMessageProcessorMiddleware
{
private readonly SemaphoreQueue _semaphoreQueue;
public int CurrentCount => _semaphoreQueue.CurrentCount;
public CustomThrottlingMiddleware(int maxConcurrent)
{
_semaphoreQueue = new SemaphoreQueue(maxConcurrent);
}
public async Task ProcessAsync<T>(IMessageStateHandler<T> messageStateHandler, IPipelineInformation pipelineInformation, IMessageProcessor next, CancellationToken cancellationToken) where T : class, IMessage
{
try
{
await _semaphoreQueue.WaitAsync().ConfigureAwait(false);
await next.ProcessAsync(messageStateHandler, cancellationToken).ConfigureAwait(false);
}
finally
{
_semaphoreQueue.Release();
}
}
}KnightBus supports custom plugins. Examples of existing plugins are: TcpAliveListener (K8S liveness probes) and Scheduling (Chron triggers).
public class CustomPlugin : IPlugin
{
public CustomPlugin(ISomeDependency dependency, ILogger<CustomPlugin> logger)
{
}
public async Task StartAsync(CancellationToken cancellationToken)
{
// Start the plugin
}
}To get documentation up and running locally, do the following.
- Install
sphinx: https://www.sphinx-doc.org - Install
sphinx_rtd_theme: https://github.com/readthedocs/sphinx_rtd_theme - Run
make html source buildin the documentation folder - Open
documentation/build/html/index.htmlin a browser to preview your changes
For Linux:
# In documentation folder:
$ sudo apt install python3 python3-sphinx python3-pip
$ python3 -m pip install sphinx-rtd-theme
$ make html source build
$ sensible-browser build/html/index.html