Merge branch 'master' of https://github.com/MidLevel/MLAPI

Author: TwoTenPvP

MLAPI/Core/NetworkingManager.cs

@@ -614,7 +614,7 @@ private void Update()
                     do
                     {
                         processedEvents++;
-                        eventType = NetworkConfig.NetworkTransport.PollEvent(out ulong clientId, out string channelName, out ArraySegment<byte> payload);
+                        eventType = NetworkConfig.NetworkTransport.PollEvent(out ulong clientId, out string channelName, out ArraySegment<byte> payload, out float receiveTime);
 
                         switch (eventType)
                         {
@@ -696,7 +696,7 @@ private void Update()
                             case NetEventType.Data:
                                 if (LogHelper.CurrentLogLevel <= LogLevel.Developer) LogHelper.LogInfo($"Incoming Data From {clientId} : {payload.Count} bytes");
 
-                                HandleIncomingData(clientId, channelName, payload);
+                                HandleIncomingData(clientId, channelName, payload, receiveTime);
                                 break;
                             case NetEventType.Disconnect:
                                 NetworkProfiler.StartEvent(TickType.Receive, 0, "NONE", "TRANSPORT_DISCONNECT");
@@ -756,16 +756,18 @@ private void Update()
             }
         }
 
-        internal void UpdateNetworkTime(ulong clientId, float netTime)
+        internal void UpdateNetworkTime(ulong clientId, float netTime, float receiveTime, bool onlyIfNotInitialized = false)
         {
+            if (onlyIfNotInitialized && networkTimeInitialized)
+                return;
             float rtt = NetworkConfig.NetworkTransport.GetCurrentRtt(clientId) / 1000f;
-            networkTimeOffset = netTime - Time.realtimeSinceStartup + rtt / 2f;
+            networkTimeOffset = netTime - receiveTime + rtt / 2f;
             if (!networkTimeInitialized) {
                 currentNetworkTimeOffset = networkTimeOffset;
                 networkTimeInitialized = true;
             }
             if (LogHelper.CurrentLogLevel <= LogLevel.Developer) LogHelper.LogInfo($"Received network time {netTime}, RTT to server is {rtt}, setting offset to {networkTimeOffset} (delta {networkTimeOffset - currentNetworkTimeOffset})");
-    }
+        }
 
     internal void SendConnectionRequest()
         {
@@ -806,7 +808,7 @@ internal IEnumerator TimeOutSwitchSceneProgress(SceneSwitchProgress switchSceneP
             switchSceneProgress.SetTimedOut();
         }
 
-        private void HandleIncomingData(ulong clientId, string channelName, ArraySegment<byte> data)
+        private void HandleIncomingData(ulong clientId, string channelName, ArraySegment<byte> data, float receiveTime)
         {
             if (LogHelper.CurrentLogLevel <= LogLevel.Developer) LogHelper.LogInfo("Unwrapping Data Header");
 
@@ -851,7 +853,7 @@ private void HandleIncomingData(ulong clientId, string channelName, ArraySegment
                             break;
                         case MLAPIConstants.MLAPI_CONNECTION_APPROVED:
                             if (IsClient)
-                                InternalMessageHandler.HandleConnectionApproved(clientId, messageStream);
+                                InternalMessageHandler.HandleConnectionApproved(clientId, messageStream, receiveTime);
                             break;
                         case MLAPIConstants.MLAPI_ADD_OBJECT:
                             if (IsClient) InternalMessageHandler.HandleAddObject(clientId, messageStream);
@@ -872,7 +874,7 @@ private void HandleIncomingData(ulong clientId, string channelName, ArraySegment
                             if (IsClient) InternalMessageHandler.HandleDestroyObjects(clientId, messageStream);
                             break;
                         case MLAPIConstants.MLAPI_TIME_SYNC:
-                            if (IsClient) InternalMessageHandler.HandleTimeSync(clientId, messageStream);
+                            if (IsClient) InternalMessageHandler.HandleTimeSync(clientId, messageStream, receiveTime);
                             break;
                         case MLAPIConstants.MLAPI_NETWORKED_VAR_DELTA:
                             InternalMessageHandler.HandleNetworkedVarDelta(clientId, messageStream);
@@ -1045,6 +1047,9 @@ internal void HandleApproval(ulong clientId, ulong? prefabHash, bool approved, V
                 ConnectedClients.Add(clientId, client);
                 ConnectedClientsList.Add(client);
 
+                // This packet is unreliable, but if it gets through it should provide a much better sync than the potentially huge approval message.
+                SyncTime();
+                
                 NetworkedObject netObject = SpawnManager.CreateLocalNetworkedObject(false, 0, (prefabHash == null ? NetworkConfig.PlayerPrefabHash : prefabHash.Value), null, position, rotation);
                 SpawnManager.SpawnNetworkedObjectLocally(netObject, SpawnManager.GetNetworkObjectId(), false, true, clientId, null, false, 0, false, false);
 

MLAPI/Messaging/InternalMessageHandler.cs

@@ -196,7 +196,7 @@ internal static void HandleConnectionRequest(ulong clientId, Stream stream)
             }
         }
 
-        internal static void HandleConnectionApproved(ulong clientId, Stream stream)
+        internal static void HandleConnectionApproved(ulong clientId, Stream stream, float receiveTime)
         {
             using (PooledBitReader reader = PooledBitReader.Get(stream))
             {
@@ -206,7 +206,7 @@ internal static void HandleConnectionApproved(ulong clientId, Stream stream)
                 Guid sceneSwitchProgressGuid = new Guid(reader.ReadByteArray());
 
                 float netTime = reader.ReadSinglePacked();
-                NetworkingManager.Singleton.UpdateNetworkTime(clientId, netTime);
+                NetworkingManager.Singleton.UpdateNetworkTime(clientId, netTime, receiveTime, true);
 
                 NetworkingManager.Singleton.ConnectedClients.Add(NetworkingManager.Singleton.LocalClientId, new NetworkedClient() { ClientId = NetworkingManager.Singleton.LocalClientId });
 
@@ -437,12 +437,12 @@ internal static void HandleDestroyObjects(ulong clientId, Stream stream)
             }
         }
 
-        internal static void HandleTimeSync(ulong clientId, Stream stream)
+        internal static void HandleTimeSync(ulong clientId, Stream stream, float receiveTime)
         {
             using (PooledBitReader reader = PooledBitReader.Get(stream))
             {
                 float netTime = reader.ReadSinglePacked();
-                NetworkingManager.Singleton.UpdateNetworkTime(clientId, netTime);
+                NetworkingManager.Singleton.UpdateNetworkTime(clientId, netTime, receiveTime);
             }
         }
 

MLAPI/Transports/Transport.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using UnityEngine;
 
 namespace MLAPI.Transports
@@ -81,7 +81,22 @@ public abstract class Transport : MonoBehaviour
         /// <param name="payload">The incoming data payload</param>
         /// <returns>Returns the event type</returns>
         public abstract NetEventType PollEvent(out ulong clientId, out string channelName, out ArraySegment<byte> payload);
-        
+
+        /// <summary>
+        /// Polls for incoming events, with an extra output parameter to report the precise time the event was received.
+        /// THIS METHOD IS OPTIONAL.  If you do implement in, you can just provide an empty stub implementation for the old PollEvent method.
+        /// </summary>
+        /// <param name="clientId">The clientId this event is for</param>
+        /// <param name="channelName">The channel the data arrived at. This is usually used when responding to things like RPCs</param>
+        /// <param name="payload">The incoming data payload</param>
+        /// <param name="receiveTime">The time the event was received, as reported by Time.realtimeSinceStartup.</param>
+        /// <returns>Returns the event type</returns>
+        public virtual NetEventType PollEvent(out ulong clientId, out string channelName, out ArraySegment<byte> payload, out float receiveTime)
+        {
+            receiveTime = Time.realtimeSinceStartup;
+            return PollEvent(out clientId, out channelName, out payload);
+        }
+
         /// <summary>
         /// Connects client to server
         /// </summary>