DotNetBrightener.Plugins.EventPubSub 2024.0.8

dotnet add package DotNetBrightener.Plugins.EventPubSub --version 2024.0.8
NuGet\Install-Package DotNetBrightener.Plugins.EventPubSub -Version 2024.0.8
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" Version="2024.0.8" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add DotNetBrightener.Plugins.EventPubSub --version 2024.0.8
#r "nuget: DotNetBrightener.Plugins.EventPubSub, 2024.0.8"
#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.
// Install DotNetBrightener.Plugins.EventPubSub as a Cake Addin
#addin nuget:?package=DotNetBrightener.Plugins.EventPubSub&version=2024.0.8

// Install DotNetBrightener.Plugins.EventPubSub as a Cake Tool
#tool nuget:?package=DotNetBrightener.Plugins.EventPubSub&version=2024.0.8

Event Publish/Subscribe Library

© DotNet Brightener

Usage

Event message

Event message is a message that would be emitted by the IEventPublisher. The IEventHandler for the message will be proceeded sequentially, and will be stopped if the higher-prioritized handler tells the next one to stop by returning false in its HandleEvent method.

public class YourEventMessage: IEventMessage 
{
	// your model goes here
}
Non-Stopped event message

Non-stopped event message is the type of IEventMessage that will be handled by all the handlers regardless the result from the process of each handler.

public class YourEventMessage: INonStoppedEventMessage 
{
	// your model goes here
}
Define event handler

Define an event handler to process the event emitted by the IEventPublisher service as follow:

public class YourEventModelEventHandler: IEventHandler<YourEventMessage>
{
	// the higher number will tell the publisher to execute before the others
	public int Priority { get; } => 10;

	public async Task<bool> HandleEvent(YourEventMessage eventMessage) 
	{
		// do something with your eventMessage

		// if YourEventModel implements INonStoppedEventMessage, 
		// regardless the next statement, 
		// the next handler will continue to process in parallel

		// if you want to let the next handler to process the message
		return true;

		// otherwise, return false here;
		// return false;
	}
}

Emit the event

Inject IEventPublisher to your controller / service class and use it as follow:


public class SomeService 
{
	private readonly IEventPublisher _eventPublisher;
	// other services

	public SomeService(IEventPublisher eventPublisher, 
						// other services
						)
	{
		_eventPublisher = eventPublisher;
	}

	public async Task SomeMethod() 
	{
		var eventMessage = new YourEventMessage
		{
			// the event content
		};

		// if you want to let the event message to be processed in the current thread
		await _eventPublisher.Publish(eventMessage);

		// if you want to let the event message to be processed in the another thread
		await _eventPublisher.Publish(eventMessage, true);
	}
}

Register at startup

You will need to install the package DotNetBrightener.Plugins.EventPubSub.DependencyInjection from nuget.org and follow instruction there.

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. 
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (9)

Showing the top 5 NuGet packages that depend on DotNetBrightener.Plugins.EventPubSub:

Package Downloads
DotNetBrightener.DataAccess.EF

Package Description

DotNetBrightener.Core.Logging

Package Description

DotNetBrightener.SimpleUploadService

A Simple Upload API for ASP.NET Core Applications

DotNetBrightener.Plugins.EventPubSub.DependencyInjection

Package Description

DotNetBrightener.WebApp.CommonShared

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2024.0.8 163 2/1/2024
2024.0.7 119 1/26/2024
2024.0.6 115 1/25/2024
2024.0.5 112 1/24/2024
2024.0.4 110 1/24/2024
2024.0.3 120 1/22/2024
2024.0.2 168 1/10/2024
2024.0.1 125 1/9/2024
2024.0.1-alpha-3 106 1/9/2024
2024.0.1-alpha-2 96 1/9/2024
2024.0.1-alpha-1 131 1/3/2024
2024.0.0 161 12/26/2023
2023.0.27 204 12/21/2023
2023.0.26 166 12/21/2023
2023.0.25 229 12/11/2023
2023.0.24 217 12/8/2023
2023.0.23 181 12/6/2023
2023.0.21 240 12/4/2023
2023.0.20 236 11/27/2023
2023.0.19 172 11/20/2023
2023.0.18 207 10/25/2023
2023.0.17 256 10/22/2023
2023.0.16 239 10/16/2023
2023.0.16-alpha-1 135 10/16/2023
2023.0.15 196 10/14/2023
2023.0.14 171 10/14/2023
2023.0.13 156 10/14/2023
2023.0.12 183 10/14/2023
2023.0.11 168 10/10/2023
2023.0.10 186 10/9/2023
2023.0.9 284 8/16/2023
2023.0.8 232 8/15/2023
2023.0.8-alpha-2 307 5/31/2023
2023.0.7 255 5/12/2023
2023.0.6 273 5/10/2023
2023.0.5 258 5/7/2023
2023.0.4 287 4/22/2023
2023.0.3 320 4/19/2023
2023.0.2 316 4/6/2023
2023.0.1 338 3/13/2023
2022.11.0 402 11/21/2022
2022.10.2 313 11/21/2022
2022.10.0 1,586 10/15/2022
2022.9.0 481 9/5/2022
2021.10.1 460 10/17/2021
1.0.0 475 1/19/2021