Initial Commit

Library/PackageCache/com.unity.multiplayer.mlapi@3e3aef6aa0/Runtime/Profiling/NetworkProfiler.cs

@@ -0,0 +1,142 @@
+using System.Collections.Generic;
+using MLAPI.Collections;
+using MLAPI.Configuration;
+using MLAPI.Transports;
+using UnityEngine;
+
+namespace MLAPI.Profiling
+{
+    /// <summary>
+    /// NetworkProfiler for profiling network traffic
+    /// </summary>
+    public static class NetworkProfiler
+    {
+        /// <summary>
+        /// The ticks that has been recorded
+        /// </summary>
+        public static FixedQueue<ProfilerTick> Ticks { get; private set; }
+
+        /// <summary>
+        /// Whether or not the profiler is recording data
+        /// </summary>
+        public static bool IsRunning { get; private set; }
+
+        private static int s_TickHistory = 1024;
+        private static int s_EventIdCounter = 0;
+        private static ProfilerTick s_CurrentTick;
+
+        /// <summary>
+        /// Starts recording data for the Profiler
+        /// </summary>
+        /// <param name="historyLength">The amount of ticks to keep in memory</param>
+        public static void Start(int historyLength)
+        {
+            if (IsRunning) return;
+            s_EventIdCounter = 0;
+            Ticks = new FixedQueue<ProfilerTick>(historyLength);
+            s_TickHistory = historyLength;
+            s_CurrentTick = null;
+            IsRunning = true;
+        }
+
+        /// <summary>
+        /// Stops recording data
+        /// </summary>
+        public static void Stop()
+        {
+            Ticks = null; //leave to GC
+            s_CurrentTick = null; //leave to GC
+            IsRunning = false;
+        }
+
+        /// <summary>
+        /// Stops recording data and fills the buffer with the recorded ticks and returns the length;
+        /// </summary>
+        /// <param name="tickBuffer">The buffer to fill with the ticks</param>
+        /// <returns>The number of ticks recorded</returns>
+        public static int Stop(ref ProfilerTick[] tickBuffer)
+        {
+            if (!IsRunning) return 0;
+            int iteration = Ticks.Count > tickBuffer.Length ? tickBuffer.Length : Ticks.Count;
+            for (int i = 0; i < iteration; i++) tickBuffer[i] = Ticks[i];
+
+            Ticks = null; //leave to GC
+            s_CurrentTick = null; //leave to GC
+            IsRunning = false;
+
+            return iteration;
+        }
+
+        /// <summary>
+        /// Stops recording data and fills the buffer with the recorded ticks and returns the length;
+        /// </summary>
+        /// <param name="tickBuffer">The buffer to fill with the ticks</param>
+        /// <returns>The number of ticks recorded</returns>
+        public static int Stop(ref List<ProfilerTick> tickBuffer)
+        {
+            if (!IsRunning) return 0;
+
+            int iteration = Ticks.Count > tickBuffer.Count ? tickBuffer.Count : Ticks.Count;
+            for (int i = 0; i < iteration; i++) tickBuffer[i] = Ticks[i];
+
+            Ticks = null; //leave to GC
+            s_CurrentTick = null; //leave to GC
+            IsRunning = false;
+
+            return iteration;
+        }
+
+        internal static void StartTick(TickType type)
+        {
+            if (!IsRunning) return;
+            if (Ticks.Count == s_TickHistory)
+            {
+                Ticks.Dequeue();
+            }
+
+            var tick = new ProfilerTick()
+            {
+                Type = type,
+                Frame = Time.frameCount,
+                EventId = s_EventIdCounter
+            };
+            s_EventIdCounter++;
+            Ticks.Enqueue(tick);
+            s_CurrentTick = tick;
+        }
+
+        internal static void EndTick()
+        {
+            if (!IsRunning) return;
+            if (s_CurrentTick == null) return;
+            s_CurrentTick = null;
+        }
+
+        internal static void StartEvent(TickType eventType, uint bytes, NetworkChannel networkChannel, byte messageType)
+        {
+            if (!IsRunning) return;
+            if (s_CurrentTick == null) return;
+
+            string messageName = messageType < NetworkConstants.MESSAGE_NAMES.Length ? NetworkConstants.MESSAGE_NAMES[messageType] : "INVALID_MESSAGE_TYPE";
+
+            string channelName = networkChannel.ToString();
+            s_CurrentTick.StartEvent(eventType, bytes, channelName, messageName);
+        }
+
+        internal static void StartEvent(TickType eventType, uint bytes, NetworkChannel networkChannel, string messageName)
+        {
+            if (!IsRunning) return;
+            if (s_CurrentTick == null) return;
+
+            string channelName = networkChannel.ToString();
+            s_CurrentTick.StartEvent(eventType, bytes, channelName, messageName);
+        }
+
+        internal static void EndEvent()
+        {
+            if (!IsRunning) return;
+            if (s_CurrentTick == null) return;
+            s_CurrentTick.EndEvent();
+        }
+    }
+}