DotNetBrightener.Plugins.EventPubSub 2023.0.21

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

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

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 net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android 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 (8)

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

Package Downloads
DotNetBrightener.DataAccess.EF

Package Description

DotNetBrightener.Plugins.EventPubSub.DependencyInjection

Package Description

DotNetBrightener.SimpleUploadService

A Simple Upload API for ASP.NET Core Applications

DotNetBrightener.Core.Logging

Package Description

DotNetBrightener.WebApp.CommonShared

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2023.0.21 79 12/4/2023
2023.0.20 114 11/27/2023
2023.0.19 78 11/20/2023
2023.0.18 134 10/25/2023
2023.0.17 187 10/22/2023
2023.0.16 192 10/16/2023
2023.0.16-alpha-1 83 10/16/2023
2023.0.15 133 10/14/2023
2023.0.14 113 10/14/2023
2023.0.13 111 10/14/2023
2023.0.12 118 10/14/2023
2023.0.11 121 10/10/2023
2023.0.10 125 10/9/2023
2023.0.9 202 8/16/2023
2023.0.8 175 8/15/2023
2023.0.8-alpha-2 240 5/31/2023
2023.0.7 208 5/12/2023
2023.0.6 222 5/10/2023
2023.0.5 208 5/7/2023
2023.0.4 232 4/22/2023
2023.0.3 267 4/19/2023
2023.0.2 263 4/6/2023
2023.0.1 278 3/13/2023
2022.11.0 376 11/21/2022
2022.10.2 279 11/21/2022
2022.10.0 1,521 10/15/2022
2022.9.0 464 9/5/2022
2021.10.1 415 10/17/2021
1.0.0 432 1/19/2021