HDByte.MessageBroker 4.0.0

dotnet add package HDByte.MessageBroker --version 4.0.0
                    
NuGet\Install-Package HDByte.MessageBroker -Version 4.0.0
                    
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="HDByte.MessageBroker" Version="4.0.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="HDByte.MessageBroker" Version="4.0.0" />
                    
Directory.Packages.props
<PackageReference Include="HDByte.MessageBroker" />
                    
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 HDByte.MessageBroker --version 4.0.0
                    
#r "nuget: HDByte.MessageBroker, 4.0.0"
                    
#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 HDByte.MessageBroker@4.0.0
                    
#: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=HDByte.MessageBroker&version=4.0.0
                    
Install as a Cake Addin
#tool nuget:?package=HDByte.MessageBroker&version=4.0.0
                    
Install as a Cake Tool

MessageBroker

Nuget Version Downloads Lines Of Code

GitHub issues

Quick Introduction

'MessageBroker' is an implementation of the Publish/Subscribe programming pattern and is used to announce and react to events asynchronously. An advantage of this pattern is that the sender and receiver are not coupled together.

By default, all events are processed on a background tasks unless otherwise specified. Events that require UI interaction can be run on the UI thread provided that the attribute ActionThread.UI is applied to the subscribe event.

Getting Started

BrokerManager.GetBroker() is a static method that always returns the same instance of Broker.

HDByte.MessageBroker.Broker Broker = BrokerManager.GetBroker();

Example - Publishing

public void PlaceFakeOrder()
{
    var order = new CustomerOrder() { Name = "John Smith", ItemName = "Mousepad", ItemCost = 10.99, ItemQuantity = 3 };
    Broker.Publish(order);
}

public class CustomerOrder
{
    public string Name {get; set; }
    public string ItemName { get; set; }
    public double ItemCost { get; set; }
    public int ItemQuantity { get; set; }

    public double GetTotalCost()
    {
        return ItemCost * ItemQuantity;
    }
}

Example - Subscribing

Using ActionThread.UI because this event will update the UI. Remove this if the event does not need to update the UI. Using ActionThread.Background will cause the events to run on the background thread. (Be careful of Thread Locking) Using ActionThread.Task will cause the events to run in a task. (Default)

Broker.Subscribe<CustomerOrder>(OnNewOrder, ActionThread.UI);
Broker.Subscribe<Item>(OnNewItem, ActionThread.Background);

private void OnNewOrder(CustomerOrder order)
{
    textBox1.Text = order.Name;
    Debug.WriteLine(order.GetTotalCost());
}

private void OnNewItem(Item item)
{
    Debug.WriteLine(item.Name));
}
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
4.0.0 172 11/30/2024
3.2.0 539 6/5/2022
3.1.2 507 6/1/2022
3.1.1 487 6/1/2022
3.0.1 663 6/19/2020
3.0.0 550 5/12/2020
2.0.0 534 4/24/2020
1.1.1 576 4/7/2020
1.1.0 624 12/1/2019
1.0.0 577 11/29/2019