EventRouter 1.0.0

A library providing a generic one-way event routing mechanism for any kind of events.

There is a newer version of this package available.
See the version list below for details.
Install-Package EventRouter -Version 1.0.0
dotnet add package EventRouter --version 1.0.0
<PackageReference Include="EventRouter" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add EventRouter --version 1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: EventRouter, 1.0.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install EventRouter as a Cake Addin
#addin nuget:?package=EventRouter&version=1.0.0

// Install EventRouter as a Cake Tool
#tool nuget:?package=EventRouter&version=1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Event Routing

The goal of this library is to provide a generic one-way event routing mechanism for any kind of events.

Principles

The main component of this library is the Hub<T> class which implements IHub<T> and handles routing of events via configured routers.

The type of routed events is specified as the generic type parameter T to the class Hub<T> and must implement IRoutable.

The routers forwarding events of type IRoutable themselves must implement IRouter<T> with T being the type of events.

Routers can be assigned to a hub by calling a hub's ReconfigureAsync method handing in an instance of HubConfiguration<T> which contains references to the router instances.

A configuration can also specify preprocessors implementing IRoutablePreprocessor<T>. Preprocessors are automatically invoked for each single forwarded event by the hub right before handing the event over to the configured routers allowing for filtering or replacing of events depending on the preprocessors' logic. Any preprocessor may decide via the OnEnqueueing property whether the preprocessing needs to be done immediately while enqueueing (in a blocking fashion) or asynchronously right before forwarding an event to the configured routers.

A built-in preprocessor is FilterPreprocessor which allows for simple filtering based on allowing and blocking conditions. In order to have an event pass the filter, all allowing conditions must be successfully tested while none of the blocking conditions may apply.

Instead of creating a HubConfiguration<T> instance directly, the builder HubConfigurationBuilder<T> can also be used to fluently define a hub configuration and finally calling the Build() method to create a related HubConfiguration<T> instance.

Example

The example app EventRouter.SampleApp defines an event MessageEvent containing a printable Message, a router ConsoleRouter which prints forwarded events on the console, and utilizes a Hub configured to forward all events whose messages start with the text Important.

Known Issues

  • After calling ReconfigureAsync(null, ?) the previously configured queue capacity is still in order.

License

This library is licensed under the MIT license.

Event Routing

The goal of this library is to provide a generic one-way event routing mechanism for any kind of events.

Principles

The main component of this library is the Hub<T> class which implements IHub<T> and handles routing of events via configured routers.

The type of routed events is specified as the generic type parameter T to the class Hub<T> and must implement IRoutable.

The routers forwarding events of type IRoutable themselves must implement IRouter<T> with T being the type of events.

Routers can be assigned to a hub by calling a hub's ReconfigureAsync method handing in an instance of HubConfiguration<T> which contains references to the router instances.

A configuration can also specify preprocessors implementing IRoutablePreprocessor<T>. Preprocessors are automatically invoked for each single forwarded event by the hub right before handing the event over to the configured routers allowing for filtering or replacing of events depending on the preprocessors' logic. Any preprocessor may decide via the OnEnqueueing property whether the preprocessing needs to be done immediately while enqueueing (in a blocking fashion) or asynchronously right before forwarding an event to the configured routers.

A built-in preprocessor is FilterPreprocessor which allows for simple filtering based on allowing and blocking conditions. In order to have an event pass the filter, all allowing conditions must be successfully tested while none of the blocking conditions may apply.

Instead of creating a HubConfiguration<T> instance directly, the builder HubConfigurationBuilder<T> can also be used to fluently define a hub configuration and finally calling the Build() method to create a related HubConfiguration<T> instance.

Example

The example app EventRouter.SampleApp defines an event MessageEvent containing a printable Message, a router ConsoleRouter which prints forwarded events on the console, and utilizes a Hub configured to forward all events whose messages start with the text Important.

Known Issues

  • After calling ReconfigureAsync(null, ?) the previously configured queue capacity is still in order.

License

This library is licensed under the MIT license.

  • .NETStandard 2.0

    • No dependencies.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on EventRouter:

Package Downloads
Logfile
A logging library for structured log events with fluent syntax.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
1.0.2 636 1/3/2020
1.0.1 405 6/26/2019
1.0.0 397 4/9/2019