Mercury Messaging
Documentation for the Mercury Messaging Framework
MercuryMessaging.MmMessageTransform Class Reference

MmMessage with MmTransform payload More...

Inheritance diagram for MercuryMessaging.MmMessageTransform:
MercuryMessaging.MmMessage

Public Member Functions

 MmMessageTransform ()
 Creates a basic MmMessageTransform More...
 
 MmMessageTransform (MmMetadataBlock metadataBlock=null)
 Creates a basic MmMessageTransform, with a control block More...
 
 MmMessageTransform (MmTransform transform, MmMethod mmMethod=default(MmMethod), MmMetadataBlock metadataBlock=null)
 Create an MmMessage, with control block, MmMethod, and an MmTransform More...
 
 MmMessageTransform (MmMessageTransform message)
 Duplicate an MmMessage More...
 
override MmMessage Copy ()
 Message copy method More...
 
override void Deserialize (NetworkReader reader)
 Deserialize the message More...
 
override void Serialize (NetworkWriter writer)
 Serialize the MmMessage More...
 
- Public Member Functions inherited from MercuryMessaging.MmMessage
 MmMessage ()
 Creates a basic MmMessage with a default control block More...
 
 MmMessage (MmMetadataBlock metadataBlock)
 Creates a basic MmMessage with the passed control block. More...
 
 MmMessage (MmMethod mmMethod, MmMetadataBlock metadataBlock=null)
 Create an MmMessage, with defined control block and MmMethod More...
 
 MmMessage (MmMethod mmMethod, MmLevelFilter levelFilter, MmActiveFilter activeFilter, MmSelectedFilter selectedFilter, MmNetworkFilter networkFilter)
 Create an MmMessage, with filters defined directly More...
 
 MmMessage (MmMessage message)
 Duplicate an MmMessage More...
 
override void Deserialize (NetworkReader reader)
 Deserialize the MmMessage More...
 
override void Serialize (NetworkWriter writer)
 Serialize the MmMessage More...
 

Public Attributes

MmTransform MmTransform
 MmTransform payload More...
 
- Public Attributes inherited from MercuryMessaging.MmMessage
MmMethod MmMethod
 The MmMethod invoked by the calling object. More...
 
MmMetadataBlock MetadataBlock
 Control parameters designating how a message should traverse an MercuryMessaging Hierarchy. More...
 
uint NetId
 Network identifier of sender/recipient objects. More...
 
bool root = true
 Deprecated - remove in next version More...
 
string TimeStamp
 Message timestamp, assists in collision avoidance More...
 

Additional Inherited Members

- Properties inherited from MercuryMessaging.MmMessage
bool IsDeserialized [get]
 Utilized by Mercury serialization/deserialization systems. More...
 

Detailed Description

MmMessage with MmTransform payload

Constructor & Destructor Documentation

◆ MmMessageTransform() [1/4]

MercuryMessaging.MmMessageTransform.MmMessageTransform ( )

Creates a basic MmMessageTransform

◆ MmMessageTransform() [2/4]

MercuryMessaging.MmMessageTransform.MmMessageTransform ( MmMetadataBlock  metadataBlock = null)

Creates a basic MmMessageTransform, with a control block

Parameters
metadataBlockObject defining the routing of messages

◆ MmMessageTransform() [3/4]

MercuryMessaging.MmMessageTransform.MmMessageTransform ( MmTransform  transform,
MmMethod  mmMethod = default(MmMethod),
MmMetadataBlock  metadataBlock = null 
)

Create an MmMessage, with control block, MmMethod, and an MmTransform

Parameters
transformMmTransform payload
mmMethodIdentifier of target MmMethod
metadataBlockObject defining the routing of messages

◆ MmMessageTransform() [4/4]

MercuryMessaging.MmMessageTransform.MmMessageTransform ( MmMessageTransform  message)

Duplicate an MmMessage

Parameters
messageItem to duplicate

Member Function Documentation

◆ Copy()

override MmMessage MercuryMessaging.MmMessageTransform.Copy ( )
virtual

Message copy method

Returns
Duplicate of MmMessage

Reimplemented from MercuryMessaging.MmMessage.

◆ Deserialize()

override void MercuryMessaging.MmMessageTransform.Deserialize ( NetworkReader  reader)

Deserialize the message

Parameters
readerUNET based deserializer object

◆ Serialize()

override void MercuryMessaging.MmMessageTransform.Serialize ( NetworkWriter  writer)

Serialize the MmMessage

Parameters
writerUNET based serializer

Member Data Documentation

◆ MmTransform

MmTransform MercuryMessaging.MmMessageTransform.MmTransform

MmTransform payload


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