com.wallstop-studios.dxmessaging 2.0.0-rc06 → 2.0.0-rc07

package/Runtime/Core/InstanceId.cs

@@ -17,14 +17,17 @@
         [JsonInclude]
         [JsonPropertyName("id")]
         [DataMember(Name = "id")]
+        public int Id => _id;
+
+        [JsonIgnore]
         private readonly int _id;
 
 #if UNITY_2017_1_OR_NEWER
         public UnityEngine.Object Object { get; }
 #endif
-        
+
         [JsonConstructor]
-        public InstanceId(int id) : this()
+        public InstanceId(int id)
         {
             _id = id;
 #if UNITY_2017_1_OR_NEWER
@@ -33,7 +36,7 @@
         }
 
 #if UNITY_2017_1_OR_NEWER
-        private InstanceId(UnityEngine.Object @object) : this()
+        private InstanceId(UnityEngine.Object @object)
         {
             _id = @object.GetInstanceID();
             Object = @object;
@@ -62,16 +65,6 @@
         }
 #endif
 
-        [MethodImpl(MethodImplOptions.AggressiveInlining)]
-        public int CompareTo(object rhs)
-        {
-            if (rhs is InstanceId other)
-            {
-                return CompareTo(other);
-            }
-            return -1;
-        }
-
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         public bool Equals(InstanceId other)
         {
@@ -110,7 +103,31 @@
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         public static bool operator !=(InstanceId lhs, InstanceId rhs)
         {
-            return !(lhs == rhs);
+            return !lhs.Equals(rhs);
+        }
+
+        [MethodImpl(MethodImplOptions.AggressiveInlining)]
+        public static bool operator <(InstanceId lhs, InstanceId rhs)
+        {
+            return lhs.CompareTo(rhs) < 0;
+        }
+
+        [MethodImpl(MethodImplOptions.AggressiveInlining)]
+        public static bool operator <=(InstanceId lhs, InstanceId rhs)
+        {
+            return lhs.CompareTo(rhs) <= 0;
+        }
+
+        [MethodImpl(MethodImplOptions.AggressiveInlining)]
+        public static bool operator >(InstanceId lhs, InstanceId rhs)
+        {
+            return lhs.CompareTo(rhs) > 0;
+        }
+
+        [MethodImpl(MethodImplOptions.AggressiveInlining)]
+        public static bool operator >=(InstanceId lhs, InstanceId rhs)
+        {
+            return lhs.CompareTo(rhs) >= 0;
         }
 
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
@@ -118,5 +135,15 @@
         {
             return _id.CompareTo(other._id);
         }
+
+        [MethodImpl(MethodImplOptions.AggressiveInlining)]
+        public int CompareTo(object rhs)
+        {
+            if (rhs is InstanceId other)
+            {
+                return CompareTo(other);
+            }
+            return -1;
+        }
     }
 }

package/Runtime/Core/MessageBus/IMessageBus.cs

@@ -1,7 +1,7 @@
 namespace DxMessaging.Core.MessageBus
 {
-    using Core;
     using System;
+    using Core;
     using Messages;
 
     /// <summary>
@@ -15,7 +15,8 @@
         /// <typeparam name="TMessage">Specific type of message.</typeparam>
         /// <param name="message">Message to consider.</param>
         /// <returns>True if the message should be processed, false if it should be skipped.</returns>
-        public delegate bool UntargetedInterceptor<TMessage>(ref TMessage message) where TMessage : IUntargetedMessage;
+        public delegate bool UntargetedInterceptor<TMessage>(ref TMessage message)
+            where TMessage : IUntargetedMessage;
 
         /// <summary>
         /// Given an Targeted message and its target, determines whether or not it should be processed or skipped.
@@ -24,7 +25,11 @@
         /// <param name="target">Target of the message.</param>
         /// <param name="message">Message to consider.</param>
         /// <returns>True if the message should be processed, false if it should be skipped.</returns>
-        public delegate bool TargetedInterceptor<TMessage>(ref InstanceId target, ref TMessage message) where TMessage : ITargetedMessage;
+        public delegate bool TargetedInterceptor<TMessage>(
+            ref InstanceId target,
+            ref TMessage message
+        )
+            where TMessage : ITargetedMessage;
 
         /// <summary>
         /// Given an Broadcast message and its source, determines whether or not it should be processed or skipped.
@@ -33,7 +38,11 @@
         /// <param name="source">Source of the message.</param>
         /// <param name="message">Message to consider.</param>
         /// <returns>True if the message should be processed, false if it should be skipped.</returns>
-        public delegate bool BroadcastInterceptor<TMessage>(ref InstanceId source, ref TMessage message) where TMessage : IBroadcastMessage;
+        public delegate bool BroadcastInterceptor<TMessage>(
+            ref InstanceId source,
+            ref TMessage message
+        )
+            where TMessage : IBroadcastMessage;
 
         /// <summary>
         /// The registration log of all messaging registrations for this MessageBus.
@@ -46,7 +55,8 @@
         /// <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>
-        Action RegisterUntargeted<T>(MessageHandler messageHandler) where T : IUntargetedMessage;
+        Action RegisterUntargeted<T>(MessageHandler messageHandler, int priority = 0)
+            where T : IUntargetedMessage;
 
         /// <summary>
         /// Registers the specified MessageHandler to receive TargetedMessages of the specified type for the specified target.
@@ -55,7 +65,12 @@
         /// <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>
-        Action RegisterTargeted<T>(InstanceId target, MessageHandler messageHandler) where T : ITargetedMessage;
+        Action RegisterTargeted<T>(
+            InstanceId target,
+            MessageHandler messageHandler,
+            int priority = 0
+        )
+            where T : ITargetedMessage;
 
         /// <summary>
         /// Registers the specified MessageHandler to receive TargetedMessages of the specified type.
@@ -64,7 +79,8 @@
         /// <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>
-        Action RegisterTargetedWithoutTargeting<T>(MessageHandler messageHandler) where T : ITargetedMessage;
+        Action RegisterTargetedWithoutTargeting<T>(MessageHandler messageHandler, int priority = 0)
+            where T : ITargetedMessage;
 
         /// <summary>
         /// Registers the specified MessageHandler to receive BroadcastMessages of the specified type from the provided source.
@@ -73,7 +89,12 @@
         /// <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>
-        Action RegisterSourcedBroadcast<T>(InstanceId source, MessageHandler messageHandler) where T : IBroadcastMessage;
+        Action RegisterSourcedBroadcast<T>(
+            InstanceId source,
+            MessageHandler messageHandler,
+            int priority = 0
+        )
+            where T : IBroadcastMessage;
 
         /// <summary>
         /// Registers the specified MessageHandler to receive BroadcastMessages of the specified type from ALL sources.
@@ -82,7 +103,11 @@
         /// <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>
-        Action RegisterSourcedBroadcastWithoutSource<T>(MessageHandler messageHandler) where T : IBroadcastMessage;
+        Action RegisterSourcedBroadcastWithoutSource<T>(
+            MessageHandler messageHandler,
+            int priority = 0
+        )
+            where T : IBroadcastMessage;
 
         /// <summary>
         /// Registers the specified MessageHandler to receive ALL messages.
@@ -104,14 +129,18 @@
         /// </note>
         /// <typeparam name="T">Type of message to intercept.</typeparam>
         /// <param name="interceptor">Transformation function to run on messages of the chosen type.</param>
-        /// <param name="priority">Priority of the interceptor to run at.</param>
+        /// <param name="priority">Priority of the interceptor to run at. Handlers run in order of priority from low -> high.</param>
         /// <note>
         ///     The transform function takes:
         ///         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>
-        Action RegisterUntargetedInterceptor<T>(UntargetedInterceptor<T> interceptor, int priority = 0) where T : IUntargetedMessage;
+        Action RegisterUntargetedInterceptor<T>(
+            UntargetedInterceptor<T> interceptor,
+            int priority = 0
+        )
+            where T : IUntargetedMessage;
 
         /// <summary>
         /// Registers the specified MessageHandler and transformer function as an interceptor for Messages of type T.
@@ -125,15 +154,15 @@
         /// </note>
         /// <typeparam name="T">Type of message to intercept.</typeparam>
         /// <param name="interceptor">Transformation function to run on messages of the chosen type.</param>
-        /// <param name="priority">Priority of the interceptor to run at.</param>
+        /// <param name="priority">Priority of the interceptor to run at. Handlers run in order of priority from low -> high.</param>
         /// <note>
         ///     The transform function takes:
         ///         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>
-        Action RegisterTargetedInterceptor<T>(TargetedInterceptor<T> interceptor, int priority = 0) where T : ITargetedMessage;
-
+        Action RegisterTargetedInterceptor<T>(TargetedInterceptor<T> interceptor, int priority = 0)
+            where T : ITargetedMessage;
 
         /// <summary>
         /// Registers the specified MessageHandler and transformer function as an interceptor for Messages of type T.
@@ -147,14 +176,18 @@
         /// </note>
         /// <typeparam name="T">Type of message to intercept.</typeparam>
         /// <param name="interceptor">Transformation function to run on messages of the chosen type.</param>
-        /// <param name="priority">Priority of the interceptor to run at.</param>
+        /// <param name="priority">Priority of the interceptor to run at. Handlers run in order of priority from low -> high.</param>
         /// <note>
         ///     The transform function takes:
         ///         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>
-        Action RegisterBroadcastInterceptor<T>(BroadcastInterceptor<T> interceptor, int priority = 0) where T : IBroadcastMessage;
+        Action RegisterBroadcastInterceptor<T>(
+            BroadcastInterceptor<T> interceptor,
+            int priority = 0
+        )
+            where T : IBroadcastMessage;
 
         /// <summary>
         /// Registers the provided MessageHandler to post process Untargeted messages of the given type.
@@ -162,8 +195,10 @@
         /// </summary>
         /// <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>
-        Action RegisterUntargetedPostProcessor<T>(MessageHandler messageHandler) where T : IUntargetedMessage;
+        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.
@@ -172,8 +207,14 @@
         /// <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="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>
-        Action RegisterTargetedPostProcessor<T>(InstanceId target, MessageHandler messageHandler) where T: ITargetedMessage;
+        Action RegisterTargetedPostProcessor<T>(
+            InstanceId target,
+            MessageHandler messageHandler,
+            int priority = 0
+        )
+            where T : ITargetedMessage;
 
         /// <summary>
         /// Registers the provided MessageHandler to post process Targeted messages of the given type for all targets.
@@ -181,8 +222,13 @@
         /// </summary>
         /// <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>
-        Action RegisterTargetedWithoutTargetingPostProcessor<T>(MessageHandler messageHandler) where T : ITargetedMessage;
+        Action RegisterTargetedWithoutTargetingPostProcessor<T>(
+            MessageHandler messageHandler,
+            int priority = 0
+        )
+            where T : ITargetedMessage;
 
         /// <summary>
         /// Registers the provided MessageHandler to post process Targeted messages of the given type.
@@ -191,8 +237,14 @@
         /// <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="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>
-        Action RegisterBroadcastPostProcessor<T>(InstanceId source, MessageHandler messageHandler) where T : IBroadcastMessage;
+        Action RegisterBroadcastPostProcessor<T>(
+            InstanceId source,
+            MessageHandler messageHandler,
+            int priority = 0
+        )
+            where T : IBroadcastMessage;
 
         /// <summary>
         /// Registers the provided MessageHandler to post process Targeted messages of the given type for all sources.
@@ -200,8 +252,13 @@
         /// </summary>
         /// <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>
-        Action RegisterBroadcastWithoutSourcePostProcessor<T>(MessageHandler messageHandler) where T : IBroadcastMessage;
+        Action RegisterBroadcastWithoutSourcePostProcessor<T>(
+            MessageHandler messageHandler,
+            int priority = 0
+        )
+            where T : IBroadcastMessage;
 
         /// <summary>
         /// Broadcasts an Untargeted message to all listeners registered to this bus.
@@ -214,7 +271,8 @@
         /// </summary>
         /// <param name="typedMessage">Message to broadcast.</param>
 
-        void UntargetedBroadcast<TMessage>(ref TMessage typedMessage) where TMessage : IUntargetedMessage;
+        void UntargetedBroadcast<TMessage>(ref TMessage typedMessage)
+            where TMessage : IUntargetedMessage;
 
         /// <summary>
         /// Broadcasts a TargetedMessage to all listeners registered to this bus.
@@ -229,7 +287,8 @@
         /// <param name="target">Target to send the message to.</param>
         /// <param name="typedMessage">Message to broadcast.</param>
 
-        void TargetedBroadcast<TMessage>(ref InstanceId target, ref TMessage typedMessage) where TMessage : ITargetedMessage;
+        void TargetedBroadcast<TMessage>(ref InstanceId target, ref TMessage typedMessage)
+            where TMessage : ITargetedMessage;
 
         /// <summary>
         /// Broadcasts a BroadcastMessage to all listeners registered to this bus.
@@ -244,6 +303,7 @@
         /// <param name="source">Source of the message.</param>
         /// <param name="typedMessage">Message to broadcast.</param>
 
-        void SourcedBroadcast<TMessage>(ref InstanceId source, ref TMessage typedMessage) where TMessage : IBroadcastMessage;
+        void SourcedBroadcast<TMessage>(ref InstanceId source, ref TMessage typedMessage)
+            where TMessage : IBroadcastMessage;
     }
 }