Mercury Messaging
Documentation for the Mercury Messaging Framework
MercuryMessaging.IMmNode Interface Reference

Defines methods required by an MmResponder & utility methods making invocation MmMethods with built-in MmMessages easier. More...

Inheritance diagram for MercuryMessaging.IMmNode:
MercuryMessaging.MmRelayNode MercuryMessaging.AppState.MmRelayAppStateNode MercuryMessaging.MmQuickNode MercuryMessaging.MmRelaySwitchNode

Public Member Functions

void MmInvoke (MmMessageType msgType, MmMessage message)
 Invoke an MmMethod. More...
 
void MmInvoke (MmMethod mmMethod, MmMetadataBlock metadataBlock)
 Invoke an MmMethod with no parameter. More...
 
void MmInvoke (MmMethod mmMethod, int param, MmMetadataBlock metadataBlock)
 Invoke an MmMethod with parameter: int. More...
 
void MmInvoke (MmMethod mmMethod, Vector3 param, MmMetadataBlock metadataBlock)
 Invoke an MmMethod with parameter: Vector3.
More...
 
void MmInvoke (MmMethod mmMethod, Vector4 param, MmMetadataBlock metadataBlock)
 Invoke an MmMethod with parameter: Vector4.
More...
 
void MmInvoke (MmMethod mmMethod, string param, MmMetadataBlock metadataBlock)
 Invoke an MmMethod with parameter: string. More...
 
void MmInvoke (MmMethod mmMethod, float param, MmMetadataBlock metadataBlock)
 Invoke an MmMethod with parameter: float. More...
 
void MmInvoke (MmMethod mmMethod, byte[] param, MmMetadataBlock metadataBlock)
 Invoke an MmMethod with parameter: byte array.
More...
 
void MmInvoke (MmMethod mmMethod, bool param, MmMetadataBlock metadataBlock)
 Invoke an MmMethod with parameter: bool. More...
 
void MmInvoke (MmMethod mmMethod, IMmSerializable param, MmMetadataBlock metadataBlock)
 Invoke an MmMethod with parameter: IMmSerializable. More...
 
void MmInvoke (MmMethod mmMethod, MmTransform param, MmMetadataBlock metadataBlock)
 Invoke an MmMethod with parameter: MmTransform. More...
 
void MmInvoke (MmMethod mmMethod, List< MmTransform > param, MmMetadataBlock metadataBlock)
 Invoke an MmMethod with parameter: List<MmTransform>. More...
 

Detailed Description

Defines methods required by an MmResponder & utility methods making invocation MmMethods with built-in MmMessages easier.

Member Function Documentation

◆ MmInvoke() [1/12]

void MercuryMessaging.IMmNode.MmInvoke ( MmMessageType  msgType,
MmMessage  message 
)

Invoke an MmMethod.

Parameters
msgTypeType of message. This specifies the type of the payload. This is important in networked scenarios, when proper deseriaization into the correct type requires knowing what was used to serialize the object originally.
msgThe message to send. This class builds on UNET's MessageBase so it is Auto [de]serialized by UNET.

Implemented in MercuryMessaging.MmRelayNode, and MercuryMessaging.MmQuickNode.

◆ MmInvoke() [2/12]

void MercuryMessaging.IMmNode.MmInvoke ( MmMethod  mmMethod,
MmMetadataBlock  metadataBlock 
)

Invoke an MmMethod with no parameter.

Parameters
mmMethodMmMethod Identifier - MmMethod
metadataBlockObject defining the routing of MmMessages through MercuryMessaging Hierarchies. MmMetadataBlock

Implemented in MercuryMessaging.MmRelayNode.

◆ MmInvoke() [3/12]

void MercuryMessaging.IMmNode.MmInvoke ( MmMethod  mmMethod,
int  param,
MmMetadataBlock  metadataBlock 
)

Invoke an MmMethod with parameter: int.

Parameters
mmMethodMmMethod Identifier - MmMethod
paramMmMethod parameter: int.
metadataBlockObject defining the routing of MmMessages through MercuryMessaging Hierarchies. MmMetadataBlock

Implemented in MercuryMessaging.MmRelayNode.

◆ MmInvoke() [4/12]

void MercuryMessaging.IMmNode.MmInvoke ( MmMethod  mmMethod,
Vector3  param,
MmMetadataBlock  metadataBlock 
)

Invoke an MmMethod with parameter: Vector3.

Parameters
mmMethodMmMethod Identifier - MmMethod
paramMmMethod parameter: Vector3.
metadataBlockObject defining the routing of MmMessages through MercuryMessaging Hierarchies. MmMetadataBlock

Implemented in MercuryMessaging.MmRelayNode.

◆ MmInvoke() [5/12]

void MercuryMessaging.IMmNode.MmInvoke ( MmMethod  mmMethod,
Vector4  param,
MmMetadataBlock  metadataBlock 
)

Invoke an MmMethod with parameter: Vector4.

Parameters
mmMethodMmMethod Identifier - MmMethod
paramMmMethod parameter: Vector4.
metadataBlockObject defining the routing of MmMessages through MercuryMessaging Hierarchies. MmMetadataBlock

Implemented in MercuryMessaging.MmRelayNode.

◆ MmInvoke() [6/12]

void MercuryMessaging.IMmNode.MmInvoke ( MmMethod  mmMethod,
string  param,
MmMetadataBlock  metadataBlock 
)

Invoke an MmMethod with parameter: string.

Parameters
mmMethodMmMethod Identifier - MmMethod
paramMmMethod parameter: string.
metadataBlockObject defining the routing of Mmessages through MercuryMessaging Hierarchies. MmMetadataBlock

Implemented in MercuryMessaging.MmRelayNode.

◆ MmInvoke() [7/12]

void MercuryMessaging.IMmNode.MmInvoke ( MmMethod  mmMethod,
float  param,
MmMetadataBlock  metadataBlock 
)

Invoke an MmMethod with parameter: float.

Parameters
mmMethodMmMethod Identifier - MmMethod
paramMmMethod parameter: float.
metadataBlockObject defining the routing of Mmessages through MercuryMessaging Hierarchies. MmMetadataBlock

Implemented in MercuryMessaging.MmRelayNode.

◆ MmInvoke() [8/12]

void MercuryMessaging.IMmNode.MmInvoke ( MmMethod  mmMethod,
byte []  param,
MmMetadataBlock  metadataBlock 
)

Invoke an MmMethod with parameter: byte array.

Parameters
mmMethodMmMethod Identifier - MmMethod
paramMmMethod parameter: byte array.
metadataBlockObject defining the routing of Mmessages through MercuryMessaging Hierarchies. MmMetadataBlock

Implemented in MercuryMessaging.MmRelayNode.

◆ MmInvoke() [9/12]

void MercuryMessaging.IMmNode.MmInvoke ( MmMethod  mmMethod,
bool  param,
MmMetadataBlock  metadataBlock 
)

Invoke an MmMethod with parameter: bool.

Parameters
mmMethodMmMethod Identifier - MmMethod
paramMmMethod parameter: bool.
metadataBlockObject defining the routing of Mmessages through MercuryMessaging Hierarchies. MmMetadataBlock

Implemented in MercuryMessaging.MmRelayNode.

◆ MmInvoke() [10/12]

void MercuryMessaging.IMmNode.MmInvoke ( MmMethod  mmMethod,
IMmSerializable  param,
MmMetadataBlock  metadataBlock 
)

Invoke an MmMethod with parameter: IMmSerializable.

Parameters
mmMethodMmMethod Identifier - MmMethod
paramMmMethod parameter: IMmSerializable. IMmSerializable
metadataBlockObject defining the routing of Mmessages through MercuryMessaging Hierarchies. MmMetadataBlock

Implemented in MercuryMessaging.MmRelayNode.

◆ MmInvoke() [11/12]

void MercuryMessaging.IMmNode.MmInvoke ( MmMethod  mmMethod,
MmTransform  param,
MmMetadataBlock  metadataBlock 
)

Invoke an MmMethod with parameter: MmTransform.

Parameters
mmMethodMmMethod Identifier - MmMethod
paramMmMethod parameter: MmTransform. MmTransform
metadataBlockObject defining the routing of Mmessages through MercuryMessaging Hierarchies. MmMetadataBlock

Implemented in MercuryMessaging.MmRelayNode.

◆ MmInvoke() [12/12]

void MercuryMessaging.IMmNode.MmInvoke ( MmMethod  mmMethod,
List< MmTransform param,
MmMetadataBlock  metadataBlock 
)

Invoke an MmMethod with parameter: List<MmTransform>.

Parameters
mmMethodMmMethod Identifier - MmMethod
paramMmMethod parameter: List<MmTransform>.
metadataBlockObject defining the routing of Mmessages through MercuryMessaging Hierarchies. MmMetadataBlock

Implemented in MercuryMessaging.MmRelayNode.


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