DotNetBrightener.Plugins.EventPubSub.Abstractions
2024.0.14.5
See the version list below for details.
dotnet add package DotNetBrightener.Plugins.EventPubSub.Abstractions --version 2024.0.14.5
NuGet\Install-Package DotNetBrightener.Plugins.EventPubSub.Abstractions -Version 2024.0.14.5
<PackageReference Include="DotNetBrightener.Plugins.EventPubSub.Abstractions" Version="2024.0.14.5" />
paket add DotNetBrightener.Plugins.EventPubSub.Abstractions --version 2024.0.14.5
#r "nuget: DotNetBrightener.Plugins.EventPubSub.Abstractions, 2024.0.14.5"
// Install DotNetBrightener.Plugins.EventPubSub.Abstractions as a Cake Addin
#addin nuget:?package=DotNetBrightener.Plugins.EventPubSub.Abstractions&version=2024.0.14.5
// Install DotNetBrightener.Plugins.EventPubSub.Abstractions as a Cake Tool
#tool nuget:?package=DotNetBrightener.Plugins.EventPubSub.Abstractions&version=2024.0.14.5
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 | Versions 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. |
-
net8.0
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.1)
- Newtonsoft.Json (>= 13.0.3)
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-preview-1860304 | 22 | 7/4/2024 |
2024.0.14.5 | 197 | 7/1/2024 |
2024.0.14.5-preview-1811601 | 168 | 6/29/2024 |
2024.0.14.5-preview-1810501 | 188 | 6/29/2024 |
2024.0.14.5-preview-180132 | 186 | 6/28/2024 |
2024.0.14.5-preview-180131 | 169 | 6/28/2024 |
2024.0.14.5-preview-180121 | 165 | 6/28/2024 |
2024.0.14.4 | 242 | 6/27/2024 |
2024.0.14.4-preview-7 | 186 | 6/27/2024 |
2024.0.14.3 | 195 | 6/21/2024 |
2024.0.14.1 | 197 | 6/6/2024 |
2024.0.14.1-preview | 185 | 6/6/2024 |
2024.0.14-preview-1 | 172 | 6/6/2024 |
2024.0.13.8-preview | 196 | 6/6/2024 |
2024.0.13.1-preview-0146 | 219 | 6/6/2024 |
2024.0.12.15803-preview-03 | 188 | 6/6/2024 |
2024.0.12.15608 | 191 | 6/4/2024 |
2024.0.12.15515 | 259 | 6/3/2024 |
2024.0.12.15220 | 172 | 5/31/2024 |
2024.0.12.15220-alpha31-240... | 174 | 5/31/2024 |
2024.0.12.14911 | 218 | 5/28/2024 |
2024.0.12.14910-alpha28-240... | 185 | 5/28/2024 |
2024.0.12.14823 | 199 | 5/27/2024 |
2024.0.12.14522-alpha7-2405... | 189 | 5/24/2024 |
2024.0.12.14514-alpha6-2405... | 190 | 5/24/2024 |
2024.0.12.14511 | 210 | 5/24/2024 |
2024.0.12.14314 | 251 | 5/22/2024 |