refactor: channel internally represented with bytes vs. strings [MTT-236]

Author: mattwalsh-unity

com.unity.multiplayer.mlapi/Runtime/Core/MessageBatcher.cs

@@ -13,7 +13,7 @@ class MessageBatcher
     {
         public class SendStream
         {
-            public string channel;
+            public byte channel;
             public PooledBitStream Stream = PooledBitStream.Get();
             public bool Empty = true;
         }

com.unity.multiplayer.mlapi/Runtime/Core/NetworkedBehaviour.cs

@@ -15,6 +15,7 @@
 using MLAPI.Serialization;
 using MLAPI.Serialization.Pooled;
 using MLAPI.Spawning;
+using MLAPI.Transports;
 using BitStream = MLAPI.Serialization.BitStream;
 using Unity.Profiling;
 
@@ -38,11 +39,6 @@ internal enum NExec
             Client = 2
         }
 
-        /// <summary>
-        /// This is a temporary solution for channel names and the below hardcoded value might not be mandatory in the future.
-        /// </summary>
-        private const string StandardRpc_ChannelName = "STDRPC";
-
 #pragma warning disable 414
         // RuntimeAccessModifiersILPP will make this `protected`
         internal NExec __nexec = NExec.None;
@@ -53,7 +49,7 @@ internal BitWriter BeginSendServerRpc(ServerRpcSendParams sendParams, bool isRel
         {
             var rpcQueueMananger = NetworkingManager.Singleton.rpcQueueContainer;
 
-            var writer = rpcQueueMananger.BeginAddQueueItemToOutboundFrame(RpcQueueContainer.QueueItemType.ServerRpc, Time.realtimeSinceStartup, StandardRpc_ChannelName, 0, NetworkingManager.Singleton.ServerClientId, null);
+            var writer = rpcQueueMananger.BeginAddQueueItemToOutboundFrame(RpcQueueContainer.QueueItemType.ServerRpc, Time.realtimeSinceStartup, Transport.MLAPI_STDRPC_CHANNEL, 0, NetworkingManager.Singleton.ServerClientId, null);
             writer.WriteUInt64Packed(NetworkId); // NetworkObjectId
             writer.WriteUInt16Packed(GetBehaviourId()); // NetworkBehaviourId
             return writer;
@@ -74,7 +70,7 @@ internal BitWriter BeginSendClientRpc(ClientRpcSendParams sendParams, bool isRel
             //This will start a new queue item entry and will then return the writer to the current frame's stream
             var rpcQueueMananger = NetworkingManager.Singleton.rpcQueueContainer;
 
-            var writer = rpcQueueMananger.BeginAddQueueItemToOutboundFrame(RpcQueueContainer.QueueItemType.ClientRpc, Time.realtimeSinceStartup, StandardRpc_ChannelName, 0, NetworkId, sendParams.TargetClientIds ?? NetworkingManager.Singleton.ConnectedClientsList.Select(c => c.ClientId).ToArray());
+            var writer = rpcQueueMananger.BeginAddQueueItemToOutboundFrame(RpcQueueContainer.QueueItemType.ClientRpc, Time.realtimeSinceStartup, Transport.MLAPI_STDRPC_CHANNEL, 0, NetworkId, sendParams.TargetClientIds ?? NetworkingManager.Singleton.ConnectedClientsList.Select(c => c.ClientId).ToArray());
             writer.WriteUInt64Packed(NetworkId); // NetworkObjectId
             writer.WriteUInt16Packed(GetBehaviourId()); // NetworkBehaviourId
             return writer;
@@ -271,7 +267,7 @@ protected NetworkedBehaviour GetBehaviour(ushort id)
         private bool varInit = false;
 
         private readonly List<HashSet<int>> channelMappedNetworkedVarIndexes = new List<HashSet<int>>();
-        private readonly List<string> channelsForNetworkedVarGroups = new List<string>();
+        private readonly List<byte> channelsForNetworkedVarGroups = new List<byte>();
         internal readonly List<INetworkedVar> networkedVarFields = new List<INetworkedVar>();
 
         private static HashSet<MLAPI.NetworkedObject> touched = new HashSet<MLAPI.NetworkedObject>();
@@ -336,12 +332,15 @@ internal void InitializeVars()
 
             {
                 // Create index map for channels
-                Dictionary<string, int> firstLevelIndex = new Dictionary<string, int>();
+                Dictionary<byte, int> firstLevelIndex = new Dictionary<byte, int>();
                 int secondLevelCounter = 0;
 
                 for (int i = 0; i < networkedVarFields.Count; i++)
                 {
-                    string channel = networkedVarFields[i].GetChannel(); // Cache this here. Some developers are stupid. You don't know what shit they will do in their methods
+                    // this could be cleaner.  The GetChannel() methods look for the SendChannel string channel name
+                    //  from the settings file.
+                    string channelName = networkedVarFields[i].GetChannel(); // Cache this here. Some developers are stupid. You don't know what shit they will do in their methods
+                    byte channel = Transport.GetChannelByte(channelName);
 
                     if (!firstLevelIndex.ContainsKey(channel))
                     {

com.unity.multiplayer.mlapi/Runtime/Core/NetworkedObject.cs

@@ -10,6 +10,7 @@
 using MLAPI.Security;
 using MLAPI.Serialization.Pooled;
 using MLAPI.Spawning;
+using MLAPI.Transports;
 using Unity.Profiling;
 using UnityEngine;
 
@@ -277,7 +278,7 @@ public static void NetworkShow(List<NetworkedObject> networkedObjects, ulong cli
                     SpawnManager.WriteSpawnCallForObject(stream, clientId, networkedObjects[i], payload);
                 }
 
-                InternalMessageSender.Send(clientId, MLAPIConstants.MLAPI_ADD_OBJECTS, "MLAPI_INTERNAL", stream, SecuritySendFlags.None);
+                InternalMessageSender.Send(clientId, MLAPIConstants.MLAPI_ADD_OBJECTS, Transport.MLAPI_INTERNAL_CHANNEL, stream, SecuritySendFlags.None);
             }
         }
 
@@ -317,7 +318,7 @@ public void NetworkHide(ulong clientId)
                 {
                     writer.WriteUInt64Packed(NetworkId);
 
-                    InternalMessageSender.Send(clientId, MLAPIConstants.MLAPI_DESTROY_OBJECT, "MLAPI_INTERNAL", stream, SecuritySendFlags.None);
+                    InternalMessageSender.Send(clientId, MLAPIConstants.MLAPI_DESTROY_OBJECT, Transport.MLAPI_INTERNAL_CHANNEL, stream, SecuritySendFlags.None);
                 }
             }
         }
@@ -369,7 +370,7 @@ public static void NetworkHide(List<NetworkedObject> networkedObjects, ulong cli
                     }
                 }
 
-                InternalMessageSender.Send(clientId, MLAPIConstants.MLAPI_DESTROY_OBJECTS, "MLAPI_INTERNAL", stream, SecuritySendFlags.None);
+                InternalMessageSender.Send(clientId, MLAPIConstants.MLAPI_DESTROY_OBJECTS, Transport.MLAPI_INTERNAL_CHANNEL, stream, SecuritySendFlags.None);
             }
         }
 

com.unity.multiplayer.mlapi/Runtime/Core/NetworkingManager.cs

@@ -261,15 +261,15 @@ internal void InvokeOnIncomingCustomMessage(ulong clientId, Stream stream)
         /// <param name="channel">The channel to send the data on</param>
         /// <param name="security">The security settings to apply to the message</param>
         [Obsolete("Use CustomMessagingManager.SendUnnamedMessage instead")]
-        public void SendCustomMessage(List<ulong> clientIds, BitStream stream, string channel = null, SecuritySendFlags security = SecuritySendFlags.None)
+        public void SendCustomMessage(List<ulong> clientIds, BitStream stream, byte channel = Transport.MLAPI_INTERNAL_CHANNEL, SecuritySendFlags security = SecuritySendFlags.None)
         {
             if (!IsServer)
             {
                 if (NetworkLog.CurrentLogLevel <= LogLevel.Error) NetworkLog.LogWarning("Can not send unnamed message to multiple users as a client");
                 return;
             }
 
-            InternalMessageSender.Send(MLAPIConstants.MLAPI_UNNAMED_MESSAGE, string.IsNullOrEmpty(channel) ? "MLAPI_DEFAULT_MESSAGE" : channel, clientIds, stream, security);
+            InternalMessageSender.Send(MLAPIConstants.MLAPI_UNNAMED_MESSAGE, channel, clientIds, stream, security);
         }
 
         /// <summary>
@@ -280,9 +280,9 @@ public void SendCustomMessage(List<ulong> clientIds, BitStream stream, string ch
         /// <param name="channel">The channel tos end the data on</param>
         /// <param name="security">The security settings to apply to the message</param>
         [Obsolete("Use CustomMessagingManager.SendUnnamedMessage instead")]
-        public void SendCustomMessage(ulong clientId, BitStream stream, string channel = null, SecuritySendFlags security = SecuritySendFlags.None)
+        public void SendCustomMessage(ulong clientId, BitStream stream, byte channel = Transport.MLAPI_INTERNAL_CHANNEL, SecuritySendFlags security = SecuritySendFlags.None)
         {
-            InternalMessageSender.Send(clientId, MLAPIConstants.MLAPI_UNNAMED_MESSAGE, string.IsNullOrEmpty(channel) ? "MLAPI_DEFAULT_MESSAGE" : channel, stream, security);
+            InternalMessageSender.Send(clientId, MLAPIConstants.MLAPI_UNNAMED_MESSAGE, channel, stream, security);
         }
 
         private void OnValidate()
@@ -732,7 +732,7 @@ private void NetworkPreUpdate()
                         while (__loopbackRpcQueue.Count > 0)
                         {
                             var (payload, receiveTime) = __loopbackRpcQueue.Dequeue();
-                            HandleRawTransportPoll(NetEventType.Data, ServerClientId, "STDRPC", payload, receiveTime);
+                            HandleRawTransportPoll(NetEventType.Data, ServerClientId, Transport.MLAPI_STDRPC_CHANNEL, payload, receiveTime);
                         }
                     }
                     // @mfatihmar (Unity) End: Temporary, inbound RPC queue will replace this workaround
@@ -748,7 +748,10 @@ private void NetworkPreUpdate()
                         {
                             processedEvents++;
                             eventType = NetworkConfig.NetworkTransport.PollEvent(out ulong clientId, out string channelName, out ArraySegment<byte> payload, out float receiveTime);
-                            HandleRawTransportPoll(eventType, clientId, channelName, payload, receiveTime);
+                            // [MTT-443] This can be improved if the Transport implementations return the channel as a byte vs. string
+                            //  Holding off on this; refactoring the Transport package will be a separate step
+                            byte channel = Transport.GetChannelByte(channelName);
+                            HandleRawTransportPoll(eventType, clientId, channel, payload, receiveTime);
 
                             // Only do another iteration if: there are no more messages AND (there is no limit to max events or we have processed less than the maximum)
                         } while (IsListening && (eventType != NetEventType.Nothing) && (NetworkConfig.MaxReceiveEventsPerTickRate <= 0 || processedEvents < NetworkConfig.MaxReceiveEventsPerTickRate));
@@ -881,7 +884,7 @@ internal void SendConnectionRequest()
                         writer.WriteByteArray(NetworkConfig.ConnectionData);
                 }
 
-                InternalMessageSender.Send(ServerClientId, MLAPIConstants.MLAPI_CONNECTION_REQUEST, "MLAPI_INTERNAL", stream, SecuritySendFlags.Authenticated | SecuritySendFlags.Encrypted);
+                InternalMessageSender.Send(ServerClientId, MLAPIConstants.MLAPI_CONNECTION_REQUEST, Transport.MLAPI_INTERNAL_CHANNEL, stream, SecuritySendFlags.Authenticated | SecuritySendFlags.Encrypted);
             }
         }
 
@@ -908,7 +911,7 @@ internal IEnumerator TimeOutSwitchSceneProgress(SceneSwitchProgress switchSceneP
             switchSceneProgress.SetTimedOut();
         }
 
-        private void HandleRawTransportPoll(NetEventType eventType, ulong clientId, string channelName, ArraySegment<byte> payload, float receiveTime)
+        private void HandleRawTransportPoll(NetEventType eventType, ulong clientId, byte channel, ArraySegment<byte> payload, float receiveTime)
         {
             ProfilerStatManager.bytesRcvd.Record(payload.Count);
             switch (eventType)
@@ -917,7 +920,7 @@ private void HandleRawTransportPoll(NetEventType eventType, ulong clientId, stri
 #if DEVELOPMENT_BUILD || UNITY_EDITOR
                     s_TransportConnect.Begin();
 #endif
-                    NetworkProfiler.StartEvent(TickType.Receive, (uint)payload.Count, channelName, "TRANSPORT_CONNECT");
+                    NetworkProfiler.StartEvent(TickType.Receive, (uint)payload.Count, channel, "TRANSPORT_CONNECT");
                     if (IsServer)
                     {
                         if (NetworkLog.CurrentLogLevel <= LogLevel.Developer) NetworkLog.LogInfo("Client Connected");
@@ -984,7 +987,7 @@ private void HandleRawTransportPoll(NetEventType eventType, ulong clientId, stri
                                     }
                                 }
                                 // Send the hail
-                                InternalMessageSender.Send(clientId, MLAPIConstants.MLAPI_CERTIFICATE_HAIL, "MLAPI_INTERNAL", hailStream, SecuritySendFlags.None, null);
+                                InternalMessageSender.Send(clientId, MLAPIConstants.MLAPI_CERTIFICATE_HAIL, Transport.MLAPI_INTERNAL_CHANNEL, hailStream, SecuritySendFlags.None);
                             }
                         }
                         else
@@ -1016,14 +1019,14 @@ private void HandleRawTransportPoll(NetEventType eventType, ulong clientId, stri
                 case NetEventType.Data:
                     {
                         if (NetworkLog.CurrentLogLevel <= LogLevel.Developer) NetworkLog.LogInfo($"Incoming Data From {clientId} : {payload.Count} bytes");
-                        HandleIncomingData(clientId, channelName, payload, receiveTime, true);
+                        HandleIncomingData(clientId, channel, payload, receiveTime, true);
                         break;
                     }
                 case NetEventType.Disconnect:
 #if DEVELOPMENT_BUILD || UNITY_EDITOR
                     s_TransportDisconnect.Begin();
 #endif
-                    NetworkProfiler.StartEvent(TickType.Receive, 0, "NONE", "TRANSPORT_DISCONNECT");
+                    NetworkProfiler.StartEvent(TickType.Receive, 0, Transport.MLAPI_INTERNAL_CHANNEL, "TRANSPORT_DISCONNECT");
 
                     if (NetworkLog.CurrentLogLevel <= LogLevel.Developer) NetworkLog.LogInfo("Disconnect Event From " + clientId);
 
@@ -1048,7 +1051,7 @@ private void HandleRawTransportPoll(NetEventType eventType, ulong clientId, stri
         private readonly BitStream inputStreamWrapper = new BitStream(new byte[0]);
         private MessageBatcher batcher = new MessageBatcher();
 
-        internal void HandleIncomingData(ulong clientId, string channelName, ArraySegment<byte> data, float receiveTime, bool allowBuffer)
+        internal void HandleIncomingData(ulong clientId, byte channel, ArraySegment<byte> data, float receiveTime, bool allowBuffer)
         {
 #if DEVELOPMENT_BUILD || UNITY_EDITOR
             s_HandleIncomingData.Begin();
@@ -1073,7 +1076,7 @@ internal void HandleIncomingData(ulong clientId, string channelName, ArraySegmen
                 }
 
                 uint headerByteSize = (uint)Arithmetic.VarIntSize(messageType);
-                NetworkProfiler.StartEvent(TickType.Receive, (uint)(data.Count - headerByteSize), channelName, messageType);
+                NetworkProfiler.StartEvent(TickType.Receive, (uint)(data.Count - headerByteSize), channel, messageType);
 
                 if (NetworkLog.CurrentLogLevel <= LogLevel.Developer) NetworkLog.LogInfo("Data Header: messageType=" + messageType);
 
@@ -1120,7 +1123,7 @@ internal void HandleIncomingData(ulong clientId, string channelName, ArraySegmen
                         InternalMessageHandler.HandleNetworkedVarDelta(clientId, messageStream, BufferCallback, new PreBufferPreset()
                         {
                             AllowBuffer = allowBuffer,
-                            ChannelName = channelName,
+                            Channel = channel,
                             ClientId = clientId,
                             Data = data,
                             MessageType = messageType,
@@ -1131,7 +1134,7 @@ internal void HandleIncomingData(ulong clientId, string channelName, ArraySegmen
                         InternalMessageHandler.HandleNetworkedVarUpdate(clientId, messageStream, BufferCallback, new PreBufferPreset()
                         {
                             AllowBuffer = allowBuffer,
-                            ChannelName = channelName,
+                            Channel = channel,
                             ClientId = clientId,
                             Data = data,
                             MessageType = messageType,
@@ -1266,7 +1269,7 @@ private void BufferCallback(ulong networkId, PreBufferPreset preset)
                 throw new InvalidOperationException("Cannot buffer on server.");
             }
 
-            BufferManager.BufferMessageForNetworkId(networkId, preset.ClientId, preset.ChannelName, preset.ReceiveTime, preset.Data);
+            BufferManager.BufferMessageForNetworkId(networkId, preset.ClientId, preset.Channel, preset.ReceiveTime, preset.Data);
         }
 
         /// <summary>
@@ -1375,7 +1378,7 @@ private void SyncTime()
                 using (PooledBitWriter writer = PooledBitWriter.Get(stream))
                 {
                     writer.WriteSinglePacked(Time.realtimeSinceStartup);
-                    InternalMessageSender.Send(MLAPIConstants.MLAPI_TIME_SYNC, "MLAPI_TIME_SYNC", stream, SecuritySendFlags.None);
+                    InternalMessageSender.Send(MLAPIConstants.MLAPI_TIME_SYNC, Transport.MLAPI_TIME_SYNC_CHANNEL, stream, SecuritySendFlags.None);
                 }
             }
 #if DEVELOPMENT_BUILD || UNITY_EDITOR
@@ -1509,7 +1512,7 @@ internal void HandleApproval(ulong clientId, bool createPlayerObject, ulong? pla
                             }
                         }
 
-                        InternalMessageSender.Send(clientId, MLAPIConstants.MLAPI_CONNECTION_APPROVED, "MLAPI_INTERNAL", stream, SecuritySendFlags.Encrypted | SecuritySendFlags.Authenticated);
+                        InternalMessageSender.Send(clientId, MLAPIConstants.MLAPI_CONNECTION_APPROVED, Transport.MLAPI_INTERNAL_CHANNEL, stream, SecuritySendFlags.Encrypted | SecuritySendFlags.Authenticated);
 
                         if (OnClientConnectedCallback != null)
                             OnClientConnectedCallback.Invoke(clientId);
@@ -1571,7 +1574,7 @@ internal void HandleApproval(ulong clientId, bool createPlayerObject, ulong? pla
                                 ConnectedClients[clientId].PlayerObject.WriteNetworkedVarData(stream, clientPair.Key);
                             }
 
-                            InternalMessageSender.Send(clientPair.Key, MLAPIConstants.MLAPI_ADD_OBJECT, "MLAPI_INTERNAL", stream, SecuritySendFlags.None);
+                            InternalMessageSender.Send(clientPair.Key, MLAPIConstants.MLAPI_ADD_OBJECT, Transport.MLAPI_INTERNAL_CHANNEL, stream, SecuritySendFlags.None);
                         }
                     }
                 }

com.unity.multiplayer.mlapi/Runtime/Core/RPCQueue/FrameQueueItem.cs

@@ -16,7 +16,7 @@ public struct FrameQueueItem
         public RpcQueueContainer.QueueItemType queueItemType;
         public SecuritySendFlags        sendFlags;
         public ulong                    networkId;          //Sender's network Identifier
-        public string                   channel;
+        public byte                     channel;
         public ulong[]                  clientIds;          //Server invoked Client RPCs only
         public long                     streamSize;
         public float                    timeStamp;

com.unity.multiplayer.mlapi/Runtime/Core/RPCQueue/QueueHistoryFrame.cs

@@ -85,7 +85,7 @@ private FrameQueueItem GetCurrentQueueItem()
             if (m_QueueFrameType == QueueFrameType.Outbound)
             {
                 //Outbound we care about both channel and clients
-                m_CurrentQueueItem.channel = queueReader.ReadString().ToString();
+                m_CurrentQueueItem.channel = queueReader.ReadByteDirect();
                 int NumClients = queueReader.ReadInt32();
                 if (NumClients > 0 && NumClients < m_MaximumClients)
                 {