Implement this interface to utilize your chosen Networking framework with Mercury XM. More...

Inheritance diagram for MercuryMessaging.IMmNetworkResponder:

Public Member Functions
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...

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

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

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

void	MmInvoke (MmMessageType msgType, MmMessage message, int connectionId=-1)
	This is the network equivalent of IMmResponder's MmInvoke. The difference is this class allows specification of connectionIDs which can be used to ensure messages are routed to the correct objects on network clients. More...

Properties
bool	AllowClientToSend `[get]`
	Allows us to stop messages on client from sending. More...

bool	IsActiveAndEnabled `[get]`
	Set when Network Obj is active & enabled. This is important since Objects in UNET scenarios UNET may not be awake/active at the same times. More...

bool	OnServer `[get]`
	Indicates whether the network responder is executing on a server More...

bool	OnClient `[get]`
	Indicates whether the network responder is executing on a client More...

Detailed Description

Implement this interface to utilize your chosen Networking framework with Mercury XM.

Member Function Documentation

◆ MmInvoke()

void MercuryMessaging.IMmNetworkResponder.MmInvoke	(	MmMessageType	msgType,
		MmMessage	message,
		int	connectionId = `-1`
	)

This is the network equivalent of IMmResponder's MmInvoke. The difference is this class allows specification of connectionIDs which can be used to ensure messages are routed to the correct objects on network clients.

Parameters

msgType	Type 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.
msg	The message to send. This class builds on UNET's MessageBase so it is Auto [de]serialized by UNET.
connectionId	Connection ID - use to identify clients.

Implemented in MercuryMessaging.MmNetworkResponder.

◆ MmOnAwakeComplete()

void MercuryMessaging.IMmNetworkResponder.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.

Implemented in MercuryMessaging.MmNetworkResponder.

◆ MmOnStartComplete()

void MercuryMessaging.IMmNetworkResponder.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.

Implemented in MercuryMessaging.MmNetworkResponder.

◆ MmRegisterAwakeCompleteCallback()

void MercuryMessaging.IMmNetworkResponder.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.

Parameters

callback Callback to be registered.

Implemented in MercuryMessaging.MmNetworkResponder.

◆ MmRegisterStartCompleteCallback()

void MercuryMessaging.IMmNetworkResponder.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.

Parameters

callback Callback to be registered.

Implemented in MercuryMessaging.MmNetworkResponder.

Property Documentation

◆ AllowClientToSend

bool MercuryMessaging.IMmNetworkResponder.AllowClientToSend

get

Allows us to stop messages on client from sending.

◆ IsActiveAndEnabled

bool MercuryMessaging.IMmNetworkResponder.IsActiveAndEnabled

get

Set when Network Obj is active & enabled. This is important since Objects in UNET scenarios UNET may not be awake/active at the same times.

◆ OnClient

bool MercuryMessaging.IMmNetworkResponder.OnClient

get

Indicates whether the network responder is executing on a client

◆ OnServer

bool MercuryMessaging.IMmNetworkResponder.OnServer

get

Indicates whether the network responder is executing on a server

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

C:/Users/ce223/Documents/Projects/MercuryMessaging/Assets/MercuryMessaging/Protocol/IMmNetworkResponder.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ MmInvoke()

◆ MmOnAwakeComplete()

◆ MmOnStartComplete()

◆ MmRegisterAwakeCompleteCallback()

◆ MmRegisterStartCompleteCallback()

Property Documentation

◆ AllowClientToSend

◆ IsActiveAndEnabled

◆ OnClient

◆ OnServer