DotNetBrightener.Plugins.EventPubSub.Abstractions 2024.0.14.4-preview-7

This is a prerelease version of DotNetBrightener.Plugins.EventPubSub.Abstractions.
There is a newer version of this package available.
See the version list below for details.
dotnet add package DotNetBrightener.Plugins.EventPubSub.Abstractions --version 2024.0.14.4-preview-7                
NuGet\Install-Package DotNetBrightener.Plugins.EventPubSub.Abstractions -Version 2024.0.14.4-preview-7                
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.Abstractions" Version="2024.0.14.4-preview-7" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add DotNetBrightener.Plugins.EventPubSub.Abstractions --version 2024.0.14.4-preview-7                
#r "nuget: DotNetBrightener.Plugins.EventPubSub.Abstractions, 2024.0.14.4-preview-7"                
#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.Abstractions as a Cake Addin
#addin nuget:?package=DotNetBrightener.Plugins.EventPubSub.Abstractions&version=2024.0.14.4-preview-7&prerelease

// Install DotNetBrightener.Plugins.EventPubSub.Abstractions as a Cake Tool
#tool nuget:?package=DotNetBrightener.Plugins.EventPubSub.Abstractions&version=2024.0.14.4-preview-7&prerelease                

Event Publish/Subscribe Library

© DotNet Brightener

NuGet Version

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)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

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

Package Downloads
DotNetBrightener.Plugins.EventPubSub

An event publisher / subscriber library for .Net Core Application

DotNetBrightener.DataAccess.Abstractions.Models

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2024.0.14.6-rc-243031001 280 10/29/2024
2024.0.14.6-rc-243030701 267 10/29/2024
2024.0.14.6-rc-242840501 257 10/10/2024
2024.0.14.6-rc-242820305 244 10/8/2024
2024.0.14.6-rc-242771401 344 10/3/2024
2024.0.14.6-rc-242770501 250 10/3/2024
2024.0.14.6-rc-242770201 253 10/3/2024
2024.0.14.6-rc-242761801 246 10/2/2024
2024.0.14.6-rc-242761601 261 10/2/2024
2024.0.14.6-rc-242761501 250 10/2/2024
2024.0.14.6-rc-242761401 269 10/2/2024
2024.0.14.6-rc-242760701 273 10/2/2024
2024.0.14.6-rc-242751002 264 10/1/2024
2024.0.14.6-rc-242750901 280 10/1/2024
2024.0.14.6-rc-242750502 274 10/1/2024
2024.0.14.6-rc-242750201 288 10/1/2024
2024.0.14.6-rc-242741501 260 9/30/2024
2024.0.14.6-rc-242730701 285 9/29/2024
2024.0.14.6-preview-2730501 249 9/29/2024
2024.0.14.6-preview-2701501 279 9/26/2024
2024.0.14.6-preview-2620901 318 9/18/2024
2024.0.14.6-preview-2570701 322 9/13/2024
2024.0.14.6-preview-2510703 407 9/7/2024
2024.0.14.6-preview-2480501 428 9/4/2024
2024.0.14.6-preview-2430401 370 8/30/2024
2024.0.14.6-preview-242730701 279 9/29/2024
2024.0.14.6-preview-2421703 303 8/29/2024
2024.0.14.6-preview-2421701 291 8/29/2024
2024.0.14.6-preview-2420901 292 8/29/2024
2024.0.14.6-preview-2390101 338 8/26/2024
2024.0.14.6-preview-2381603 318 8/25/2024
2024.0.14.6-preview-2341601 339 8/21/2024
2024.0.14.6-preview-2321602 309 8/20/2024
2024.0.14.6-preview-2190801 295 8/6/2024
2024.0.14.6-preview-2041501 274 7/22/2024
2024.0.14.6-preview-1920603 342 7/10/2024
2024.0.14.6-preview-1920301 298 7/10/2024
2024.0.14.6-preview-1911302 297 7/9/2024
2024.0.14.6-preview-1901001 299 7/8/2024
2024.0.14.6-preview-1900901 268 7/8/2024
2024.0.14.6-preview-1900801 269 7/8/2024
2024.0.14.6-preview-1860304 279 7/4/2024
2024.0.14.5 373 7/1/2024
2024.0.14.5-preview-1811601 292 6/29/2024
2024.0.14.5-preview-1810501 317 6/29/2024
2024.0.14.5-preview-180132 369 6/28/2024
2024.0.14.5-preview-180131 297 6/28/2024
2024.0.14.5-preview-180121 289 6/28/2024
2024.0.14.4 433 6/27/2024
2024.0.14.4-preview-7 316 6/27/2024
2024.0.14.3 332 6/21/2024
2024.0.14.1 317 6/6/2024
2024.0.14.1-preview 306 6/6/2024
2024.0.14-preview-1 285 6/6/2024
2024.0.13.8-preview 326 6/6/2024
2024.0.13.1-preview-0146 364 6/6/2024
2024.0.12.15803-preview-03 301 6/6/2024
2024.0.12.15608 313 6/4/2024
2024.0.12.15515 373 6/3/2024
2024.0.12.15220 295 5/31/2024
2024.0.12.15220-alpha31-240... 291 5/31/2024
2024.0.12.14911 344 5/28/2024
2024.0.12.14910-alpha28-240... 307 5/28/2024
2024.0.12.14823 335 5/27/2024
2024.0.12.14522-alpha7-2405... 302 5/24/2024
2024.0.12.14514-alpha6-2405... 318 5/24/2024
2024.0.12.14511 346 5/24/2024
2024.0.12.14314 380 5/22/2024