Class CustomMessagingManager

The manager class to manage custom messages, note that this is different from the NetworkManager custom messages. These are named and are much easier to use.

Inheritance

object

CustomMessagingManager

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: MLAPI.Messaging

Assembly: Unity.Multiplayer.MLAPI.Runtime.dll

Syntax

public static class CustomMessagingManager

Methods

RegisterNamedMessageHandler(string, HandleNamedMessageDelegate)

Registers a named message handler delegate.

Declaration

public static void RegisterNamedMessageHandler(string name, CustomMessagingManager.HandleNamedMessageDelegate callback)

Parameters

Type	Name	Description
string	name	Name of the message.
CustomMessagingManager.HandleNamedMessageDelegate	callback	The callback to run when a named message is received.

SendNamedMessage(string, List<ulong>, Stream, NetworkChannel)

Sends the named message

Declaration

public static void SendNamedMessage(string name, List<ulong> clientIds, Stream stream, NetworkChannel networkChannel = NetworkChannel.Internal)

Parameters

Type	Name	Description
string	name	The message name to send
List<ulong>	clientIds	The clients to send to, sends to everyone if null
Stream	stream	The message stream containing the data
NetworkChannel	networkChannel	The channel to send the data on

SendNamedMessage(string, ulong, Stream, NetworkChannel)

Sends a named message

Declaration

public static void SendNamedMessage(string name, ulong clientId, Stream stream, NetworkChannel networkChannel = NetworkChannel.Internal)

Parameters

Type	Name	Description
string	name	The message name to send
ulong	clientId	The client to send the message to
Stream	stream	The message stream containing the data
NetworkChannel	networkChannel	The channel to send the data on

SendUnnamedMessage(List<ulong>, NetworkBuffer, NetworkChannel)

Sends unnamed message to a list of clients

Declaration

public static void SendUnnamedMessage(List<ulong> clientIds, NetworkBuffer buffer, NetworkChannel networkChannel = NetworkChannel.Internal)

Parameters

Type	Name	Description
List<ulong>	clientIds	The clients to send to, sends to everyone if null
NetworkBuffer	buffer	The message stream containing the data
NetworkChannel	networkChannel	The channel to send the data on

SendUnnamedMessage(ulong, NetworkBuffer, NetworkChannel)

Sends a unnamed message to a specific client

Declaration

public static void SendUnnamedMessage(ulong clientId, NetworkBuffer buffer, NetworkChannel networkChannel = NetworkChannel.Internal)

Parameters

Type	Name	Description
ulong	clientId	The client to send the message to
NetworkBuffer	buffer	The message stream containing the data
NetworkChannel	networkChannel	The channel tos end the data on

UnregisterNamedMessageHandler(string)

Unregisters a named message handler.

Declaration

public static void UnregisterNamedMessageHandler(string name)

Parameters

Type	Name	Description
string	name	The name of the message.

Events

OnUnnamedMessage

Event invoked when unnamed messages arrive

Declaration

public static event CustomMessagingManager.UnnamedMessageDelegate OnUnnamedMessage

Event Type

Type	Description
CustomMessagingManager.UnnamedMessageDelegate