DotNetBrightener.Plugins.EventPubSub.AzureServiceBus 2024.0.14.6-preview-2190801

This is a prerelease version of DotNetBrightener.Plugins.EventPubSub.AzureServiceBus.
There is a newer version of this package available.
See the version list below for details.
dotnet add package DotNetBrightener.Plugins.EventPubSub.AzureServiceBus --version 2024.0.14.6-preview-2190801
                    
NuGet\Install-Package DotNetBrightener.Plugins.EventPubSub.AzureServiceBus -Version 2024.0.14.6-preview-2190801
                    
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="DotNetBrightener.Plugins.EventPubSub.AzureServiceBus" Version="2024.0.14.6-preview-2190801" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="DotNetBrightener.Plugins.EventPubSub.AzureServiceBus" Version="2024.0.14.6-preview-2190801" />
                    
Directory.Packages.props
<PackageReference Include="DotNetBrightener.Plugins.EventPubSub.AzureServiceBus" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add DotNetBrightener.Plugins.EventPubSub.AzureServiceBus --version 2024.0.14.6-preview-2190801
                    
#r "nuget: DotNetBrightener.Plugins.EventPubSub.AzureServiceBus, 2024.0.14.6-preview-2190801"
                    
#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.
#:package DotNetBrightener.Plugins.EventPubSub.AzureServiceBus@2024.0.14.6-preview-2190801
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=DotNetBrightener.Plugins.EventPubSub.AzureServiceBus&version=2024.0.14.6-preview-2190801&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=DotNetBrightener.Plugins.EventPubSub.AzureServiceBus&version=2024.0.14.6-preview-2190801&prerelease
                    
Install as a Cake Tool

Azure Service Bus Enabled for Event PubSub Library

© 2024 DotNet Brightener

Versions

Library Version
EventPubSub Core NuGet Version
Azure Service Bus Library NuGet Version
Dependency Injection Library NuGet Version

Installation

dotnet package add DotNetBrightener.Plugins.EventPubSub
dotnet package add DotNetBrightener.Plugins.EventPubSub.DependencyInjection
dotnet package add DotNetBrightener.Plugins.EventPubSub.AzureServiceBus

Usage

Configuration

Option 1: Use IConfiguration to configure the service bus

builder.Services
        // Initialize EventPubSubService
       .AddEventPubSubService(
                              Assembly.GetExecutingAssembly(),
                              // assemblies where the event messages are defined
                              typeof(DistributedTestMessage).Assembly
                             )
        // Add Azure Service Bus
       .AddAzureServiceBus(builder.Configuration)
        // Add event handlers
       .AddEventHandlersFromAssemblies([
            Assembly.GetExecutingAssembly(),
            // assemblies where the event handlers are defined
        ]);

In your appsettings.json file, add the the following configuration:

"ServiceBusConfiguration": {
    "ConnectionString": "<connection_string_to_Azure_Service_Bus",
    "SubscriptionName": "<your_app_name>"
} 
Option 2: Configure from code

builder.Services
        // Initialize EventPubSubService
       .AddEventPubSubService(
                              Assembly.GetExecutingAssembly(),
                              // assemblies where the event messages are defined
                              typeof(DistributedTestMessage).Assembly
                             )
        // Add Azure Service Bus
       .AddAzureServiceBus("<connection_string_to_Azure_Service_Bus>",
                           "<your_app_name>")
        // Add event handlers
       .AddEventHandlersFromAssemblies([
            Assembly.GetExecutingAssembly(),
            // assemblies where the event handlers are defined
        ]);
Default Configuration Value

If you use appsettings.json to configure the service bus, you can also customize the following configuration values by adding it to the JSON:

Configuration Description Value Type Default Value
ConnectionString The connection string to Azure Service Bus string required, must specify
SubscriptionName The name of the application that subscribes to the events from Azure Service Bus string required, must specify
IncludeNamespaceForTopicName Indicates if the namespace of the class is used for topic name boolean true, means the namespace will be used for topic name.<br />Set to false to only use class name as topic name
AutoDeleteOnIdle The TimeSpan idle interval after which the topic is automatically deleted. TimeSpan TimeSpan.FromDays(90), means the topic will be automatically deleted after 90 days.
DefaultMessageTimeToLive The default time to live value for the messages. This is the duration after which the message expires, starting from when the message is sent to Service Bus. TimeSpan TimeSpan.FromDays(5)
DuplicateDetectionHistoryTimeWindow The TimeSpan duration of duplicate detection history that is maintained by the service. TimeSpan TimeSpan.FromMinutes(1)
MaxSizeInMegabytes The maximum size of the topic in megabytes, which is the size of memory allocated for the topic. long 5120

Event Message Definition

Create a class that represents the event message. The class must implement the IDistributedEventMessage interface.


namespace YourProject.NameSpace;

public class DistributedTestMessage : IDistributedEventMessage
{
    public string Name { get; set; }

    // more payload properties
}

Event Handler Definition

Create a class derived from DistributedEventEventHandler<YourEventMessage> and override HandleEvent method to handle the event message.

With this implementation, you'll be able to access the original payload of the messsage by accessing OriginPayload property.



public class TestEventHandlerDistributed(ILogger<TestEventHandlerDistributed> logger)
    : DistributedEventEventHandler<DistributedTestMessage>
{
    private readonly ILogger _logger = logger;
    
    public override Task<bool> HandleEvent(DistributedTestMessage eventMessage)
    {
        // access the `OriginPayload` 
        var origin = OriginPayload;

        _logger.LogInformation($"Received message: {eventMessage.Name}");

        return Task.FromResult<bool>(true);
    }
}

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.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
2025.0.9-preview-481 0 9/29/2025
2025.0.9-preview-473 31 9/28/2025
2025.0.8 143 9/23/2025
2025.0.6 160 9/22/2025
2025.0.6-preview-455 155 9/22/2025
2025.0.6-preview-454 268 9/17/2025
2025.0.6-preview-441 122 9/14/2025
2025.0.6-preview-440 110 9/14/2025
2025.0.6-preview-406 150 9/2/2025
2025.0.6-preview-401 139 9/2/2025
2025.0.6-preview-400 142 9/2/2025
2025.0.6-preview-369 191 8/27/2025
2025.0.6-preview-368 182 8/27/2025
2025.0.6-preview-334 151 8/18/2025
2025.0.6-preview-333 146 7/27/2025
2025.0.6-preview-332 477 7/24/2025
2025.0.6-preview-331 478 7/24/2025
2025.0.6-preview-328 476 7/24/2025
2025.0.6-preview-327 335 7/21/2025
2025.0.6-preview-326 330 7/21/2025
2025.0.6-preview-325 237 7/20/2025
2025.0.6-preview-324 237 7/20/2025
2025.0.6-preview-322 239 7/20/2025
2025.0.6-preview-321 245 7/19/2025
2025.0.6-preview-320 242 7/19/2025
2025.0.6-preview-319 145 7/17/2025
2025.0.6-preview-317 144 7/17/2025
2025.0.6-preview-316 145 7/17/2025
2025.0.6-preview-315 148 7/17/2025
2025.0.6-preview-314 144 7/17/2025
2025.0.6-preview-313 148 7/17/2025
2025.0.6-preview-312 147 7/16/2025
2025.0.5 160 7/10/2025
2025.0.5-preview-307 86 7/5/2025
2025.0.4 89 7/5/2025
2025.0.4-preview-305 97 7/4/2025
2025.0.4-preview-304 159 7/1/2025
2025.0.4-preview-299 136 5/31/2025
2025.0.4-preview-298 110 5/30/2025
2025.0.4-preview-296 147 5/30/2025
2025.0.4-preview-295 161 5/29/2025
2025.0.4-preview-293 157 5/26/2025
2025.0.4-preview-292 159 5/26/2025
2025.0.3 130 2/10/2025
2025.0.3-preview-288 123 2/10/2025
2025.0.2 130 1/21/2025
2025.0.2-preview-278 105 1/21/2025
2025.0.2-preview-277 116 12/16/2024
2025.0.1-rc-243301701 391 11/25/2024
2024.0.14.6 138 11/25/2024
2024.0.14.6-rc-243031001 192 10/29/2024
2024.0.14.6-rc-243030701 121 10/29/2024
2024.0.14.6-rc-242840501 111 10/10/2024
2024.0.14.6-rc-242820305 116 10/8/2024
2024.0.14.6-rc-242771401 209 10/3/2024
2024.0.14.6-rc-242770501 113 10/3/2024
2024.0.14.6-rc-242770201 129 10/3/2024
2024.0.14.6-rc-242761801 114 10/2/2024
2024.0.14.6-rc-242761601 128 10/2/2024
2024.0.14.6-rc-242761501 120 10/2/2024
2024.0.14.6-rc-242761401 130 10/2/2024
2024.0.14.6-rc-242760701 133 10/2/2024
2024.0.14.6-rc-242751002 117 10/1/2024
2024.0.14.6-rc-242750901 137 10/1/2024
2024.0.14.6-rc-242750502 129 10/1/2024
2024.0.14.6-rc-242750201 119 10/1/2024
2024.0.14.6-rc-242741501 110 9/30/2024
2024.0.14.6-rc-242730701 143 9/29/2024
2024.0.14.6-preview-2730501 104 9/29/2024
2024.0.14.6-preview-2701501 146 9/26/2024
2024.0.14.6-preview-2620901 161 9/18/2024
2024.0.14.6-preview-2570701 124 9/13/2024
2024.0.14.6-preview-2510703 176 9/7/2024
2024.0.14.6-preview-2480501 127 9/4/2024
2024.0.14.6-preview-2430401 141 8/30/2024
2024.0.14.6-preview-242730701 109 9/29/2024
2024.0.14.6-preview-2421703 119 8/29/2024
2024.0.14.6-preview-2421701 115 8/29/2024
2024.0.14.6-preview-2420901 114 8/29/2024
2024.0.14.6-preview-2390101 126 8/26/2024
2024.0.14.6-preview-2381603 142 8/25/2024
2024.0.14.6-preview-2341601 163 8/21/2024
2024.0.14.6-preview-2321602 139 8/20/2024
2024.0.14.6-preview-2190801 146 8/6/2024
2024.0.14.6-preview-2041501 128 7/22/2024
2024.0.14.6-preview-1920603 184 7/10/2024
2024.0.14.6-preview-1920301 121 7/10/2024
2024.0.14.6-preview-1911302 132 7/9/2024
2024.0.14.6-preview-1901001 152 7/8/2024
2024.0.14.6-preview-1900901 127 7/8/2024
2024.0.14.6-preview-1900801 120 7/8/2024
2024.0.14.6-preview-1860304 130 7/4/2024
2024.0.14.5 184 7/1/2024
2024.0.14.5-preview-1811601 121 6/29/2024
2024.0.14.5-preview-1810501 152 6/29/2024
2024.0.14.5-preview-180132 130 6/28/2024
2024.0.14.5-preview-180131 131 6/28/2024
2024.0.14.5-preview-180121 114 6/28/2024
2024.0.14.4 144 6/27/2024
2024.0.14.4-preview-7 120 6/27/2024
2024.0.14.3 141 6/21/2024
2024.0.14.1 139 6/6/2024
2024.0.14.1-preview 119 6/6/2024
2024.0.14-preview-1 128 6/6/2024
2024.0.13.8-preview 136 6/6/2024
2024.0.13.1-preview-0146 137 6/6/2024
2024.0.12.15803-preview-03 121 6/6/2024
2024.0.12.15608 134 6/4/2024
2024.0.12.15515 216 6/3/2024
2024.0.12.15220 126 5/31/2024
2024.0.12.15220-alpha31-240... 115 5/31/2024
2024.0.12.14911 178 5/28/2024
2024.0.12.14910-alpha28-240... 127 5/28/2024
2024.0.12.14823 168 5/27/2024
2024.0.12.14522-alpha7-2405... 138 5/24/2024
2024.0.12.14514-alpha6-2405... 131 5/24/2024
2024.0.12.14511 152 5/24/2024
2024.0.12.14314 193 5/22/2024
2024.0.12.14114 189 5/20/2024