MercuryMessaging.MmMessageString Class Reference

MmMessage with string payload More...

Inheritance diagram for MercuryMessaging.MmMessageString:

Public Member Functions
	MmMessageString ()
	Creates a basic MmMessageString More...
	MmMessageString (MmMetadataBlock metadataBlock=null)
	Creates a basic MmMessageString, with a control block More...
	MmMessageString (string initVal, MmMethod mmMethod=default(MmMethod), MmMetadataBlock metadataBlock=null)
	Create an MmMessage, with control block, MmMethod, and a string More...
	MmMessageString (MmMessageString 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
string	value
	String 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 string payload

Constructor & Destructor Documentation

MmMessageString() [1/4]

MercuryMessaging.MmMessageString.MmMessageString

(

)

Creates a basic MmMessageString

MmMessageString() [2/4]

MercuryMessaging.MmMessageString.MmMessageString

(

MmMetadataBlock

metadataBlock = null

)

Creates a basic MmMessageString, with a control block

Parameters

metadataBlock

Object defining the routing of messages

MmMessageString() [3/4]

MercuryMessaging.MmMessageString.MmMessageString	(	string	initVal,
		MmMethod	mmMethod = default(MmMethod),
		MmMetadataBlock	metadataBlock = null
	)

Create an MmMessage, with control block, MmMethod, and a string

Parameters

initVal	String payload
mmMethod	Identifier of target MmMethod
metadataBlock	Object defining the routing of messages

MmMessageString() [4/4]

MercuryMessaging.MmMessageString.MmMessageString

(

MmMessageString

message

)

Duplicate an MmMessage

Parameters

message

Item to duplicate

Member Function Documentation

Copy()

override MmMessage MercuryMessaging.MmMessageString.Copy ( )

virtual

Message copy method

Returns

Duplicate of MmMessage

Reimplemented from MercuryMessaging.MmMessage.

Deserialize()

override void MercuryMessaging.MmMessageString.Deserialize

(

NetworkReader

reader

)

Deserialize the message

Parameters

reader

UNET based deserializer object

Serialize()

override void MercuryMessaging.MmMessageString.Serialize

(

NetworkWriter

writer

)

Serialize the MmMessage

Parameters

writer

UNET based serializer

Member Data Documentation

value

string MercuryMessaging.MmMessageString.value

String payload

---

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

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