Mercury Messaging
Documentation for the Mercury Messaging Framework
InvocationComparison Class Reference
Inheritance diagram for InvocationComparison:
MercuryMessaging.MmBaseResponder ICustomMessageTarget MercuryMessaging.MmResponder MercuryMessaging.IMmResponder

Public Types

enum  TestingMode {
  Control = 0, Mercury, SendMessage, Event,
  Execute
}
 Various testing modes supported by the invocation comparison system More...
 

Public Member Functions

delegate void EventActionTest ()
 Event delegate for event test. More...
 
override void Start ()
 Start this instance. More...
 
override void Update ()
 Press Space to run tests. More...
 
void TimingTest ()
 Run through all tests More...
 
void TimingFunction (TestingMode state)
 Timing Function. More...
 
void TestFunction ()
 Timing test of standard function invocation in Unity. More...
 
void TestMercury ()
 Mercury timing test. More...
 
void TestSendMessage ()
 Unity send message timing test. More...
 
void TestEvent ()
 Unity event timing test. More...
 
void TestExecute ()
 Unity execute timing test. More...
 
void SimpleFunction ()
 Empty Function to use for function invocation. More...
 
override void MmInvoke (MmMessageType msgType, MmMessage message)
 Overrides the base MmInvoke Here we just stop the stopwatch. But we could throw in a switch (to represent normal usage) too. More...
 
- Public Member Functions inherited from MercuryMessaging.MmBaseResponder
virtual void SetActive (bool active)
 Handle MmMethod: SetActive More...
 
virtual void Initialize ()
 Handle MmMethod: Initialize Initialize allows you to provide additional initialization logic in-between calls to Monobehavior provided Awake() and Start() calls. More...
 
virtual void Refresh (List< MmTransform > transformList)
 Handle MmMethod: Refresh More...
 
override MmRelayNode GetRelayNode ()
 Implementation of IMmResponder's GetRelayNode. More...
 
- Public Member Functions inherited from MercuryMessaging.MmResponder
virtual void Awake ()
 Awake: Invokes MmOnAwakeComplete More...
 
virtual void MmOnAwakeComplete ()
 Post Awake callback used between objects implementing this interface. This allows for initialization steps that must occur before one instance's Awake and its Start. More...
 
virtual void MmOnStartComplete ()
 Post Start callback used between objects implementing this interface This allows for initialization steps that must occur before one instance's Start and its first Update. More...
 
virtual void MmRegisterAwakeCompleteCallback (IMmCallback callback)
 It is possible that certain handles are not going to be in-place when registration of the OnAwakeComplete callback is invoked. The is especially true in scenarios where MmRelayNodes are networked. This allows for a deferred registration, eliminating most instances where the Awake callback invocations fail. More...
 
virtual void MmRegisterStartCompleteCallback (IMmCallback callback)
 It is possible that certain handles are not going to be in-place when registration of the OnStartComplete callback is invoked. The is especially true in scenarios where MmRelayNodes are networked. This allows for a deferred registration, eliminating most instances where the Start callback invocations fail. More...
 

Public Attributes

int Repetitions = 1000
 Number of repetitions for the test. More...
 
System.Diagnostics.Stopwatch stopWatch
 The stop watch. More...
 
System.Diagnostics.Stopwatch totalWatch
 
bool simpleLock = false
 Simple lock to use in some tests. More...
 
StringBuilder Results
 

Events

EventActionTest OnEventTest
 Occurs when on event test. More...
 

Additional Inherited Members

- Protected Member Functions inherited from MercuryMessaging.MmBaseResponder
virtual void Switch (string iName)
 Handle MmMethod: Switch More...
 
virtual void Complete (bool active)
 Handle MmMethod: Switch More...
 
virtual void ApplyTaskInfo (IMmSerializable serializableValue)
 Handle MmMethod: TaskInfo Given a IMmSerializable, extract TaskInfo. More...
 
virtual void ReceivedMessage (MmMessage message)
 Handle MmMethod: Base MmMessage. Override this to handle base Mercury Messages. More...
 
virtual void ReceivedMessage (MmMessageBool message)
 Handle MmMethod: MessageBool. Override this to handle Mercury's bool messages. More...
 
virtual void ReceivedMessage (MmMessageByteArray message)
 Handle MmMethod: MessageByteArray. Override this to handle Mercury's byte array messages. More...
 
virtual void ReceivedMessage (MmMessageFloat message)
 Handle MmMethod: MessageFloat. Override this to handle Mercury's float messages. More...
 
virtual void ReceivedMessage (MmMessageInt message)
 Handle MmMethod: MessageInt. Override this to handle Mercury's int messages. More...
 
virtual void ReceivedMessage (MmMessageSerializable message)
 Handle MmMethod: MessageSerializable. Override this to handle Mercury's serializable messages. More...
 
virtual void ReceivedMessage (MmMessageString message)
 Handle MmMethod: MessageString Override this to handle Mercury's string messages. More...
 
virtual void ReceivedMessage (MmMessageTransform message)
 Handle MmMethod: MessageTransform Override this to handle Mercury's transform messages. More...
 
virtual void ReceivedMessage (MmMessageTransformList message)
 Handle MmMethod: MessageTransformList Override this to handle Mercury's transform list messages. More...
 
virtual void ReceivedMessage (MmMessageVector3 message)
 Handle MmMethod: MessageVector3 Override this to handle Mercury's Vector3 messages. More...
 
virtual void ReceivedMessage (MmMessageVector4 message)
 Handle MmMethod: MessageVector4 Override this to handle Mercury's Vector4 messages. More...
 
- Properties inherited from MercuryMessaging.MmResponder
GameObject MmGameObject [get]
 Handle to an instance's GameObject. More...
 
MmTag Tag [get, set]
 MmTags allow you to specify filters for execution in Mercury XM graphs. More...
 
bool TagCheckEnabled [get, set]
 Determines whether tag checking is enabled for this IMmResponder More...
 
- Properties inherited from MercuryMessaging.IMmResponder
MmTag Tag [get, set]
 MmTags allow you to specify filters for execution in MercuryMessaging Hierarchies. MmTag More...
 
GameObject MmGameObject [get]
 Handle to an instance's GameObject. More...
 
bool TagCheckEnabled [get, set]
 Determines whether tag checking is enabled for this IMmResponder More...
 

Member Enumeration Documentation

◆ TestingMode

Various testing modes supported by the invocation comparison system

Member Function Documentation

◆ EventActionTest()

delegate void InvocationComparison.EventActionTest ( )

Event delegate for event test.

◆ MmInvoke()

override void InvocationComparison.MmInvoke ( MmMessageType  msgType,
MmMessage  message 
)
virtual

Overrides the base MmInvoke Here we just stop the stopwatch. But we could throw in a switch (to represent normal usage) too.

Reimplemented from MercuryMessaging.MmBaseResponder.

◆ SimpleFunction()

void InvocationComparison.SimpleFunction ( )

Empty Function to use for function invocation.

Implements ICustomMessageTarget.

◆ Start()

override void InvocationComparison.Start ( )
virtual

Start this instance.

Reimplemented from MercuryMessaging.MmResponder.

◆ TestEvent()

void InvocationComparison.TestEvent ( )

Unity event timing test.

◆ TestExecute()

void InvocationComparison.TestExecute ( )

Unity execute timing test.

◆ TestFunction()

void InvocationComparison.TestFunction ( )

Timing test of standard function invocation in Unity.

◆ TestMercury()

void InvocationComparison.TestMercury ( )

Mercury timing test.

◆ TestSendMessage()

void InvocationComparison.TestSendMessage ( )

Unity send message timing test.

◆ TimingFunction()

void InvocationComparison.TimingFunction ( TestingMode  state)

Timing Function.

Parameters
stateState.

◆ TimingTest()

void InvocationComparison.TimingTest ( )

Run through all tests

◆ Update()

override void InvocationComparison.Update ( )
virtual

Press Space to run tests.

Reimplemented from MercuryMessaging.MmResponder.

Member Data Documentation

◆ Repetitions

int InvocationComparison.Repetitions = 1000

Number of repetitions for the test.

◆ simpleLock

bool InvocationComparison.simpleLock = false

Simple lock to use in some tests.

◆ stopWatch

System.Diagnostics.Stopwatch InvocationComparison.stopWatch

The stop watch.

Event Documentation

◆ OnEventTest

EventActionTest InvocationComparison.OnEventTest

Occurs when on event test.


The documentation for this class was generated from the following file: