com.wallstop-studios.dxmessaging 2.0.0-rc13 → 2.0.0-rc15

package/README.md

@@ -16,6 +16,9 @@ Game engine agnostic robust, synchronous pub/sub C# messaging solution, mostly g
 
 # Installation
 
+## From Releases
+Check out the latest [Releases](https://github.com/wallstop/DxMessaging/releases) to grab the Unity Package and import to your project.
+
 ## To Install as Unity Package
 1. Open Unity Package Manager
 2. (Optional) Enable Pre-release packages to get the latest, cutting-edge builds
@@ -29,23 +32,20 @@ Game engine agnostic robust, synchronous pub/sub C# messaging solution, mostly g
 ## From Source
 Grab a copy of this repo (either `git clone` both [this repo](https://github.com/wallstop/DxMessaging) *and* [Unity Helpers](https://github.com/wallstop/unity-helpers) or [download a zip of the source](https://github.com/wallstop/DxMessaging/archive/refs/heads/master.zip) and [Unity Helper's source](https://github.com/wallstop/unity-helpers/archive/refs/heads/main.zip)) and copy the contents to your project's `Assets` folder.
 
-## From Releases
-Check out the latest [Releases](https://github.com/wallstop/DxMessaging/releases) to grab the Unity Package and import to your project.
-
 # Dependencies
 This project has a dependency on my [`Unity Helpers`](https://github.com/wallstop/unity-helpers) project, which contains the `System.Runtime.CompilerServices.Unsafe.dll`, which is used for some speed hacks in DxMessaging directly. Unity Helpers bundles a few (small) dependencies, including protobuf. If you don't want these dependencies, or if they conflict in some way, you can either include a copy of the `System.Runtime.CompilerServices.Unsafe.dll` yourself without relying on UnityHelpers, or manually download and include the Unity Helpers project and delete anything that conflicts with your project. Or, manually download this project without UnityHelpers. The choice is yours.
 
 # Benchmarks
 DxMessaging is currently a bit slower (2-3x) than Unity's built in messaging solution (when running in Unity). [Source](./Tests/Runtime/Benchmarks/PerformanceTests.cs).
 
-| Message Tech | Operations / Second | Memory Allocated |
-| ------------ | ------------------- | --------------- |
-| Unity | 2,302,247 | 76.83 GB |
-| DxMessaging (GameObject) - Normal | 1,223,941 | 3.52 MB |
-| DxMessaging (Component) - Normal | 1,229,897 | 2.83 MB |
-| DxMessaging (GameObject) - No-Copy | 1,172,148 | 2.83 MB |
-| DxMessaging (Component) - No-Copy | 1,258,505 | 3.03 MB |
-| DxMessaging (Untargeted) - No-Copy | 1,737,476 | 4.2 MB |
+| Message Tech | Operations / Second | Allocations? |
+| ------------ | ------------------- | ------------ | 
+| Unity | 2,287,562 | Yes |
+| DxMessaging (GameObject) - Normal | 1,198,797 | No |
+| DxMessaging (Component) - Normal | 1,198,796 | No |
+| DxMessaging (GameObject) - No-Copy | 1,137,634 | No |
+| DxMessaging (Component) - No-Copy | 1,225,105 | No |
+| DxMessaging (Untargeted) - No-Copy | 1,681,407 | No |
 
 # Functionality
 While not as fast, DxMessaging offers *additional functionality* as compared to Unity's messaging solution.
@@ -64,6 +64,7 @@ While not as fast, DxMessaging offers *additional functionality* as compared to
 | Send a message without boxing its parameters | _ | ✓ |
 | Listen to all messages | _ | ✓ |
 | View a filter-able history of message registrations | N/A | ✓ |
+| "PreUpdate" style handlers | _ | ✓ |
 | "LateUpdate" style handlers | _ | ✓ |
 
 # Concepts

package/Runtime/Core/InstanceId.cs

@@ -23,7 +23,8 @@
         private readonly int _id;
 
 #if UNITY_2017_1_OR_NEWER
-        public UnityEngine.Object Object { get; }
+        // ReSharper disable once InconsistentNaming
+        public readonly UnityEngine.Object Object;
 #endif
 
         [JsonConstructor]
@@ -36,10 +37,10 @@
         }
 
 #if UNITY_2017_1_OR_NEWER
-        private InstanceId(UnityEngine.Object @object)
+        private InstanceId(UnityEngine.Object unityObject)
         {
-            _id = @object.GetInstanceID();
-            Object = @object;
+            _id = unityObject.GetInstanceID();
+            Object = unityObject;
         }
 
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
@@ -88,9 +89,9 @@
 #if UNITY_2017_1_OR_NEWER
             UnityEngine.Object instance = Object;
             string objectName = instance == null ? string.Empty : instance.name;
-            return $"{{\"Id\": {_id}, \"Name\": \"{objectName}\"}}";
+            return new { Id = _id, Name = objectName }.ToString();
 #else
-            return $"{{\"Id\": {_id}}}";
+            return new { Id = _id }.ToString();
 #endif
         }
 

package/Runtime/Core/MessageBus/IMessageBus.cs

@@ -5,10 +5,16 @@
     using Messages;
 
     /// <summary>
-    /// Description of a general purpose message bus that provides both registration, de-registration, and broadcast capabilities.
+    /// Description of a general purpose message bus that provides both registration, deregistration, and broadcast capabilities.
     /// </summary>
     public interface IMessageBus
     {
+        public int RegisteredBroadcast { get; }
+
+        public int RegisteredTargeted { get; }
+
+        public int RegisteredUntargeted { get; }
+
         /// <summary>
         /// Given an Untargeted message, determines whether or not it should be processed or skipped
         /// </summary>
@@ -54,7 +60,7 @@
         /// </summary>
         /// <typeparam name="T">Specific type of UntargetedMessages to register for.</typeparam>
         /// <param name="messageHandler">MessageHandler to register to accept UntargetedMessages of the specified type.</param>
-        /// <returns>The de-registration action. Should be invoked when the handler no longer wants to receive messages.</returns>
+        /// <returns>The deregistration action. Should be invoked when the handler no longer wants to receive messages.</returns>
         Action RegisterUntargeted<T>(MessageHandler messageHandler, int priority = 0)
             where T : IUntargetedMessage;
 
@@ -64,7 +70,7 @@
         /// <typeparam name="T">Specific type of TargetedMessages to register for.</typeparam>
         /// <param name="target">Target of messages to listen for.</param>
         /// <param name="messageHandler">MessageHandler to register the TargetedMessages of the specified type.</param>
-        /// <returns>The de-registration action. Should be invoked when the handler no longer wants to receive the messages.</returns>
+        /// <returns>The deregistration action. Should be invoked when the handler no longer wants to receive the messages.</returns>
         Action RegisterTargeted<T>(
             InstanceId target,
             MessageHandler messageHandler,
@@ -78,7 +84,7 @@
         /// </summary>
         /// <typeparam name="T">Specific type of TargetedMessages to register for.</typeparam>
         /// <param name="messageHandler">MessageHandler to register to accept all TargetedMessages of the specified type.</param>
-        /// <returns>The de-registration action. Should be invoked when the handler no longer wants to receive messages.</returns>
+        /// <returns>The deregistration action. Should be invoked when the handler no longer wants to receive messages.</returns>
         Action RegisterTargetedWithoutTargeting<T>(MessageHandler messageHandler, int priority = 0)
             where T : ITargetedMessage;
 
@@ -88,7 +94,7 @@
         /// <typeparam name="T">Type of the BroadcastMessage to register.</typeparam>
         /// <param name="source">InstanceId of the source for BroadcastMessages to listen to.</param>
         /// <param name="messageHandler">MessageHandler to register to accept BroadcastMessages.</param>
-        /// <returns>The de-registration action. Should be invoked when the handler no longer wants to receive messages.</returns>
+        /// <returns>The deregistration action. Should be invoked when the handler no longer wants to receive messages.</returns>
         Action RegisterSourcedBroadcast<T>(
             InstanceId source,
             MessageHandler messageHandler,
@@ -102,7 +108,7 @@
         /// </summary>
         /// <typeparam name="T">Type of the BroadcastMessage to register.</typeparam>
         /// <param name="messageHandler">MessageHandler to register to accept BroadcastMessages.</param>
-        /// <returns>The de-registration action. Should be invoked when the handler no longer wants to receive messages.</returns>
+        /// <returns>The deregistration action. Should be invoked when the handler no longer wants to receive messages.</returns>
         Action RegisterSourcedBroadcastWithoutSource<T>(
             MessageHandler messageHandler,
             int priority = 0
@@ -114,7 +120,7 @@
         /// It doesn't matter if the message is Targeted or Untargeted, this MessageHandler will be invoked for it.
         /// </summary>
         /// <param name="messageHandler">MessageHandler to register to accept all messages.</param>
-        /// <returns>The de-registration action. Should be invoked when the handler no longer wants to receive messages.</returns>
+        /// <returns>The deregistration action. Should be invoked when the handler no longer wants to receive messages.</returns>
         Action RegisterGlobalAcceptAll(MessageHandler messageHandler);
 
         /// <summary>
@@ -135,7 +141,7 @@
         ///         param1: Current message instance by reference
         ///     And returns: true if message handling should continue, false if message handling should be stopped.
         /// </note>
-        /// <returns>The de-registration action. Should be invoked when the handler no longer wants to intercept messages.</returns>
+        /// <returns>The deregistration action. Should be invoked when the handler no longer wants to intercept messages.</returns>
         Action RegisterUntargetedInterceptor<T>(
             UntargetedInterceptor<T> interceptor,
             int priority = 0
@@ -160,7 +166,7 @@
         ///         param1: Current message instance by reference
         ///     And returns: true if message handling should continue, false if message handling should be stopped.
         /// </note>
-        /// <returns>The de-registration action. Should be invoked when the handler no longer wants to intercept messages.</returns>
+        /// <returns>The deregistration action. Should be invoked when the handler no longer wants to intercept messages.</returns>
         Action RegisterTargetedInterceptor<T>(TargetedInterceptor<T> interceptor, int priority = 0)
             where T : ITargetedMessage;
 
@@ -182,7 +188,7 @@
         ///         param1: Current message instance by reference
         ///     And returns: true if message handling should continue, false if message handling should be stopped.
         /// </note>
-        /// <returns>The de-registration action. Should be invoked when the handler no longer wants to intercept messages.</returns>
+        /// <returns>The deregistration action. Should be invoked when the handler no longer wants to intercept messages.</returns>
         Action RegisterBroadcastInterceptor<T>(
             BroadcastInterceptor<T> interceptor,
             int priority = 0
@@ -190,25 +196,25 @@
             where T : IBroadcastMessage;
 
         /// <summary>
-        /// Registers the provided MessageHandler to post process Untargeted messages of the given type.
+        /// Registers the provided MessageHandler to post-process Untargeted messages of the given type.
         /// (This will run after all handlers run for the provided message).
         /// </summary>
-        /// <typeparam name="T">Type of UntargetedMessage to post process.</typeparam>
-        /// <param name="messageHandler">MessageHandler to post process messages for.</param>
+        /// <typeparam name="T">Type of UntargetedMessage to post-process.</typeparam>
+        /// <param name="messageHandler">MessageHandler to post-process messages for.</param>
         /// <param name="priority">Priority of the interceptor to run at. Handlers run in order of priority from low -> high.</param>
-        /// <returns>The de-registration action. Should be invoked when the handler no longer wants to post process messages.</returns>
+        /// <returns>The deregistration action. Should be invoked when the handler no longer wants to post-process messages.</returns>
         Action RegisterUntargetedPostProcessor<T>(MessageHandler messageHandler, int priority = 0)
             where T : IUntargetedMessage;
 
         /// <summary>
-        /// Registers the provided MessageHandler to post process Targeted messages of the given type.
+        /// Registers the provided MessageHandler to post-process Targeted messages of the given type.
         /// (This will run after all handlers run for the provided message).
         /// </summary>
-        /// <typeparam name="T">Type of TargetedMessage to post process.</typeparam>
+        /// <typeparam name="T">Type of TargetedMessage to post-process.</typeparam>
         /// <param name="target">Target of messages to listen for.</param>
-        /// <param name="messageHandler">MessageHandler to post process messages for.</param>
+        /// <param name="messageHandler">MessageHandler to post-process messages for.</param>
         /// <param name="priority">Priority of the interceptor to run at. Handlers run in order of priority from low -> high.</param>
-        /// <returns>The de-registration action. Should be invoked when the handler no longer wants to post process messages.</returns>
+        /// <returns>The deregistration action. Should be invoked when the handler no longer wants to post-process messages.</returns>
         Action RegisterTargetedPostProcessor<T>(
             InstanceId target,
             MessageHandler messageHandler,
@@ -217,13 +223,13 @@
             where T : ITargetedMessage;
 
         /// <summary>
-        /// Registers the provided MessageHandler to post process Targeted messages of the given type for all targets.
+        /// Registers the provided MessageHandler to post-process Targeted messages of the given type for all targets.
         /// (This will run after all handlers run for the provided message).
         /// </summary>
-        /// <typeparam name="T">Type of TargetedMessage to post process.</typeparam>
-        /// <param name="messageHandler">MessageHandler to post process messages for.</param>
+        /// <typeparam name="T">Type of TargetedMessage to post-process.</typeparam>
+        /// <param name="messageHandler">MessageHandler to post-process messages for.</param>
         /// <param name="priority">Priority of the interceptor to run at. Handlers run in order of priority from low -> high.</param>
-        /// <returns>The de-registration action. Should be invoked when the handler no longer wants to post process messages.</returns>
+        /// <returns>The deregistration action. Should be invoked when the handler no longer wants to post-process messages.</returns>
         Action RegisterTargetedWithoutTargetingPostProcessor<T>(
             MessageHandler messageHandler,
             int priority = 0
@@ -231,14 +237,14 @@
             where T : ITargetedMessage;
 
         /// <summary>
-        /// Registers the provided MessageHandler to post process Targeted messages of the given type.
+        /// Registers the provided MessageHandler to post-process Targeted messages of the given type.
         /// (This will run after all handlers run for the provided message).
         /// </summary>
-        /// <typeparam name="T">Type of TargetedMessage to post process.</typeparam>
+        /// <typeparam name="T">Type of TargetedMessage to post-process.</typeparam>
         /// <param name="source">Source of messages to listen for.</param>
-        /// <param name="messageHandler">MessageHandler to post process messages for.</param>
+        /// <param name="messageHandler">MessageHandler to post-process messages for.</param>
         /// <param name="priority">Priority of the interceptor to run at. Handlers run in order of priority from low -> high.</param>
-        /// <returns>The de-registration action. Should be invoked when the handler no longer wants to post process messages.</returns>
+        /// <returns>The deregistration action. Should be invoked when the handler no longer wants to post-process messages.</returns>
         Action RegisterBroadcastPostProcessor<T>(
             InstanceId source,
             MessageHandler messageHandler,
@@ -247,13 +253,13 @@
             where T : IBroadcastMessage;
 
         /// <summary>
-        /// Registers the provided MessageHandler to post process Targeted messages of the given type for all sources.
+        /// Registers the provided MessageHandler to post-process Targeted messages of the given type for all sources.
         /// (This will run after all handlers run for the provided message).
         /// </summary>
-        /// <typeparam name="T">Type of TargetedMessage to post process.</typeparam>
-        /// <param name="messageHandler">MessageHandler to post process messages for.</param>
+        /// <typeparam name="T">Type of TargetedMessage to post-process.</typeparam>
+        /// <param name="messageHandler">MessageHandler to post-process messages for.</param>
         /// <param name="priority">Priority of the interceptor to run at. Handlers run in order of priority from low -> high.</param>
-        /// <returns>The de-registration action. Should be invoked when the handler no longer wants to post process messages.</returns>
+        /// <returns>The deregistration action. Should be invoked when the handler no longer wants to post-process messages.</returns>
         Action RegisterBroadcastWithoutSourcePostProcessor<T>(
             MessageHandler messageHandler,
             int priority = 0

package/Runtime/Core/MessageBus/MessageBus.cs

@@ -221,11 +221,15 @@
                 );
                 if (!_globalSinks.TryGetValue(messageHandler, out count))
                 {
-                    MessagingDebug.Log(
-                        LogLevel.Error,
-                        "Received over-deregistration of GlobalAcceptAll for MessageHandler {0}. Check to make sure you're not calling (de)registration multiple times.",
-                        messageHandler
-                    );
+                    if (MessagingDebug.enabled)
+                    {
+                        MessagingDebug.Log(
+                            LogLevel.Error,
+                            "Received over-deregistration of GlobalAcceptAll for MessageHandler {0}. Check to make sure you're not calling (de)registration multiple times.",
+                            messageHandler
+                        );
+                    }
+
                     return;
                 }
 
@@ -421,7 +425,7 @@
                         _uniqueInterceptorsAndPriorities.Remove(interceptor);
                     }
                 }
-                else
+                else if (MessagingDebug.enabled)
                 {
                     MessagingDebug.Log(
                         LogLevel.Error,
@@ -441,7 +445,7 @@
                         complete = interceptors.Remove(interceptor);
                     }
 
-                    if (!complete)
+                    if (!complete && MessagingDebug.enabled)
                     {
                         MessagingDebug.Log(
                             LogLevel.Error,
@@ -534,7 +538,7 @@
                 }
             }
 
-            if (!foundAnyHandlers)
+            if (!foundAnyHandlers && MessagingDebug.enabled)
             {
                 MessagingDebug.Log(
                     LogLevel.Info,
@@ -765,7 +769,7 @@
                 }
             }
 
-            if (!foundAnyHandlers)
+            if (!foundAnyHandlers && MessagingDebug.enabled)
             {
                 MessagingDebug.Log(
                     LogLevel.Info,
@@ -1096,7 +1100,7 @@
                 }
             }
 
-            if (!foundAnyHandlers)
+            if (!foundAnyHandlers && MessagingDebug.enabled)
             {
                 MessagingDebug.Log(
                     LogLevel.Info,
@@ -1914,12 +1918,16 @@
                     || !handler.TryGetValue(messageHandler, out count)
                 )
                 {
-                    MessagingDebug.Log(
-                        LogLevel.Error,
-                        "Received over-deregistration of {0} for {1}. Check to make sure you're not calling (de)registration multiple times.",
-                        type,
-                        messageHandler
-                    );
+                    if (MessagingDebug.enabled)
+                    {
+                        MessagingDebug.Log(
+                            LogLevel.Error,
+                            "Received over-deregistration of {0} for {1}. Check to make sure you're not calling (de)registration multiple times.",
+                            type,
+                            messageHandler
+                        );
+                    }
+
                     return;
                 }
 
@@ -1937,7 +1945,7 @@
                         _ = sinks.Remove(type);
                     }
 
-                    if (!complete)
+                    if (!complete && MessagingDebug.enabled)
                     {
                         MessagingDebug.Log(
                             LogLevel.Error,
@@ -2032,12 +2040,16 @@
                     || !handler.TryGetValue(messageHandler, out count)
                 )
                 {
-                    MessagingDebug.Log(
-                        LogLevel.Error,
-                        "Received over-deregistration of {0} for {1}. Check to make sure you're not calling (de)registration multiple times.",
-                        type,
-                        messageHandler
-                    );
+                    if (MessagingDebug.enabled)
+                    {
+                        MessagingDebug.Log(
+                            LogLevel.Error,
+                            "Received over-deregistration of {0} for {1}. Check to make sure you're not calling (de)registration multiple times.",
+                            type,
+                            messageHandler
+                        );
+                    }
+
                     return;
                 }
 
@@ -2059,7 +2071,7 @@
                         _ = sinks.Remove(type);
                     }
 
-                    if (!complete)
+                    if (!complete && MessagingDebug.enabled)
                     {
                         MessagingDebug.Log(
                             LogLevel.Error,
@@ -2106,7 +2118,10 @@
             }
             else
             {
-                messageHandlers.AddRange(handlers);
+                foreach (KeyValuePair<int, SortedList<MessageHandler, int>> handler in handlers)
+                {
+                    messageHandlers.Add(handler);
+                }
             }
             return messageHandlers;
         }
@@ -2162,7 +2177,10 @@
                 }
                 default:
                 {
-                    messageHandlers.AddRange(handlers);
+                    foreach (MessageHandler handler in handlers)
+                    {
+                        messageHandlers.Add(handler);
+                    }
                     break;
                 }
             }