A type safe event manager library for .NET. Due the use of generic, this event manager doesn't suffer for boxing and unboxing of value types nor for casting errors of the consumers. Additionaly, closures of delegates can be stored apart in order to reuse the delegate and reduce allocations. Finally, it has support for weak-refence listeners.
The following example show some of the functions of the event manager:
public static class Player
{
private static EventManager<IPlayerEvents> eventManager = new EventManager<IPlayerEvents>();
public static void Main()
{
eventManager.Subscribe<PlayerHurtEvent>("Ouch", OnPlayerHurt);
eventManager.Subscribe<PlayerPickedUpItemEvent>(OnPlayerPickedUpItem);
eventManager.Subscribe<PlayerPickedUpItemEvent>(("Excalibur", "Mimic"), OnPlayerPickedUpItem2);
eventManager.Raise(new PlayerPickedUpItemEvent("Excalibur"));
eventManager.SubscribeOnce<PlayerPickedUpItemEvent>(OnPlayerPickedUpItemOnce);
eventManager.Raise(new PlayerPickedUpItemEvent("Pencil"));
eventManager.Raise(new PlayerPickedUpItemEvent("Mimic"));
eventManager.Unsubscribe<PlayerPickedUpItemEvent>(OnPlayerPickedUpItem2);
eventManager.Raise(new PlayerPickedUpItemEvent("Mimic"));
}
private static void OnPlayerHurt(string closure)
=> Console.WriteLine(closure);
private static void OnPlayerPickedUpItem(PlayerPickedUpItemEvent @event)
=> Console.WriteLine($"Picked {@event.Item}");
private static void OnPlayerPickedUpItem2((string, string) closure, PlayerPickedUpItemEvent @event)
{
if (@event.Item == closure.Item1)
Console.WriteLine("Player picked up legendary sword!");
else if (@event.Item == closure.Item2)
{
Console.WriteLine("Oh no! You picked up a mimic!");
eventManager.Raise(new PlayerHurtEvent());
}
}
private static void OnPlayerPickedUpItemOnce(PlayerPickedUpItemEvent @event)
=> Console.WriteLine($"This was registered to only execute once.");
public interface IPlayerEvents { }
public readonly struct PlayerHurtEvent : IPlayerEvents { }
public readonly struct PlayerPickedUpItemEvent : IPlayerEvents
{
public readonly string Item;
public PlayerPickedUpItemEvent(string item) => Item = item;
}
}/// Type safe event manager where each type represent an event type.
public sealed class EventManager : IDisposable
{
/// Subscribes an action to run when the event `TEvent` is raised.
public void Subscribe<TEvent>(Action<TEvent> callback);
public void Subscribe<TEvent>(Action callback);
public void Unsubscribe<TEvent>(Action<TEvent> callback);
public void Unsubscribe<TEvent>(Action callback);
/// Subscribes an action to run when the event `TEvent` is raised. The `closure` is passed as a parameter to `callback`.
public void Subscribe<TClosure, TEvent>(TClosure closure, Action<TClosure, TEvent> callback);
public void Subscribe<TClosure, TEvent>(TClosure closure, Action<TClosure> callback);
public void Unsubscribe<TClosure, TEvent>(TClosure closure, Action<TClosure, TEvent> callback);
public void Unsubscribe<TClosure, TEvent>(TClosure closure, Action<TClosure> callback);
/// Subscribes an action to run the next time the event `TEvent` is raised.
public void SubscribeOnce<TEvent>(Action<TEvent> callback);
public void SubscribeOnce<TEvent>(Action callback);
public void UnsubscribeOnce<TEvent>(Action<TEvent> callback);
public void UnsubscribeOnce<TEvent>(Action callback);
/// Subscribes an action to run the next time the event `TEvent` is raised. The `closure` is passed as a parameter to `callback`.
public void SubscribeOnce<TClosure, TEvent>(TClosure closure, Action<TClosure, TEvent> callback);
public void SubscribeOnce<TClosure, TEvent>(TClosure closure, Action<TClosure> callback);
public void UnsubscribeOnce<TClosure, TEvent>(TClosure closure, Action<TClosure, TEvent> callback);
public void UnsubscribeOnce<TClosure, TEvent>(TClosure closure, Action<TClosure> callback);
/// Subscribes an action to run when the event `TEvent` is raised.
/// A weak reference to handle is stored. If the reference gets garbage collected, the listener is automatically removed.
public void WeakSubscribe<THandle, TEvent>(THandle handle, Action<TEvent> callback, bool trackResurrection);
public void WeakSubscribe<THandle, TEvent>(THandle handle, Action callback, bool trackResurrection);
public void WeakSubscribe<THandle, TEvent>(THandle handle, Action<THandle, TEvent> callback, bool trackResurrection);
public void WeakSubscribe<THandle, TEvent>(THandle handle, Action<THandle> callback, bool trackResurrection);
public void WeakUnsubscribe<THandle, TEvent>(THandle handle, Action<TEvent> callback, bool trackResurrection);
public void WeakUnsubscribe<THandle, TEvent>(THandle handle, Action callback, bool trackResurrection);
public void WeakUnsubscribe<THandle, TEvent>(THandle handle, Action<THandle, TEvent> callback, bool trackResurrection);
public void WeakUnsubscribe<THandle, TEvent>(THandle handle, Action<THandle> callback, bool trackResurrection);
/// Subscribes an action to run when the event `TEvent` is raised. The `closure` is passed as a parameter to `callback`.
/// A weak reference to handle is stored. If the reference gets garbage collected, the listener is automatically removed.
public void WeakSubscribe<THandle, TClosure, TEvent>(THandle handle, TClosure closure, Action<TClosure, TEvent> callback, bool trackResurrection);
public void WeakSubscribe<THandle, TClosure, TEvent>(THandle handle, TClosure closure, Action<TClosure> callback, bool trackResurrection);
public void WeakSubscribe<THandle, TClosure, TEvent>(THandle handle, TClosure closure, Action<THandle, TClosure, TEvent> callback, bool trackResurrection);
public void WeakSubscribe<THandle, TClosure, TEvent>(THandle handle, TClosure closure, Action<THandle, TClosure> callback, bool trackResurrection);
public void WeakUnsubscribe<THandle, TClosure, TEvent>(THandle handle, TClosure closure, Action<TClosure, TEvent> callback, bool trackResurrection);
public void WeakUnsubscribe<THandle, TClosure, TEvent>(THandle handle, TClosure closure, Action<TClosure> callback, bool trackResurrection);
public void WeakUnsubscribe<THandle, TClosure, TEvent>(THandle handle, TClosure closure, Action<THandle, TClosure, TEvent> callback, bool trackResurrection);
public void WeakUnsubscribe<THandle, TClosure, TEvent>(THandle handle, TClosure closure, Action<THandle, TClosure> callback, bool trackResurrection);
/// Subscribes an action to run the next time the event `TEvent` is raised.
public void WeakSubscribeOnce<THandle, TEvent>(THandle handle, Action<TEvent> callback, bool trackResurrection);
public void WeakSubscribeOnce<THandle, TEvent>(THandle handle, Action callback, bool trackResurrection);
public void WeakSubscribeOnce<THandle, TEvent>(THandle handle, Action<THandle, TEvent> callback, bool trackResurrection);
public void WeakSubscribeOnce<THandle, TEvent>(THandle handle, Action<THandle> callback, bool trackResurrection);
public void WeakUnsubscribeOnce<THandle, TEvent>(THandle handle, Action<TEvent> callback, bool trackResurrection);
public void WeakUnsubscribeOnce<THandle, TEvent>(THandle handle, Action callback, bool trackResurrection);
public void WeakUnsubscribeOnce<THandle, TEvent>(THandle handle, Action<THandle, TEvent> callback, bool trackResurrection);
public void WeakUnsubscribeOnce<THandle, TEvent>(THandle handle, Action<THandle> callback, bool trackResurrection);
/// Subscribes an action to run the next time the event `TEvent` is raised. The `closure` is passed as a parameter to `callback`.
public void WeakSubscribeOnce<THandle, TClosure, TEvent>(THandle handle, TClosure closure, Action<TClosure, TEvent> callback, bool trackResurrection);
public void WeakSubscribeOnce<THandle, TClosure, TEvent>(THandle handle, TClosure closure, Action<TClosure> callback, bool trackResurrection);
public void WeakSubscribeOnce<THandle, TClosure, TEvent>(THandle handle, TClosure closure, Action<THandle, TClosure, TEvent> callback, bool trackResurrection);
public void WeakSubscribeOnce<THandle, TClosure, TEvent>(THandle handle, TClosure closure, Action<THandle, TClosure> callback, bool trackResurrection);
public void WeakUnsubscribeOnce<THandle, TClosure, TEvent>(THandle handle, TClosure closure, Action<TClosure, TEvent> callback, bool trackResurrection);
public void WeakUnsubscribeOnce<THandle, TClosure, TEvent>(THandle handle, TClosure closure, Action<TClosure> callback, bool trackResurrection);
public void WeakUnsubscribeOnce<THandle, TClosure, TEvent>(THandle handle, TClosure closure, Action<THandle, TClosure, TEvent> callback, bool trackResurrection);
public void WeakUnsubscribeOnce<THandle, TClosure, TEvent>(THandle handle, TClosure closure, Action<THandle, TClosure> callback, bool trackResurrection);
/// Raise the specified event.
public void Raise<TEvent>(TEvent eventArgument);
/// Dispose the underlying content of this event manager.
public void Dispose();
}Initial Release
- Remove
TEventBasegeneric parameter fromEventManager<TEventBase>. - Become
EventManagerthread-safe. - Increase perfomance in
EventManagersubscribe and unsubscribe methods by replacingDelegate.CombineandDelegate.Removewith pooled arrays of delegates. - Add target frameworks for .Net Standard 2.1 and .Net 5.
- Add the following APIs:
public sealed partial class EventManager : IDisposable
{
/// Subscribes an action to run when the event `TEvent` is raised. The `closure` is passed as a parameter to `callback`.
public void Subscribe<TClosure, TEvent>(TClosure closure, Action<TClosure, TEvent> callback);
public void Subscribe<TClosure, TEvent>(TClosure closure, Action<TClosure> callback);
public void Unsubscribe<TClosure, TEvent>(TClosure closure, Action<TClosure, TEvent> callback);
public void Unsubscribe<TClosure, TEvent>(TClosure closure, Action<TClosure> callback);
/// Subscribes an action to run the next time the event `TEvent` is raised.
public void SubscribeOnce<TEvent>(Action<TEvent> callback);
public void SubscribeOnce<TEvent>(Action callback);
public void UnsubscribeOnce<TEvent>(Action<TEvent> callback);
public void UnsubscribeOnce<TEvent>(Action callback);
/// Subscribes an action to run the next time the event `TEvent` is raised. The `closure` is passed as a parameter to `callback`.
public void SubscribeOnce<TClosure, TEvent>(TClosure closure, Action<TClosure, TEvent> callback);
public void SubscribeOnce<TClosure, TEvent>(TClosure closure, Action<TClosure> callback);
public void UnsubscribeOnce<TClosure, TEvent>(TClosure closure, Action<TClosure, TEvent> callback);
public void UnsubscribeOnce<TClosure, TEvent>(TClosure closure, Action<TClosure> callback);
/// Subscribes an action to run when the event `TEvent` is raised.
/// A weak reference to handle is stored. If the reference gets garbage collected, the listener is automatically removed.
public void WeakSubscribe<THandle, TEvent>(THandle handle, Action<TEvent> callback, bool trackResurrection);
public void WeakSubscribe<THandle, TEvent>(THandle handle, Action callback, bool trackResurrection);
public void WeakUnsubscribe<THandle, TEvent>(THandle handle, Action<TEvent> callback, bool trackResurrection);
public void WeakUnsubscribe<THandle, TEvent>(THandle handle, Action callback, bool trackResurrection);
public void WeakSubscribe<THandle, TEvent>(THandle handle, Action<THandle, TEvent> callback, bool trackResurrection);
public void WeakSubscribe<THandle, TEvent>(THandle handle, Action<THandle> callback, bool trackResurrection);
public void WeakUnsubscribe<THandle, TEvent>(THandle handle, Action<THandle, TEvent> callback, bool trackResurrection);
public void WeakUnsubscribe<THandle, TEvent>(THandle handle, Action<THandle> callback, bool trackResurrection);
/// Subscribes an action to run when the event `TEvent` is raised. The `closure` is passed as a parameter to `callback`.
/// A weak reference to handle is stored. If the reference gets garbage collected, the listener is automatically removed.
public void WeakSubscribe<THandle, TClosure, TEvent>(THandle handle, TClosure closure, Action<TClosure, TEvent> callback, bool trackResurrection);
public void WeakSubscribe<THandle, TClosure, TEvent>(THandle handle, TClosure closure, Action<TClosure> callback, bool trackResurrection);
public void WeakSubscribe<THandle, TClosure, TEvent>(THandle handle, TClosure closure, Action<THandle, TClosure, TEvent> callback, bool trackResurrection);
public void WeakSubscribe<THandle, TClosure, TEvent>(THandle handle, TClosure closure, Action<THandle, TClosure> callback, bool trackResurrection);
public void WeakUnsubscribe<THandle, TClosure, TEvent>(THandle handle, TClosure closure, Action<TClosure, TEvent> callback, bool trackResurrection);
public void WeakUnsubscribe<THandle, TClosure, TEvent>(THandle handle, TClosure closure, Action<TClosure> callback, bool trackResurrection);
public void WeakUnsubscribe<THandle, TClosure, TEvent>(THandle handle, TClosure closure, Action<THandle, TClosure, TEvent> callback, bool trackResurrection);
public void WeakUnsubscribe<THandle, TClosure, TEvent>(THandle handle, TClosure closure, Action<THandle, TClosure> callback, bool trackResurrection);
/// Subscribes an action to run the next time the event `TEvent` is raised.
public void WeakSubscribeOnce<THandle, TEvent>(THandle handle, Action<TEvent> callback, bool trackResurrection);
public void WeakSubscribeOnce<THandle, TEvent>(THandle handle, Action callback, bool trackResurrection);
public void WeakSubscribeOnce<THandle, TEvent>(THandle handle, Action<THandle, TEvent> callback, bool trackResurrection);
public void WeakSubscribeOnce<THandle, TEvent>(THandle handle, Action<THandle> callback, bool trackResurrection);
public void WeakUnsubscribeOnce<THandle, TEvent>(THandle handle, Action<TEvent> callback, bool trackResurrection);
public void WeakUnsubscribeOnce<THandle, TEvent>(THandle handle, Action callback, bool trackResurrection);
public void WeakUnsubscribeOnce<THandle, TEvent>(THandle handle, Action<THandle, TEvent> callback, bool trackResurrection);
public void WeakUnsubscribeOnce<THandle, TEvent>(THandle handle, Action<THandle> callback, bool trackResurrection);
/// Subscribes an action to run the next time the event `TEvent` is raised. The `closure` is passed as a parameter to `callback`.
public void WeakSubscribeOnce<THandle, TClosure, TEvent>(THandle handle, TClosure closure, Action<TClosure, TEvent> callback, bool trackResurrection);
public void WeakSubscribeOnce<THandle, TClosure, TEvent>(THandle handle, TClosure closure, Action<TClosure> callback, bool trackResurrection);
public void WeakSubscribeOnce<THandle, TClosure, TEvent>(THandle handle, TClosure closure, Action<THandle, TClosure, TEvent> callback, bool trackResurrection);
public void WeakSubscribeOnce<THandle, TClosure, TEvent>(THandle handle, TClosure closure, Action<THandle, TClosure> callback, bool trackResurrection);
public void WeakUnsubscribeOnce<THandle, TClosure, TEvent>(THandle handle, TClosure closure, Action<TClosure, TEvent> callback, bool trackResurrection);
public void WeakUnsubscribeOnce<THandle, TClosure, TEvent>(THandle handle, TClosure closure, Action<TClosure> callback, bool trackResurrection);
public void WeakUnsubscribeOnce<THandle, TClosure, TEvent>(THandle handle, TClosure closure, Action<THandle, TClosure, TEvent> callback, bool trackResurrection);
public void WeakUnsubscribeOnce<THandle, TClosure, TEvent>(THandle handle, TClosure closure, Action<THandle, TClosure> callback, bool trackResurrection);
}- Apply nullable analysis on API.
- Fix some null reference error bugs.
- Fix exceptions when raising events.
- Fix memory leaks of weak subscribers.
- Fix documentation.
- Reduce garbage produced when a subscribed delegate throws.
- Become auto-cleaning abortable and incremental.
- Add internal multithreading on
.Dispose()method and auto-cleaning. - Check for math overflow and underflow on debug builds.
- Reduce assembly size.
- Reduce instance of
EventManagersize. - Reduce amount of required allocations.
- Reduce initial cost by using lazily initialization.