MercuryMessaging.MmMessage Class Reference

Base class for messages passed through MmInvoke Built on Unity's Message Base, allowing usage of serialize/deserialize More...

Inheritance diagram for MercuryMessaging.MmMessage:

Public Member Functions
	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...
virtual MmMessage	Copy ()
	Message copy method More...
override void	Deserialize (NetworkReader reader)
	Deserialize the MmMessage More...
override void	Serialize (NetworkWriter writer)
	Serialize the MmMessage More...

Public Attributes
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...

Properties
bool	IsDeserialized [get]
	Utilized by Mercury serialization/deserialization systems. More...

Detailed Description

Base class for messages passed through MmInvoke Built on Unity's Message Base, allowing usage of serialize/deserialize

Constructor & Destructor Documentation

MmMessage() [1/5]

MercuryMessaging.MmMessage.MmMessage

(

)

Creates a basic MmMessage with a default control block

MmMessage() [2/5]

MercuryMessaging.MmMessage.MmMessage

(

MmMetadataBlock

metadataBlock

)

Creates a basic MmMessage with the passed control block.

Parameters

metadataBlock

Object defining the routing of messages.

MmMessage() [3/5]

MercuryMessaging.MmMessage.MmMessage	(	MmMethod	mmMethod,
		MmMetadataBlock	metadataBlock = null
	)

Create an MmMessage, with defined control block and MmMethod

Parameters

mmMethod	Identifier of target MmMethod
metadataBlock	Object defining the routing of messages through MercuryMessaging Hierarchys.

MmMessage() [4/5]

MercuryMessaging.MmMessage.MmMessage	(	MmMethod	mmMethod,
		MmLevelFilter	levelFilter,
		MmActiveFilter	activeFilter,
		MmSelectedFilter	selectedFilter,
		MmNetworkFilter	networkFilter
	)

Create an MmMessage, with filters defined directly

Parameters

mmMethod	Identifier of target MmMethod
levelFilter	Determines direction of messages
activeFilter	Determines whether message sent to active and/or inactive objects
selectedFilter	Determines whether message sent to objects "selected" as defined by MmRelayNode implementation
networkFilter	Determines whether message will remain local or can be sent over the network

MmMessage() [5/5]

MercuryMessaging.MmMessage.MmMessage

(

MmMessage

message

)

Duplicate an MmMessage

Parameters

message

Item to duplicate

Member Function Documentation

Copy()

virtual MmMessage MercuryMessaging.MmMessage.Copy ( )

virtual

Message copy method

Returns

Deep copy of message

Reimplemented in MercuryMessaging.MmMessageSerializable, MercuryMessaging.MmMessageTransformList, MercuryMessaging.MmMessageByteArray, MercuryMessaging.MmMessageVector4, MercuryMessaging.MmMessageTransform, MercuryMessaging.MmMessageVector3, MercuryMessaging.MmMessageFloat, MercuryMessaging.MmMessageInt, MercuryMessaging.MmMessageString, and MercuryMessaging.MmMessageBool.

Deserialize()

override void MercuryMessaging.MmMessage.Deserialize

(

NetworkReader

reader

)

Deserialize the MmMessage

Parameters

reader

UNET based deserializer object

Serialize()

override void MercuryMessaging.MmMessage.Serialize

(

NetworkWriter

writer

)

Serialize the MmMessage

Parameters

writer

UNET based serializer

Member Data Documentation

MetadataBlock

MmMetadataBlock MercuryMessaging.MmMessage.MetadataBlock

Control parameters designating how a message should traverse an MercuryMessaging Hierarchy.

MmMethod

MmMethod MercuryMessaging.MmMessage.MmMethod

The MmMethod invoked by the calling object.

NetId

uint MercuryMessaging.MmMessage.NetId

Network identifier of sender/recipient objects.

root

bool MercuryMessaging.MmMessage.root = true

Deprecated - remove in next version

TimeStamp

string MercuryMessaging.MmMessage.TimeStamp

Message timestamp, assists in collision avoidance

Property Documentation

IsDeserialized

bool MercuryMessaging.MmMessage.IsDeserialized

get

Utilized by Mercury serialization/deserialization systems.

---

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

• C:/Users/ce223/Documents/Projects/MercuryMessaging/Assets/MercuryMessaging/Protocol/Message/MmMessage.cs