Added BitWriter pooling to prevent allocating BitWriters

Author: TwoTenPvP

MLAPI/Data/NetworkConfig.cs

@@ -148,7 +148,7 @@ public byte[] GetConfig(bool cache = true)
             if (ConfigHash != null && cache)
                 return ConfigHash;
 
-            using (BitWriter writer = new BitWriter())
+            using (BitWriter writer = BitWriter.Get())
             {
                 writer.WriteUShort(ProtocolVersion);
                 for (int i = 0; i < Channels.Count; i++)

MLAPI/MonoBehaviours/Core/NetworkedBehaviour.cs

@@ -219,7 +219,7 @@ protected void InvokeCommand(string methodName, params object[] methodParams)
             }
 
             ulong hash = Data.Cache.GetMessageAttributeHash(methodName);
-            using (BitWriter writer = new BitWriter())
+            using (BitWriter writer = BitWriter.Get())
             {
                 writer.WriteUInt(networkId);
                 writer.WriteUShort(networkedObject.GetOrderIndex(this));
@@ -255,7 +255,7 @@ protected void InvokeClientRpc(string methodName, params object[] methodParams)
             }
 
             ulong hash = Data.Cache.GetMessageAttributeHash(methodName);
-            using (BitWriter writer = new BitWriter())
+            using (BitWriter writer = BitWriter.Get())
             {
                 writer.WriteUInt(networkId);
                 writer.WriteUShort(networkedObject.GetOrderIndex(this));
@@ -291,7 +291,7 @@ protected void InvokeTargetRpc(string methodName, params object[] methodParams)
             }
 
             ulong hash = Data.Cache.GetMessageAttributeHash(methodName);
-            using (BitWriter writer = new BitWriter())
+            using (BitWriter writer = BitWriter.Get())
             {
                 writer.WriteUInt(networkId);
                 writer.WriteUShort(networkedObject.GetOrderIndex(this));
@@ -474,7 +474,7 @@ internal void FlushToClient(uint clientId)
             if (syncedVarFields.Count == 0)
                 return;
 
-            using (BitWriter writer = new BitWriter())
+            using (BitWriter writer = BitWriter.Get())
             {
                 //Write all indexes
                 int syncCount = 0;
@@ -531,7 +531,7 @@ internal void SyncVarUpdate()
                 if (dirtyTargets == 0)
                 {
                     //It's sync time!
-                    using (BitWriter writer = new BitWriter())
+                    using (BitWriter writer = BitWriter.Get())
                     {
                         //Write all indexes
                         writer.WriteByte(totalDirtyCount);
@@ -561,7 +561,7 @@ internal void SyncVarUpdate()
                     if (!(isHost && ownerClientId == NetworkingManager.singleton.NetworkConfig.NetworkTransport.HostDummyId))
                     {
                         //It's sync time. This is the target receivers packet.
-                        using (BitWriter writer = new BitWriter())
+                        using (BitWriter writer = BitWriter.Get())
                         {
                             //Write all indexes
                             writer.WriteByte(totalDirtyCount);
@@ -592,7 +592,7 @@ internal void SyncVarUpdate()
                         return;
 
                     //It's sync time. This is the NON target receivers packet.
-                    using (BitWriter writer = new BitWriter())
+                    using (BitWriter writer = BitWriter.Get())
                     {
                         //Write all indexes
                         writer.WriteByte(nonTargetDirtyCount);
@@ -665,7 +665,7 @@ protected void SendToServer(string messageType, string channelName, byte[] data)
                 Debug.LogWarning("MLAPI: Server can not send messages to server.");
                 return;
             }
-            using (BitWriter writer = new BitWriter())
+            using (BitWriter writer = BitWriter.Get())
             {
                 writer.WriteByteArray(data);
                 InternalMessageHandler.Send(NetworkingManager.singleton.NetworkConfig.NetworkTransport.ServerNetId, messageType, channelName, writer, null);
@@ -733,7 +733,7 @@ protected void SendToServerTarget(string messageType, string channelName, byte[]
                 Debug.LogWarning("MLAPI: Server can not send messages to server.");
                 return;
             }
-            using (BitWriter writer = new BitWriter())
+            using (BitWriter writer = BitWriter.Get())
             {
                 writer.WriteByteArray(data);
                 InternalMessageHandler.Send(NetworkingManager.singleton.NetworkConfig.NetworkTransport.ServerNetId, messageType, channelName, writer, null, networkId, networkedObject.GetOrderIndex(this));
@@ -803,7 +803,7 @@ protected void SendToLocalClient(string messageType, string channelName, byte[]
                 return;
             }
             uint? fromNetId = respectObservers ? (uint?)networkId : null;
-            using (BitWriter writer = new BitWriter())
+            using (BitWriter writer = BitWriter.Get())
             {
                 writer.WriteByteArray(data);
                 InternalMessageHandler.Send(ownerClientId, messageType, channelName, writer, fromNetId);
@@ -874,7 +874,7 @@ protected void SendToLocalClientTarget(string messageType, string channelName, b
                 Debug.LogWarning("MLAPI: Invalid Passthrough send. Ensure AllowPassthroughMessages are turned on and that the MessageType " + messageType + " is registered as a passthroughMessageType");
                 return;
             }
-            using (BitWriter writer = new BitWriter())
+            using (BitWriter writer = BitWriter.Get())
             {
                 writer.WriteByteArray(data);
                 InternalMessageHandler.Send(ownerClientId, messageType, channelName, writer, null, networkId, networkedObject.GetOrderIndex(this));
@@ -944,7 +944,7 @@ protected void SendToNonLocalClients(string messageType, string channelName, byt
                 return;
             }
             uint? fromNetId = respectObservers ? (uint?)networkId : null;
-            using (BitWriter writer = new BitWriter())
+            using (BitWriter writer = BitWriter.Get())
             {
                 writer.WriteByteArray(data);
                 InternalMessageHandler.Send(messageType, channelName, writer, ownerClientId, fromNetId, null, null);
@@ -1017,7 +1017,7 @@ protected void SendToNonLocalClientsTarget(string messageType, string channelNam
                 return;
             }
             uint? fromNetId = respectObservers ? (uint?)networkId : null;
-            using (BitWriter writer = new BitWriter())
+            using (BitWriter writer = BitWriter.Get())
             {
                 writer.WriteByteArray(data);
                 InternalMessageHandler.Send(messageType, channelName, writer, ownerClientId, fromNetId, networkId, networkedObject.GetOrderIndex(this));
@@ -1091,7 +1091,7 @@ protected void SendToClient(uint clientId, string messageType, string channelNam
                 return;
             }
             uint? fromNetId = respectObservers ? (uint?)networkId : null;
-            using (BitWriter writer = new BitWriter())
+            using (BitWriter writer = BitWriter.Get())
             {
                 writer.WriteByteArray(data);
                 InternalMessageHandler.Send(clientId, messageType, channelName, writer, fromNetId);
@@ -1168,7 +1168,7 @@ protected void SendToClientTarget(uint clientId, string messageType, string chan
                 return;
             }
             uint? fromNetId = respectObservers ? (uint?)networkId : null;
-            using (BitWriter writer = new BitWriter())
+            using (BitWriter writer = BitWriter.Get())
             {
                 writer.WriteByteArray(data);
                 InternalMessageHandler.Send(clientId, messageType, channelName, writer, fromNetId, networkId, networkedObject.GetOrderIndex(this));
@@ -1244,7 +1244,7 @@ protected void SendToClients(uint[] clientIds, string messageType, string channe
                 return;
             }
             uint? fromNetId = respectObservers ? (uint?)networkId : null;
-            using (BitWriter writer = new BitWriter())
+            using (BitWriter writer = BitWriter.Get())
             {
                 writer.WriteByteArray(data);
                 InternalMessageHandler.Send(clientIds, messageType, channelName, writer, fromNetId);
@@ -1320,7 +1320,7 @@ protected void SendToClientsTarget(uint[] clientIds, string messageType, string
                 return;
             }
             uint? fromNetId = respectObservers ? (uint?)networkId : null;
-            using (BitWriter writer = new BitWriter())
+            using (BitWriter writer = BitWriter.Get())
             {
                 writer.WriteByteArray(data);
                 InternalMessageHandler.Send(clientIds, messageType, channelName, writer, fromNetId, networkId, networkedObject.GetOrderIndex(this));
@@ -1396,7 +1396,7 @@ protected void SendToClients(List<uint> clientIds, string messageType, string ch
                 return;
             }
             uint? fromNetId = respectObservers ? (uint?)networkId : null;
-            using (BitWriter writer = new BitWriter())
+            using (BitWriter writer = BitWriter.Get())
             {
                 writer.WriteByteArray(data);
                 InternalMessageHandler.Send(clientIds, messageType, channelName, writer, fromNetId);
@@ -1472,7 +1472,7 @@ protected void SendToClientsTarget(List<uint> clientIds, string messageType, str
                 return;
             }
             uint? fromNetId = respectObservers ? (uint?)networkId : null;
-            using (BitWriter writer = new BitWriter())
+            using (BitWriter writer = BitWriter.Get())
             {
                 writer.WriteByteArray(data);
                 InternalMessageHandler.Send(clientIds, messageType, channelName, writer, fromNetId, networkId, networkedObject.GetOrderIndex(this));
@@ -1547,7 +1547,7 @@ protected void SendToClients(string messageType, string channelName, byte[] data
                 return;
             }
             uint? fromNetId = respectObservers ? (uint?)networkId : null;
-            using (BitWriter writer = new BitWriter())
+            using (BitWriter writer = BitWriter.Get())
             {
                 writer.WriteByteArray(data);
                 InternalMessageHandler.Send(messageType, channelName, writer, fromNetId);
@@ -1620,7 +1620,7 @@ protected void SendToClientsTarget(string messageType, string channelName, byte[
                 return;
             }
             uint? fromNetId = respectObservers ? (uint?)networkId : null;
-            using (BitWriter writer = new BitWriter())
+            using (BitWriter writer = BitWriter.Get())
             {
                 writer.WriteByteArray(data);
                 InternalMessageHandler.Send(messageType, channelName, writer, fromNetId, networkId, networkedObject.GetOrderIndex(this));

MLAPI/MonoBehaviours/Core/NetworkedObject.cs

@@ -183,7 +183,7 @@ internal void RebuildObservers(uint? clientId = null)
                             (!previousObservers.Contains(pair.Key) && observers.Contains(pair.Key)))
                         {
                             //Something changed for this client.
-                            using (BitWriter writer = new BitWriter())
+                            using (BitWriter writer = BitWriter.Get())
                             {
                                 writer.WriteUInt(networkId);
                                 writer.WriteBool(observers.Contains(pair.Key));

MLAPI/MonoBehaviours/Core/NetworkingManager.cs

@@ -687,7 +687,7 @@ private void Update()
                                         diffiePublic = clientDiffieHellman.GetPublicKey();
                                     }
 
-                                    using (BitWriter writer = new BitWriter())
+                                    using (BitWriter writer = BitWriter.Get())
                                     {
                                         writer.WriteByteArray(NetworkConfig.GetConfig(), true);
 
@@ -999,7 +999,7 @@ internal void OnClientDisconnect(uint clientId)
                 foreach (KeyValuePair<uint, NetworkedObject> pair in SpawnManager.spawnedObjects)
                     pair.Value.observers.Remove(clientId);
 
-                using (BitWriter writer = new BitWriter())
+                using (BitWriter writer = BitWriter.Get())
                 {
                     writer.WriteUInt(clientId);
                     InternalMessageHandler.Send("MLAPI_CLIENT_DISCONNECT", "MLAPI_INTERNAL", writer, clientId, null);
@@ -1009,7 +1009,7 @@ internal void OnClientDisconnect(uint clientId)
 
         private void SyncTime()
         {
-            using (BitWriter writer = new BitWriter())
+            using (BitWriter writer = BitWriter.Get())
             {
                 writer.WriteFloat(NetworkTime);
                 int timestamp = NetworkConfig.NetworkTransport.GetNetworkTimestamp();
@@ -1065,7 +1065,7 @@ internal void HandleApproval(uint clientId, bool approved, Vector3 position, Qua
 
                 int amountOfObjectsToSend = SpawnManager.spawnedObjects.Values.Count;
 
-                using (BitWriter writer = new BitWriter())
+                using (BitWriter writer = BitWriter.Get())
                 {
                     writer.WriteUInt(clientId);
                     if (NetworkConfig.EnableSceneSwitching)
@@ -1125,7 +1125,7 @@ internal void HandleApproval(uint clientId, bool approved, Vector3 position, Qua
 
                 //Inform old clients of the new player
 
-                using (BitWriter writer = new BitWriter())
+                using (BitWriter writer = BitWriter.Get())
                 {
                     if (NetworkConfig.HandleObjectSpawning)
                     {

MLAPI/NetworkingManagerComponents/Binary/BinarySerializer.cs

@@ -40,7 +40,7 @@ public static byte[] Serialize<T>(T instance)
                 cachedFields.Add(instance.GetType().FullName, sortedFields);
             }
 
-            using (BitWriter writer = new BitWriter())
+            using (BitWriter writer = BitWriter.Get())
             {
                 for (int i = 0; i < sortedFields.Length; i++)
                 {

MLAPI/NetworkingManagerComponents/Binary/BitWriter.cs

@@ -24,7 +24,7 @@ public Partial(byte value, byte count)
             }
         }
 
-        private static readonly Queue<List<object>> listPool = new Queue<List<object>>();
+        private static readonly Queue<BitWriter> writerPool = new Queue<BitWriter>();
 
         private static readonly float[] holder_f = new float[1];
         private static readonly double[] holder_d = new double[1];
@@ -63,28 +63,34 @@ static BitWriter()
 
             for (int i = 0; i < 10; i++)
             {
-                listPool.Enqueue(new List<object>());
+                writerPool.Enqueue(new BitWriter());
             }
         }
 
-        private List<object> collect = null;
-        private bool tempAlloc = false;
+        private readonly List<object> collect = new List<object>();
+        private bool outsidePool = false;
 
         /// <summary>
-        /// Allocates a new binary collector.
+        /// Allocates a new binary collector. This is only used when there are no more writers in the pool
         /// </summary>
-        public BitWriter()
+        private BitWriter()
         {
-            if (listPool.Count == 0)
+
+        }
+
+        /// <summary>
+        /// Returns a BitWriter from the pool
+        /// </summary>
+        /// <returns></returns>
+        public static BitWriter Get()
+        {
+            if (writerPool.Count == 0)
             {
                 Debug.LogWarning("MLAPI: There can be no more than 10 BitWriters. Have you forgotten do dispose? (It will still work with worse performance)");
-                collect = new List<object>();
-                tempAlloc = true;
+                return new BitWriter() { outsidePool = true };
             }
             else
-            {
-                collect = listPool.Dequeue();
-            }
+                return writerPool.Dequeue();
         }
 
         private void Push<T>(T b)
@@ -425,15 +431,13 @@ private static int BytesToRead(object i)
         // Supported datatypes for serialization
         private static bool IsSupportedType(Type t) => supportedTypes.Contains(t);
 
-        // Creates a weak reference to the allocated collector so that reuse may be possible
         public void Dispose()
         {
-            if (!tempAlloc)
+            if (!outsidePool)
             {
                 collect.Clear();
-                listPool.Enqueue(collect);
+                writerPool.Enqueue(this);
             }
-            collect = null; //GC picks this
         }
     }
 }

MLAPI/NetworkingManagerComponents/Core/InternalMessageHandler.Send.cs

@@ -18,7 +18,7 @@ internal static void PassthroughSend(uint targetId, uint sourceId, ushort messag
                 return;
             }
 
-            using (BitWriter writer = new BitWriter())
+            using (BitWriter writer = BitWriter.Get())
             {
                 writer.WriteUShort(messageType);
                 writer.WriteBool(networkId != null);
@@ -72,7 +72,7 @@ internal static bool Send(uint clientId, string messageType, string channelName,
                 return true;
             }
 
-            using (BitWriter writer = new BitWriter())
+            using (BitWriter writer = BitWriter.Get())
             {
                 writer.WriteUShort(MessageManager.messageTypes[messageType]);
                 writer.WriteBool(networkId != null);
@@ -127,7 +127,7 @@ internal static void Send(uint[] clientIds, string messageType, string channelNa
                 return;
             }
 
-            using (BitWriter writer = new BitWriter())
+            using (BitWriter writer = BitWriter.Get())
             {
                 writer.WriteUShort(MessageManager.messageTypes[messageType]);
                 writer.WriteBool(networkId != null);
@@ -179,7 +179,7 @@ internal static void Send(List<uint> clientIds, string messageType, string chann
                 return;
             }
 
-            using (BitWriter writer = new BitWriter())
+            using (BitWriter writer = BitWriter.Get())
             {
                 writer.WriteUShort(MessageManager.messageTypes[messageType]);
                 writer.WriteBool(networkId != null);
@@ -236,7 +236,7 @@ internal static ref List<uint> Send(string messageType, string channelName, BitW
                 return ref failedObservers;
             }
 
-            using (BitWriter writer = new BitWriter())
+            using (BitWriter writer = BitWriter.Get())
             {
                 writer.WriteUShort(MessageManager.messageTypes[messageType]);
                 writer.WriteBool(networkId != null);
@@ -294,7 +294,7 @@ internal static ref List<uint> Send(string messageType, string channelName, BitW
                 return ref failedObservers;
             }
 
-            using (BitWriter writer = new BitWriter())
+            using (BitWriter writer = BitWriter.Get())
             {
                 writer.WriteUShort(MessageManager.messageTypes[messageType]);
                 writer.WriteBool(networkId != null);