fix: Rename 'Send Queue Batch Size' field in adapter (1.0.0) (#1585)

Author: simon-lemay-unity

com.unity.netcode.adapter.utp/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 All notable changes to this package will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 
+## [Unreleased]
+
+### Added
+
+### Changed
+
+- Rename the 'Send Queue Batch Size' property to 'Max Payload Size' to better reflect its usage. (#1585)
+
+### Fixed
+
 ## [1.0.0-pre.4] - 2022-01-04
 
 ### Added

com.unity.netcode.adapter.utp/Runtime/UnityTransport.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using UnityEngine;
+using UnityEngine.Serialization;
 using NetcodeNetworkEvent = Unity.Netcode.NetworkEvent;
 using TransportNetworkEvent = Unity.Networking.Transport.NetworkEvent;
 using Unity.Collections.LowLevel.Unsafe;
@@ -85,8 +86,8 @@ private enum State
         }
 
         public const int InitialMaxPacketQueueSize = 128;
-        public const int InitialBatchQueueSize = 6 * 1024;
-        public const int InitialMaxSendQueueSize = 16 * InitialBatchQueueSize;
+        public const int InitialMaxPayloadSize = 6 * 1024;
+        public const int InitialMaxSendQueueSize = 16 * InitialMaxPayloadSize;
 
         private static ConnectionAddressData s_DefaultConnectionAddressData = new ConnectionAddressData()
         { Address = "127.0.0.1", Port = 7777 };
@@ -103,9 +104,9 @@ private enum State
             "Basically this is how many packets can be sent/received in a single update/frame.")]
         [SerializeField] private int m_MaxPacketQueueSize = InitialMaxPacketQueueSize;
 
-        [Tooltip("The maximum size of a batched send. The send queue accumulates messages and batches them together " +
-            "up to this size. This is effectively the maximum payload size that can be handled by the transport.")]
-        [SerializeField] private int m_SendQueueBatchSize = InitialBatchQueueSize;
+        [Tooltip("The maximum size of a payload that can be handled by the transport.")]
+        [FormerlySerializedAs("m_SendQueueBatchSize")]
+        [SerializeField] private int m_MaxPayloadSize = InitialMaxPayloadSize;
 
         [Tooltip("The maximum size in bytes of the transport send queue. The send queue accumulates messages for " +
             "batching and stores messages when other internal send queues are full. If you routinely observe an " +
@@ -639,9 +640,9 @@ public override void Initialize()
 
             m_NetworkSettings = new NetworkSettings(Allocator.Persistent);
 
-            // If the user sends a message of exactly m_SendQueueBatchSize in length, we need to
+            // If the user sends a message of exactly m_MaxPayloadSize in length, we need to
             // account for the overhead of its length when we store it in the send queue.
-            var fragmentationCapacity = m_SendQueueBatchSize + BatchedSendQueue.PerMessageOverhead;
+            var fragmentationCapacity = m_MaxPayloadSize + BatchedSendQueue.PerMessageOverhead;
 
             m_NetworkSettings
                 .WithFragmentationStageParameters(payloadCapacity: fragmentationCapacity)
@@ -660,9 +661,9 @@ public override NetcodeNetworkEvent PollEvent(out ulong clientId, out ArraySegme
 
         public override void Send(ulong clientId, ArraySegment<byte> payload, NetworkDelivery networkDelivery)
         {
-            if (payload.Count > m_SendQueueBatchSize)
+            if (payload.Count > m_MaxPayloadSize)
             {
-                Debug.LogError($"Payload of size {payload.Count} larger than configured 'Send Queue Batch Size' ({m_SendQueueBatchSize}).");
+                Debug.LogError($"Payload of size {payload.Count} larger than configured 'Max Payload Size' ({m_MaxPayloadSize}).");
                 return;
             }
 
@@ -671,7 +672,7 @@ public override void Send(ulong clientId, ArraySegment<byte> payload, NetworkDel
             var sendTarget = new SendTarget(clientId, pipeline);
             if (!m_SendQueue.TryGetValue(sendTarget, out var queue))
             {
-                queue = new BatchedSendQueue(Math.Max(m_MaxSendQueueSize, m_SendQueueBatchSize));
+                queue = new BatchedSendQueue(Math.Max(m_MaxSendQueueSize, m_MaxPayloadSize));
                 m_SendQueue.Add(sendTarget, queue);
             }
 

com.unity.netcode.adapter.utp/Tests/Runtime/Helpers/DriverClient.cs

@@ -36,7 +36,7 @@ public class DriverClient : MonoBehaviour
         private void Awake()
         {
 
-            var maxCap = UnityTransport.InitialBatchQueueSize + 128;
+            var maxCap = UnityTransport.InitialMaxPayloadSize + 128;
 
             var settings = new NetworkSettings();
             settings.WithFragmentationStageParameters(payloadCapacity: maxCap);

com.unity.netcode.adapter.utp/Tests/Runtime/TransportTests.cs

@@ -128,7 +128,7 @@ public IEnumerator SendMaximumPayloadSize([ValueSource("k_DeliveryParameters")]
 
             yield return WaitForNetworkEvent(NetworkEvent.Connect, m_ServerEvents);
 
-            var payload = new ArraySegment<byte>(new byte[UnityTransport.InitialBatchQueueSize]);
+            var payload = new ArraySegment<byte>(new byte[UnityTransport.InitialMaxPayloadSize]);
             m_Client1.Send(m_Client1.ServerClientId, payload, delivery);
 
             yield return WaitForNetworkEvent(NetworkEvent.Data, m_ServerEvents);