com.wallstop-studios.dxmessaging 1.0.2 → 1.0.3

package/README.md

@@ -10,16 +10,19 @@ Game engine agnostic robust, synchronous pub/sub C# messaging solution, mostly g
     - Scope(s): `com.wallstop-studios.dxmessaging` *and* `com.wallstop-studios.unity-helpers`
 4. Resolve the latest `DxMessaging`
 
+# 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.
+
 # Benchmarks
 DxMessaging is currently a bit slower (2-4x) than Unity's built in messaging solution (when running in Unity). [Source](./Tests/Runtime/Core/PerformanceTests.cs).
 | Message Tech | Operations / Second |
 | ------------ | ------------------- |
-| Unity | 1,955,744 |
-| DxMessaging (GameObject) - Normal | 596,409 |
-| DxMessaging (Component) - Normal | 602,120 |
-| DxMessaging (GameObject) - No-Copy | 583,824 |
-| DxMessaging (Component) - No-Copy | 611,504 |
-| DxMessaging (Untargeted) - No-Copy | 1,044,795 |
+| Unity | 1,939,366 |
+| DxMessaging (GameObject) - Normal | 645,241 |
+| DxMessaging (Component) - Normal | 649,222 |
+| DxMessaging (GameObject) - No-Copy | 630,259 |
+| DxMessaging (Component) - No-Copy | 663,757 |
+| DxMessaging (Untargeted) - No-Copy | 1,093,308 
 
 # Functionality
 While not as fast, DxMessaging offers *additional functionality* as compared to Unity's messaging solution.
@@ -55,6 +58,17 @@ Receivers can subscribe to any number of message types.
 
 For Unity, we have an easy-to-integrate [MessageAwareComponent](./Runtime/Unity/MessageAwareComponent.cs) - simply extend any component you want off of this base class. This will handle message registration lifetimes automatically for you. 
 If you have your own base classes or aren't using Unity, then you'll need to add lifetimes yourself. Please use the MessageAwareComponent as reference.
+
+### Implementation Notes (Unity)
+Please note, if you want to receive messages and inherit off of the `MessageAwareComponent`, the component implements several Unity-specific methods to manage lifetimes. Specifically,
+* `protected virtual void Awake()`
+* `protected virtual void OnEnable()`
+* `protected virtual void OnDisable()`
+* `protected virtual void OnDestroy()`
+* `protected virtual void OnApplicationQuit()`
+
+If you wish to use any of these methods in components that inherit from `MessageAwareComponent`, please make sure to have the overrides call the base methods, otherwise messaging *may break* or not work as expected.
+
 ## Integration
 See the [tests](./Tests/Runtime/Scripts/) directory for examples about how to integrate with the MessageAwareComponent. But, for some starters:
 ```csharp

package/Runtime/Core/MessageBus/MessageBus.cs

@@ -229,7 +229,6 @@
                 }
             };
         }
-
         
         public void UntypedUntargetedBroadcast(IUntargetedMessage typedMessage)
         {
@@ -250,11 +249,10 @@
             Action<IUntargetedMessage> broadcast = (Action<IUntargetedMessage>)untargetedMethod;
             broadcast.Invoke(typedMessage);
         }
-
         
         public void UntargetedBroadcast<TMessage>(ref TMessage typedMessage) where TMessage : IUntargetedMessage
         {
-            Type type = typedMessage.MessageType;
+            Type type = typeof(TMessage);
             if (!RunUntargetedInterceptors(type, ref typedMessage))
             {
                 return;
@@ -310,11 +308,10 @@
             Action<InstanceId, ITargetedMessage> broadcast = (Action<InstanceId, ITargetedMessage>)targetedMethod;
             broadcast.Invoke(target, typedMessage);
         }
-
         
         public void TargetedBroadcast<TMessage>(ref InstanceId target, ref TMessage typedMessage) where TMessage : ITargetedMessage
         {
-            Type type = typedMessage.MessageType;
+            Type type = typeof(TMessage);
             if (!RunTargetedInterceptors(type, ref typedMessage, ref target))
             {
                 return;
@@ -411,7 +408,7 @@
         
         public void SourcedBroadcast<TMessage>(ref InstanceId source, ref TMessage typedMessage) where TMessage : IBroadcastMessage
         {
-            Type type = typedMessage.MessageType;
+            Type type = typeof(TMessage);
             if (!RunBroadcastInterceptors(type, ref typedMessage, ref source))
             {
                 return;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "com.wallstop-studios.dxmessaging",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "displayName": "DxMessaging",
   "description": "Synchronous Event Bus for Unity",
   "unity": "2021.1",