Signals-pubsub
1.0.0
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 Signals-pubsub --version 1.0.0
NuGet\Install-Package Signals-pubsub -Version 1.0.0
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="Signals-pubsub" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Signals-pubsub" Version="1.0.0" />
<PackageReference Include="Signals-pubsub" />
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 Signals-pubsub --version 1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Signals-pubsub, 1.0.0"
#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 Signals-pubsub@1.0.0
#: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=Signals-pubsub&version=1.0.0
#tool nuget:?package=Signals-pubsub&version=1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Signals
Siganal is a simple to use pub-sub framework. It is designed to allow you to separate concerns easily
Installation
Use Nuget to install the latest version
Install-Package Signals
Usage
(in startup.cs)
using Signals.Extensions;
public void ConfigureServices(IServiceCollection services)
{
// add controllers etc
services.AddSignalProcessor(); // add an instance of ISignalProcessor
services.AddSignalHandlers(GetType().Assembly); // adds any signal handlers from this assembly
}
make a message class to send, derived from the Signal class
using Signals;
public class BookPriceSignal : Signal
{
public BookPriceSignal(int bookId)
{
BookId = bookId;
}
public int BookId { get; }
public Book BookDetails { get; set; }
}
make a handler to process the signal
using Signals.Context;
using Signals.Handlers;
public class BookDetailsHandler : SignalHandler<BookPriceSignal>
{
public override int Order => 0; // this denotes the order of handlers
protected override Task OnSignal(BookPriceSignal signal, ISignalContext context, CancellationToken token)
{
var bookDetails = dataRepository.GetBook(signal.BookId);
signal.BookDetails = bookDetails;
return Task.CompletedTask;
}
}
finally you can send a message send a message
var signal = await signalProcessor.Process(new BookPriceSignal(id));
var bookDetails = signal.BookDetails;
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
License
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 is compatible. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. 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-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.
-
net5.0
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.