Event Bus for unity with UniRx

Bus.cs

// Create by: Nam kazt
// Email: [email protected]
// Event Bus for unity with UniRx


/* How to use:
 * 
    // 1, NormalEventCall
    //------------------------------------------------------
    // create test passing data
    var passingData = new object[] { "aaaa", 111 };
    // register event for current object ( any ) with "test" event and data
    Bus.Register(this, "test", (obj, data) => {
        Debug.Log("Listened: NormalEventCall");
        // unregister after finish call or if you wish leave it there for other call
        Bus.Unregister(this);
    });
    // call event with data
    Bus.Call("test", passingData);
 

    // 2, DelayEventCall
    //------------------------------------------------------
    var passingData = new object[] { "aaaa", 111 };
    // register event for current object ( any ) with "test" event and data
    Bus.Register(this, "test", (obj, data) => {
        Debug.Log("Listened: DelayEventCall");
        // unregister after finish call or if you wish leave it there for other call
        Bus.Unregister(this);
    });
    // call event after 2 second
    Bus.Call("test", 2000, passingData);


    // 3, Interval
    //-------------------------------------------------------
    // create new interval
    int index = 0;
    var interval = Bus.Interval(1000, () => {
        index++;
        Debug.Log("Call : " + index.ToString() + " - time: " + DateTimeOffset.UtcNow.ToUnixTimeSeconds().ToString());
    });

    // clear interval
    Bus.ClearInterval(interval)

    // clear all interval
    Bus.ClearAllInterval();


    // 4, Delay call method
    //-------------------------------------------------------
    Bus.Call(2000, () => {
        // your code will be call after 2 seconds
    });

 */

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using UniRx;
using UnityEngine;

namespace NKBus
{
    public class Bus
    {
        private static object s_stationLock = new object();
        private static object s_intervalLock = new object();
        private static Dictionary<string, List<Passenger>> s_station = new Dictionary<string, List<Passenger>>();
        private static List<IDisposable> s_intervals = new List<IDisposable>();

        public static void Register(object passenger, string eventId, Action<object, object> handler)
        {
            Register(passenger, eventId, handler, Scheduler.MainThread);
        }

        public static void Register(object passenger, string eventId, Action<object, object> handler, IScheduler runOn)
        {
            // create new slot for this bus
            var newPassenger = new Passenger
            {
                id = passenger.GetType().FullName,
                busId = eventId
            };
            newPassenger.disposable = newPassenger.obserable
                .ObserveOn(runOn)
                .Subscribe(obj => handler(passenger, obj));

            lock (s_stationLock)
            {
                // check if we already add this bus
                if (s_station.ContainsKey(eventId))
                {
                    var passengers = s_station[eventId];
                    var shouldAdd = true;
                    foreach (var op in passengers)
                    {
                        // there is no glich on matrix that 2 version of passenger on bus
                        // at same time
                        if (op.id == newPassenger.id)
                        {
                            shouldAdd = false;
                            break;
                        }
                    }
                    if (shouldAdd)
                    {
                        passengers.Add(newPassenger);
                    }
                }
                else
                {
                    s_station[eventId] = new List<Passenger>() { newPassenger };
                }
            }
        }

        public static void Unregister(string eventId)
        {
            lock (s_stationLock)
            {
                if (s_station.ContainsKey(eventId))
                {
                    var passengers = s_station[eventId];
                    passengers.ForEach(p => p.disposable?.Dispose());
                    passengers.Clear();
                    s_station.Remove(eventId);
                }
                else
                {
                    Debug.LogWarning("[Event Bus] try to unregister event id [" + eventId + "] but not found");
                }
            }
        }

        public static void Unregister(object passenger)
        {
            lock (s_stationLock)
            {
                foreach (var eventId in s_station.Keys)
                {
                    var passengers = s_station[eventId];
                    foreach (var p in passengers)
                    {
                        if (p.id == passenger.GetType().FullName)
                        {
                            p.disposable?.Dispose();
                            passengers.Remove(p);
                            break;
                        }
                    }
                    if (passengers.Count == 0)
                    {
                        s_station.Remove(eventId);
                        break;
                    }
                }
            }
        }

        public static void UnregisterAll()
        {
            lock(s_stationLock)
            {
                foreach (var eventId in s_station.Keys)
                {
                    var passengers = s_station[eventId];
                    foreach (var p in passengers)
                    {
                        p.disposable?.Dispose();
                    }
                    passengers.Clear();
                }
                s_station.Clear();
            }
        }

        public static bool Call(string eventId, object data = null)
        {
            lock (s_stationLock)
            {
                if (s_station.ContainsKey(eventId))
                {
                    var passengers = s_station[eventId];
                    passengers.ForEach(p => p.subject.OnNext(data));
                    return true;
                }
                else
                {
                    Debug.LogWarning("[Event Bus] try to call event id [" + eventId + "] but it's not register in anywhere.");
                }
            }
            return false;
        }

        public static void Call(string eventId, long delay, object data = null)
        {
            Call(delay, () => {
                Call(eventId, data);
            });
        }

        public static void Call(long delay, Action callback)
        {
            // create timer dispose after finish call
            var timer = Observable.Create<long>(o => {
                var d = Observable.Timer(new TimeSpan(delay * TimeSpan.TicksPerMillisecond)).Subscribe(o);
                return Disposable.Create(() => {
                    d.Dispose();
                });
            });
            timer.Subscribe(ticks => callback.Invoke());
        }

        public static IDisposable Interval(long ticks, Action callback)
        {
            var d = Observable.Interval(new TimeSpan(ticks * TimeSpan.TicksPerMillisecond)).Subscribe(v => callback.Invoke());
            lock (s_intervalLock)
            {
                s_intervals.Add(d);
            }
            return d;
        }

        public static void ClearInterval(IDisposable d)
        {
            lock (s_intervalLock)
            {
                s_intervals.Remove(d);
            }
            d.Dispose();
        }

        public static void ClearAllInterval()
        {
            lock (s_intervalLock)
            {
                foreach (var d in s_intervals)
                {
                    d.Dispose();
                }
                s_intervals.Clear();
            }
        }


        class Passenger {
            internal Subject<object> subject = new Subject<object>();
            internal IDisposable disposable = null;
            internal IObservable<object> obserable { get { return subject; } }
            internal string busId;
            internal string id;
        }
    }

}

EventBus.cs

using System.Collections;
using System.Collections.Generic;
using NUnit.Framework;
using UnityEngine;
using UnityEngine.TestTools;
using Nkit.Core.Event;
using System;

namespace Tests
{
    public class EventBus
    {
        // A Test behaves as an ordinary method
        [UnityTest]
        public IEnumerator NormalEventCall()
        {
            var passingData = new object[] { "aaaa", 111 };
            Bus.Register(this, "test", (obj, data) => {
                Assert.AreEqual(obj, this);
                Assert.AreEqual(data, passingData);
                Debug.Log("Listened: NormalEventCall");
                Bus.Unregister(this);
                Debug.Log("Unregister: NormalEventCall");
            });
            Debug.Log("Registered: NormalEventCall");
            var callable = Bus.Call("test", passingData);
            Debug.Log("Call: NormalEventCall");
            Assert.IsTrue(callable);
            yield return null;
        }

        [UnityTest]
        public IEnumerator DelayEventCall()
        {
            // Use the Assert class to test conditions
            var passingData = new object[] { "aaaa", 111 };
            Bus.Register(this, "test", (obj, data) => {
                Assert.AreEqual(obj, this);
                Assert.AreEqual(data, passingData);
                Debug.Log("Listened: DelayEventCall - time: " + DateTimeOffset.UtcNow.ToUnixTimeSeconds().ToString());
                Bus.Unregister(this);
                Debug.Log("Unregister: DelayEventCall");
            });
            Debug.Log("Registered: DelayEventCall");
            Bus.Call("test", 2000, passingData);
            Debug.Log("Call: DelayEventCall after 2 seconds : " + DateTimeOffset.UtcNow.ToUnixTimeSeconds().ToString());
            yield return new WaitForSeconds(2.1f);
        }

        [UnityTest]
        public IEnumerator Interval()
        {
            int index = 0;
            Bus.Interval(1000, () => {
                index++;
                Debug.Log("Call : " + index.ToString() + " - time: " + DateTimeOffset.UtcNow.ToUnixTimeSeconds().ToString());
                if (index >= 3)
                {
                    Bus.ClearAllInterval();
                    Debug.Log("ClearAllInterval : " + index.ToString());
                }
            });
            Debug.Log("Registered : Interval");
            yield return new WaitForSeconds(3.1f);
        }
    }
}