DotNetBrightener.Plugins.EventPubSub
2024.0.14.6-preview-2321602
This is a prerelease version of DotNetBrightener.Plugins.EventPubSub.
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package DotNetBrightener.Plugins.EventPubSub --version 2024.0.14.6-preview-2321602
NuGet\Install-Package DotNetBrightener.Plugins.EventPubSub -Version 2024.0.14.6-preview-2321602
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.6-preview-2321602" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="DotNetBrightener.Plugins.EventPubSub" Version="2024.0.14.6-preview-2321602" />
<PackageReference Include="DotNetBrightener.Plugins.EventPubSub" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add DotNetBrightener.Plugins.EventPubSub --version 2024.0.14.6-preview-2321602
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: DotNetBrightener.Plugins.EventPubSub, 2024.0.14.6-preview-2321602"
#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.
#:package DotNetBrightener.Plugins.EventPubSub@2024.0.14.6-preview-2321602
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=DotNetBrightener.Plugins.EventPubSub&version=2024.0.14.6-preview-2321602&prerelease
#tool nuget:?package=DotNetBrightener.Plugins.EventPubSub&version=2024.0.14.6-preview-2321602&prerelease
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
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. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net8.0
- DotNetBrightener.Plugins.EventPubSub.Abstractions (>= 2024.0.14.6-preview-2321602)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.1)
NuGet packages (10)
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.Infrastructure.ApiKeyAuthentication
Package Description |
|
|
DotNetBrightener.WebApp.CommonShared
Package Description |
GitHub repositories
This package is not used by any popular GitHub repositories.