DotNetBrightener.Plugins.EventPubSub.AzureServiceBus 2025.0.4-preview-298

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 2025.0.4-preview-298
                    
NuGet\Install-Package DotNetBrightener.Plugins.EventPubSub.AzureServiceBus -Version 2025.0.4-preview-298
                    
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="2025.0.4-preview-298" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="DotNetBrightener.Plugins.EventPubSub.AzureServiceBus" Version="2025.0.4-preview-298" />
                    
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 2025.0.4-preview-298
                    
#r "nuget: DotNetBrightener.Plugins.EventPubSub.AzureServiceBus, 2025.0.4-preview-298"
                    
#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.
#addin nuget:?package=DotNetBrightener.Plugins.EventPubSub.AzureServiceBus&version=2025.0.4-preview-298&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=DotNetBrightener.Plugins.EventPubSub.AzureServiceBus&version=2025.0.4-preview-298&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 net9.0 is compatible.  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.5-preview-307 0 7/5/2025
2025.0.4 0 7/5/2025
2025.0.4-preview-305 19 7/4/2025
2025.0.4-preview-304 118 7/1/2025
2025.0.4-preview-299 109 5/31/2025
2025.0.4-preview-298 86 5/30/2025
2025.0.4-preview-296 122 5/30/2025
2025.0.4-preview-295 136 5/29/2025
2025.0.4-preview-293 133 5/26/2025
2025.0.4-preview-292 134 5/26/2025
2025.0.3 109 2/10/2025
2025.0.3-preview-288 102 2/10/2025
2025.0.2 109 1/21/2025
2025.0.2-preview-278 85 1/21/2025
2025.0.2-preview-277 95 12/16/2024
2025.0.1-rc-243301701 369 11/25/2024
2024.0.14.6 117 11/25/2024
2024.0.14.6-rc-243031001 170 10/29/2024
2024.0.14.6-rc-243030701 101 10/29/2024
2024.0.14.6-rc-242840501 91 10/10/2024
2024.0.14.6-rc-242820305 97 10/8/2024
2024.0.14.6-rc-242771401 190 10/3/2024
2024.0.14.6-rc-242770501 94 10/3/2024
2024.0.14.6-rc-242770201 109 10/3/2024
2024.0.14.6-rc-242761801 94 10/2/2024
2024.0.14.6-rc-242761601 109 10/2/2024
2024.0.14.6-rc-242761501 99 10/2/2024
2024.0.14.6-rc-242761401 110 10/2/2024
2024.0.14.6-rc-242760701 114 10/2/2024
2024.0.14.6-rc-242751002 96 10/1/2024
2024.0.14.6-rc-242750901 115 10/1/2024
2024.0.14.6-rc-242750502 108 10/1/2024
2024.0.14.6-rc-242750201 99 10/1/2024
2024.0.14.6-rc-242741501 90 9/30/2024
2024.0.14.6-rc-242730701 122 9/29/2024
2024.0.14.6-preview-2730501 82 9/29/2024
2024.0.14.6-preview-2701501 126 9/26/2024
2024.0.14.6-preview-2620901 139 9/18/2024
2024.0.14.6-preview-2570701 104 9/13/2024
2024.0.14.6-preview-2510703 156 9/7/2024
2024.0.14.6-preview-2480501 107 9/4/2024
2024.0.14.6-preview-2430401 122 8/30/2024
2024.0.14.6-preview-242730701 89 9/29/2024
2024.0.14.6-preview-2421703 100 8/29/2024
2024.0.14.6-preview-2421701 95 8/29/2024
2024.0.14.6-preview-2420901 95 8/29/2024
2024.0.14.6-preview-2390101 105 8/26/2024
2024.0.14.6-preview-2381603 121 8/25/2024
2024.0.14.6-preview-2341601 143 8/21/2024
2024.0.14.6-preview-2321602 120 8/20/2024
2024.0.14.6-preview-2190801 126 8/6/2024
2024.0.14.6-preview-2041501 107 7/22/2024
2024.0.14.6-preview-1920603 164 7/10/2024
2024.0.14.6-preview-1920301 101 7/10/2024
2024.0.14.6-preview-1911302 111 7/9/2024
2024.0.14.6-preview-1901001 122 7/8/2024
2024.0.14.6-preview-1900901 107 7/8/2024
2024.0.14.6-preview-1900801 100 7/8/2024
2024.0.14.6-preview-1860304 105 7/4/2024
2024.0.14.5 165 7/1/2024
2024.0.14.5-preview-1811601 100 6/29/2024
2024.0.14.5-preview-1810501 122 6/29/2024
2024.0.14.5-preview-180132 110 6/28/2024
2024.0.14.5-preview-180131 112 6/28/2024
2024.0.14.5-preview-180121 94 6/28/2024
2024.0.14.4 124 6/27/2024
2024.0.14.4-preview-7 101 6/27/2024
2024.0.14.3 122 6/21/2024
2024.0.14.1 119 6/6/2024
2024.0.14.1-preview 98 6/6/2024
2024.0.14-preview-1 108 6/6/2024
2024.0.13.8-preview 117 6/6/2024
2024.0.13.1-preview-0146 117 6/6/2024
2024.0.12.15803-preview-03 102 6/6/2024
2024.0.12.15608 114 6/4/2024
2024.0.12.15515 196 6/3/2024
2024.0.12.15220 106 5/31/2024
2024.0.12.15220-alpha31-240... 96 5/31/2024
2024.0.12.14911 157 5/28/2024
2024.0.12.14910-alpha28-240... 108 5/28/2024
2024.0.12.14823 147 5/27/2024
2024.0.12.14522-alpha7-2405... 117 5/24/2024
2024.0.12.14514-alpha6-2405... 112 5/24/2024
2024.0.12.14511 132 5/24/2024
2024.0.12.14314 172 5/22/2024
2024.0.12.14114 167 5/20/2024