DotNetBrightener.Plugins.EventPubSub 2024.0.14.5

There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package DotNetBrightener.Plugins.EventPubSub --version 2024.0.14.5                
NuGet\Install-Package DotNetBrightener.Plugins.EventPubSub -Version 2024.0.14.5                
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.14.5" />                
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.14.5                
#r "nuget: DotNetBrightener.Plugins.EventPubSub, 2024.0.14.5"                
#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.14.5

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

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 (14)

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

Package Downloads
DotNetBrightener.Core.BackgroundTasks

Package Description

DotNetBrightener.Plugins.EventPubSub.DependencyInjection

Package Description

DotNetBrightener.SimpleUploadService

A Simple Upload API for ASP.NET Core Applications

DotNetBrightener.WebApp.CommonShared

Package Description

DotNetBrightener.Infrastructure.ApiKeyAuthentication

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2024.0.14.6-rc-243031001 176 10/29/2024
2024.0.14.6-rc-243030701 151 10/29/2024
2024.0.14.6-rc-242840501 145 10/10/2024
2024.0.14.6-rc-242820305 135 10/8/2024
2024.0.14.6-rc-242771401 254 10/3/2024
2024.0.14.6-rc-242770501 136 10/3/2024
2024.0.14.6-rc-242770201 151 10/3/2024
2024.0.14.6-rc-242761801 134 10/2/2024
2024.0.14.6-rc-242761601 150 10/2/2024
2024.0.14.6-rc-242761501 134 10/2/2024
2024.0.14.6-rc-242761401 146 10/2/2024
2024.0.14.6-rc-242760701 154 10/2/2024
2024.0.14.6-rc-242751002 145 10/1/2024
2024.0.14.6-rc-242750901 163 10/1/2024
2024.0.14.6-rc-242750502 158 10/1/2024
2024.0.14.6-rc-242750201 181 10/1/2024
2024.0.14.6-rc-242741501 161 9/30/2024
2024.0.14.6-rc-242730701 170 9/29/2024
2024.0.14.6-preview-2730501 137 9/29/2024
2024.0.14.6-preview-2701501 179 9/26/2024
2024.0.14.6-preview-2620901 197 9/18/2024
2024.0.14.6-preview-2570701 188 9/13/2024
2024.0.14.6-preview-2510703 243 9/7/2024
2024.0.14.6-preview-2480501 266 9/4/2024
2024.0.14.6-preview-2430401 219 8/30/2024
2024.0.14.6-preview-242730701 145 9/29/2024
2024.0.14.6-preview-2421703 174 8/29/2024
2024.0.14.6-preview-2421701 170 8/29/2024
2024.0.14.6-preview-2420901 169 8/29/2024
2024.0.14.6-preview-2390101 204 8/26/2024
2024.0.14.6-preview-2381603 196 8/25/2024
2024.0.14.6-preview-2341601 210 8/21/2024
2024.0.14.6-preview-2321602 183 8/20/2024
2024.0.14.6-preview-2190801 202 8/6/2024
2024.0.14.6-preview-2041501 161 7/22/2024
2024.0.14.6-preview-1920603 230 7/10/2024
2024.0.14.6-preview-1920301 163 7/10/2024
2024.0.14.6-preview-1911302 167 7/9/2024
2024.0.14.6-preview-1901001 162 7/8/2024
2024.0.14.6-preview-1900901 145 7/8/2024
2024.0.14.6-preview-1900801 157 7/8/2024
2024.0.14.6-preview-1860304 146 7/4/2024
2024.0.14.5 255 7/1/2024
2024.0.14.5-preview-1811601 186 6/29/2024
2024.0.14.5-preview-1810501 190 6/29/2024
2024.0.14.5-preview-180132 192 6/28/2024
2024.0.14.5-preview-180131 172 6/28/2024
2024.0.14.5-preview-180121 178 6/28/2024
2024.0.14.4 229 6/27/2024
2024.0.14.4-preview-7 181 6/27/2024
2024.0.14.3 181 6/21/2024
2024.0.14.1 185 6/6/2024
2024.0.14.1-preview 166 6/6/2024
2024.0.14-preview-1 166 6/6/2024
2024.0.13.8-preview 191 6/6/2024
2024.0.13.1-preview-0146 203 6/6/2024
2024.0.12.15803-preview-03 170 6/6/2024
2024.0.12.15608 182 6/4/2024
2024.0.12.15515 258 6/3/2024
2024.0.12.15220 179 5/31/2024
2024.0.12.15220-alpha31-240... 159 5/31/2024
2024.0.12.14911 221 5/28/2024
2024.0.12.14910-alpha28-240... 186 5/28/2024
2024.0.12.14823 200 5/27/2024
2024.0.12.14522-alpha7-2405... 188 5/24/2024
2024.0.12.14514-alpha6-2405... 194 5/24/2024
2024.0.12.14511 203 5/24/2024
2024.0.12.14314 245 5/22/2024
2024.0.12.14114 291 5/20/2024
2024.0.12.12815 293 5/7/2024
2024.0.12.12814 251 5/7/2024
2024.0.12.12721 270 5/6/2024
2024.0.12.12702 258 5/5/2024
2024.0.12.12622 260 5/5/2024
2024.0.12.12514 241 5/4/2024
2024.0.12.12512 248 5/4/2024
2024.0.12.12510 240 5/4/2024
2024.0.12.12420 226 5/3/2024
2024.0.12.12319 187 5/2/2024
2024.0.12.12319-rc-2405021801 176 5/2/2024
2024.0.12.12318 185 5/2/2024
2024.0.12.12215 241 5/1/2024
2024.0.12.12011 208 4/29/2024
2024.0.12.11720 223 4/26/2024
2024.0.12.11719 215 4/26/2024
2024.0.12.11621 255 4/25/2024
2024.0.12.11523 235 4/24/2024
2024.0.12.11522 226 4/24/2024
2024.0.12.11417 229 4/23/2024
2024.0.12.11400 220 4/22/2024
2024.0.12.11316 219 4/22/2024
2024.0.11.10220 201 4/11/2024
2024.0.11.10120 190 4/10/2024
2024.0.11.10119 168 4/10/2024
2024.0.11.10115 179 4/10/2024
2024.0.11.9914 206 4/8/2024
2024.0.11.9901 200 4/7/2024
2024.0.11.9823 198 4/7/2024
2024.0.11.9401 195 4/2/2024
2024.0.11.9301 208 4/1/2024
2024.0.11.9206 186 3/31/2024
2024.0.11.9205 183 3/31/2024
2024.0.11.8200 219 3/21/2024
2024.0.11.8122 179 3/21/2024
2024.0.11.8120 190 3/21/2024
2024.0.11.7320 248 3/13/2024
2024.0.11.7316 194 3/13/2024
2024.0.11.7310 197 3/13/2024
2024.0.11 197 3/13/2024
2024.0.10 224 3/3/2024
2024.0.9 207 2/27/2024
2024.0.8 252 2/1/2024
2024.0.7 200 1/26/2024
2024.0.6 192 1/25/2024
2024.0.5 187 1/24/2024
2024.0.4 190 1/24/2024
2024.0.3 199 1/22/2024
2024.0.2 245 1/10/2024
2024.0.1 200 1/9/2024
2024.0.1-alpha-3 183 1/9/2024
2024.0.1-alpha-2 200 1/9/2024
2024.0.1-alpha-1 214 1/3/2024
2024.0.0 238 12/26/2023
2023.0.27 296 12/21/2023
2023.0.26 252 12/21/2023
2023.0.25 308 12/11/2023
2023.0.24 295 12/8/2023
2023.0.23 271 12/6/2023
2023.0.21 341 12/4/2023
2023.0.20 335 11/27/2023
2023.0.19 267 11/20/2023
2023.0.18 296 10/25/2023
2023.0.17 342 10/22/2023
2023.0.16 321 10/16/2023
2023.0.16-alpha-1 209 10/16/2023
2023.0.15 272 10/14/2023
2023.0.14 256 10/14/2023
2023.0.13 249 10/14/2023
2023.0.12 260 10/14/2023
2023.0.11 249 10/10/2023
2023.0.10 267 10/9/2023
2023.0.9 400 8/16/2023
2023.0.8 316 8/15/2023
2023.0.8-alpha-2 385 5/31/2023
2023.0.7 332 5/12/2023
2023.0.6 369 5/10/2023
2023.0.5 336 5/7/2023
2023.0.4 369 4/22/2023
2023.0.3 411 4/19/2023
2023.0.2 402 4/6/2023
2023.0.1 411 3/13/2023
2022.11.0 439 11/21/2022
2022.10.2 343 11/21/2022
2022.10.0 1,710 10/15/2022
2022.9.0 515 9/5/2022
2021.10.1 497 10/17/2021
1.0.0 512 1/19/2021