Skip to content

Commit 05206d6

Browse files
author
Jean-Sébastien Fauteux
authored
refactor: Clarify naming of profiler constants (fix #602 and fix #603) (#611)
* fix: Clarify naming of profiler constants (fix #602 and fix #603) * Removing s and correcting formatting for the Rpc
1 parent a39c4d6 commit 05206d6

File tree

10 files changed

+74
-74
lines changed

10 files changed

+74
-74
lines changed

‎com.unity.multiplayer.mlapi/Editor/MLAPIProfilerModule.cs‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -47,13 +47,13 @@ private class MLAPIModules
4747

4848
private static List<MLAPIProfilerCounter> CreateRPCCounters() => new List<MLAPIProfilerCounter>()
4949
{
50-
new MLAPIProfilerCounter { m_Name = ProfilerConstants.NumberOfRPCsSent, m_Category = ProfilerCategory.Network.Name },
51-
new MLAPIProfilerCounter { m_Name = ProfilerConstants.NumberOfRPCsReceived, m_Category = ProfilerCategory.Network.Name },
52-
new MLAPIProfilerCounter { m_Name = ProfilerConstants.NumberOfRPCBatchesSent, m_Category = ProfilerCategory.Network.Name },
53-
new MLAPIProfilerCounter { m_Name = ProfilerConstants.NumberOfRPCBatchesReceived, m_Category = ProfilerCategory.Network.Name },
54-
new MLAPIProfilerCounter { m_Name = ProfilerConstants.NumberOfRPCQueueProcessed, m_Category = ProfilerCategory.Network.Name },
55-
new MLAPIProfilerCounter { m_Name = ProfilerConstants.NumberOfRPCsInQueueSize, m_Category = ProfilerCategory.Network.Name },
56-
new MLAPIProfilerCounter { m_Name = ProfilerConstants.NumberOfRPCsOutQueueSize, m_Category = ProfilerCategory.Network.Name },
50+
new MLAPIProfilerCounter { m_Name = ProfilerConstants.RpcSent, m_Category = ProfilerCategory.Network.Name },
51+
new MLAPIProfilerCounter { m_Name = ProfilerConstants.RpcReceived, m_Category = ProfilerCategory.Network.Name },
52+
new MLAPIProfilerCounter { m_Name = ProfilerConstants.RpcBatchesSent, m_Category = ProfilerCategory.Network.Name },
53+
new MLAPIProfilerCounter { m_Name = ProfilerConstants.RpcBatchesReceived, m_Category = ProfilerCategory.Network.Name },
54+
new MLAPIProfilerCounter { m_Name = ProfilerConstants.RpcQueueProcessed, m_Category = ProfilerCategory.Network.Name },
55+
new MLAPIProfilerCounter { m_Name = ProfilerConstants.RpcInQueueSize, m_Category = ProfilerCategory.Network.Name },
56+
new MLAPIProfilerCounter { m_Name = ProfilerConstants.RpcOutQueueSize, m_Category = ProfilerCategory.Network.Name },
5757
};
5858

5959
private static List<MLAPIProfilerCounter> CreateOperationsCounters() => new List<MLAPIProfilerCounter>()
@@ -64,11 +64,11 @@ private class MLAPIModules
6464

6565
private static List<MLAPIProfilerCounter> CreateMessagesCounters() => new List<MLAPIProfilerCounter>()
6666
{
67-
new MLAPIProfilerCounter { m_Name = ProfilerConstants.NumberOfNamedMessages, m_Category = ProfilerCategory.Network.Name },
68-
new MLAPIProfilerCounter { m_Name = ProfilerConstants.NumberOfUnnamedMessages, m_Category = ProfilerCategory.Network.Name },
69-
new MLAPIProfilerCounter { m_Name = ProfilerConstants.NumberBytesSent, m_Category = ProfilerCategory.Network.Name },
70-
new MLAPIProfilerCounter { m_Name = ProfilerConstants.NumberBytesReceived, m_Category = ProfilerCategory.Network.Name },
71-
new MLAPIProfilerCounter { m_Name = ProfilerConstants.NumberNetworkVarsReceived, m_Category = ProfilerCategory.Network.Name },
67+
new MLAPIProfilerCounter { m_Name = ProfilerConstants.NamedMessageReceived, m_Category = ProfilerCategory.Network.Name },
68+
new MLAPIProfilerCounter { m_Name = ProfilerConstants.UnnamedMessageReceived, m_Category = ProfilerCategory.Network.Name },
69+
new MLAPIProfilerCounter { m_Name = ProfilerConstants.ByteSent, m_Category = ProfilerCategory.Network.Name },
70+
new MLAPIProfilerCounter { m_Name = ProfilerConstants.ByteReceived, m_Category = ProfilerCategory.Network.Name },
71+
new MLAPIProfilerCounter { m_Name = ProfilerConstants.NetworkVarReceived, m_Category = ProfilerCategory.Network.Name },
7272
};
7373

7474
private delegate List<MLAPIProfilerCounter> CounterListFactoryDelegate();

‎com.unity.multiplayer.mlapi/Runtime/Core/NetworkBehaviour.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -729,7 +729,7 @@ internal static void HandleNetworkVariableDeltas(List<INetworkVariable> networkV
729729
long readStartPos = stream.Position;
730730

731731
networkVariableList[i].ReadDelta(stream, IsServer, localTick, remoteTick);
732-
PerformanceDataManager.Increment(ProfilerConstants.NumberNetworkVarsReceived);
732+
PerformanceDataManager.Increment(ProfilerConstants.NetworkVarReceived);
733733

734734
ProfilerStatManager.NetworkVarsRcvd.Record();
735735

@@ -810,7 +810,7 @@ internal static void HandleNetworkVariableUpdate(List<INetworkVariable> networkV
810810
long readStartPos = stream.Position;
811811

812812
networkVariableList[i].ReadField(stream, NetworkTickSystem.NoTick, NetworkTickSystem.NoTick);
813-
PerformanceDataManager.Increment(ProfilerConstants.NumberNetworkVarsReceived);
813+
PerformanceDataManager.Increment(ProfilerConstants.NetworkVarReceived);
814814

815815
ProfilerStatManager.NetworkVarsRcvd.Record();
816816

‎com.unity.multiplayer.mlapi/Runtime/Core/NetworkManager.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -831,7 +831,7 @@ internal IEnumerator TimeOutSwitchSceneProgress(SceneSwitchProgress switchSceneP
831831

832832
private void HandleRawTransportPoll(NetworkEvent networkEvent, ulong clientId, NetworkChannel networkChannel, ArraySegment<byte> payload, float receiveTime)
833833
{
834-
PerformanceDataManager.Increment(ProfilerConstants.NumberBytesReceived, payload.Count);
834+
PerformanceDataManager.Increment(ProfilerConstants.ByteReceived, payload.Count);
835835
ProfilerStatManager.BytesRcvd.Record(payload.Count);
836836

837837
switch (networkEvent)
@@ -1052,7 +1052,7 @@ internal void HandleIncomingData(ulong clientId, NetworkChannel networkChannel,
10521052
{
10531053
m_RpcBatcher.ReceiveItems(messageStream, ReceiveCallback, RpcQueueContainer.QueueItemType.ServerRpc, clientId, receiveTime);
10541054
ProfilerStatManager.RpcBatchesRcvd.Record();
1055-
PerformanceDataManager.Increment(ProfilerConstants.NumberOfRPCBatchesReceived);
1055+
PerformanceDataManager.Increment(ProfilerConstants.RpcBatchesReceived);
10561056
}
10571057
else
10581058
{
@@ -1070,7 +1070,7 @@ internal void HandleIncomingData(ulong clientId, NetworkChannel networkChannel,
10701070
{
10711071
m_RpcBatcher.ReceiveItems(messageStream, ReceiveCallback, RpcQueueContainer.QueueItemType.ClientRpc, clientId, receiveTime);
10721072
ProfilerStatManager.RpcBatchesRcvd.Record();
1073-
PerformanceDataManager.Increment(ProfilerConstants.NumberOfRPCBatchesReceived);
1073+
PerformanceDataManager.Increment(ProfilerConstants.RpcBatchesReceived);
10741074
}
10751075
else
10761076
{

‎com.unity.multiplayer.mlapi/Runtime/Messaging/InternalMessageHandler.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -550,7 +550,7 @@ internal static void RpcReceiveQueueItem(ulong clientId, Stream stream, float re
550550
}
551551

552552
ProfilerStatManager.RpcsRcvd.Record();
553-
PerformanceDataManager.Increment(ProfilerConstants.NumberOfRPCsReceived);
553+
PerformanceDataManager.Increment(ProfilerConstants.RpcReceived);
554554

555555
#if DEVELOPMENT_BUILD || UNITY_EDITOR
556556
switch (queueItemType)
@@ -582,7 +582,7 @@ internal static void RpcReceiveQueueItem(ulong clientId, Stream stream, float re
582582

583583
internal static void HandleUnnamedMessage(ulong clientId, Stream stream)
584584
{
585-
PerformanceDataManager.Increment(ProfilerConstants.NumberOfUnnamedMessages);
585+
PerformanceDataManager.Increment(ProfilerConstants.UnnamedMessageReceived);
586586
ProfilerStatManager.UnnamedMessage.Record();
587587
#if DEVELOPMENT_BUILD || UNITY_EDITOR
588588
s_HandleUnnamedMessage.Begin();
@@ -595,7 +595,7 @@ internal static void HandleUnnamedMessage(ulong clientId, Stream stream)
595595

596596
internal static void HandleNamedMessage(ulong clientId, Stream stream)
597597
{
598-
PerformanceDataManager.Increment(ProfilerConstants.NumberOfNamedMessages);
598+
PerformanceDataManager.Increment(ProfilerConstants.NamedMessageReceived);
599599
ProfilerStatManager.NamedMessage.Record();
600600
#if DEVELOPMENT_BUILD || UNITY_EDITOR
601601
s_HandleNamedMessage.Begin();

‎com.unity.multiplayer.mlapi/Runtime/Messaging/InternalMessageSender.cs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ internal static void Send(ulong clientId, byte messageType, NetworkChannel netwo
2222

2323
NetworkManager.Singleton.NetworkConfig.NetworkTransport.Send(clientId, new ArraySegment<byte>(buffer.GetBuffer(), 0, (int)buffer.Length), networkChannel);
2424
ProfilerStatManager.BytesSent.Record((int)buffer.Length);
25-
PerformanceDataManager.Increment(ProfilerConstants.NumberBytesSent, (int)buffer.Length);
25+
PerformanceDataManager.Increment(ProfilerConstants.ByteSent, (int)buffer.Length);
2626

2727
#if !UNITY_2020_2_OR_NEWER
2828
NetworkProfiler.EndEvent();
@@ -46,7 +46,7 @@ internal static void Send(byte messageType, NetworkChannel networkChannel, Netwo
4646

4747
NetworkManager.Singleton.NetworkConfig.NetworkTransport.Send(NetworkManager.Singleton.ConnectedClientsList[i].ClientId, new ArraySegment<byte>(buffer.GetBuffer(), 0, (int)buffer.Length), networkChannel);
4848
ProfilerStatManager.BytesSent.Record((int)buffer.Length);
49-
PerformanceDataManager.Increment(ProfilerConstants.NumberBytesSent, (int)buffer.Length);
49+
PerformanceDataManager.Increment(ProfilerConstants.ByteSent, (int)buffer.Length);
5050
}
5151

5252
#if !UNITY_2020_2_OR_NEWER
@@ -77,7 +77,7 @@ internal static void Send(byte messageType, NetworkChannel networkChannel, List<
7777

7878
NetworkManager.Singleton.NetworkConfig.NetworkTransport.Send(clientIds[i], new ArraySegment<byte>(buffer.GetBuffer(), 0, (int)buffer.Length), networkChannel);
7979
ProfilerStatManager.BytesSent.Record((int)buffer.Length);
80-
PerformanceDataManager.Increment(ProfilerConstants.NumberBytesSent, (int)buffer.Length);
80+
PerformanceDataManager.Increment(ProfilerConstants.ByteSent, (int)buffer.Length);
8181
}
8282

8383
#if !UNITY_2020_2_OR_NEWER
@@ -106,7 +106,7 @@ internal static void Send(byte messageType, NetworkChannel networkChannel, ulong
106106

107107
NetworkManager.Singleton.NetworkConfig.NetworkTransport.Send(NetworkManager.Singleton.ConnectedClientsList[i].ClientId, new ArraySegment<byte>(buffer.GetBuffer(), 0, (int)buffer.Length), networkChannel);
108108
ProfilerStatManager.BytesSent.Record((int)buffer.Length);
109-
PerformanceDataManager.Increment(ProfilerConstants.NumberBytesSent, (int)buffer.Length);
109+
PerformanceDataManager.Increment(ProfilerConstants.ByteSent, (int)buffer.Length);
110110
}
111111

112112
#if !UNITY_2020_2_OR_NEWER

‎com.unity.multiplayer.mlapi/Runtime/Messaging/RpcBatcher.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -146,8 +146,8 @@ public void QueueItem(in RpcFrameQueueItem queueItem)
146146

147147
ProfilerStatManager.BytesSent.Record(queueItem.MessageData.Count);
148148
ProfilerStatManager.RpcsSent.Record();
149-
PerformanceDataManager.Increment(ProfilerConstants.NumberBytesSent, queueItem.MessageData.Count);
150-
PerformanceDataManager.Increment(ProfilerConstants.NumberOfRPCsSent);
149+
PerformanceDataManager.Increment(ProfilerConstants.ByteSent, queueItem.MessageData.Count);
150+
PerformanceDataManager.Increment(ProfilerConstants.RpcSent);
151151
}
152152
}
153153

@@ -178,7 +178,7 @@ public void SendItems(int thresholdBytes, SendCallbackType sendCallback)
178178
entry.Value.Buffer.Position = 0;
179179
entry.Value.IsEmpty = true;
180180
ProfilerStatManager.RpcBatchesSent.Record();
181-
PerformanceDataManager.Increment(ProfilerConstants.NumberOfRPCBatchesSent);
181+
PerformanceDataManager.Increment(ProfilerConstants.RpcBatchesSent);
182182
}
183183
}
184184
}

‎com.unity.multiplayer.mlapi/Runtime/Messaging/RpcQueue/RpcQueueContainer.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -192,12 +192,12 @@ public void AdvanceFrameHistory(RpcQueueHistoryFrame.QueueFrameType queueType)
192192
if (queueType == RpcQueueHistoryFrame.QueueFrameType.Inbound)
193193
{
194194
ProfilerStatManager.RpcInQueueSize.Record((int)rpcQueueHistoryItem.TotalSize);
195-
PerformanceDataManager.Increment(ProfilerConstants.NumberOfRPCsInQueueSize, (int)rpcQueueHistoryItem.TotalSize);
195+
PerformanceDataManager.Increment(ProfilerConstants.RpcInQueueSize, (int)rpcQueueHistoryItem.TotalSize);
196196
}
197197
else
198198
{
199199
ProfilerStatManager.RpcOutQueueSize.Record((int)rpcQueueHistoryItem.TotalSize);
200-
PerformanceDataManager.Increment(ProfilerConstants.NumberOfRPCsOutQueueSize, (int)rpcQueueHistoryItem.TotalSize);
200+
PerformanceDataManager.Increment(ProfilerConstants.RpcOutQueueSize, (int)rpcQueueHistoryItem.TotalSize);
201201
}
202202
}
203203

‎com.unity.multiplayer.mlapi/Runtime/Messaging/RpcQueue/RpcQueueProcessor.cs‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ public void ProcessReceiveQueue(NetworkUpdateStage currentStage)
6262

6363
NetworkManager.InvokeRpc(currentQueueItem);
6464
ProfilerStatManager.RpcsQueueProc.Record();
65-
PerformanceDataManager.Increment(ProfilerConstants.NumberOfRPCQueueProcessed);
65+
PerformanceDataManager.Increment(ProfilerConstants.RpcQueueProcessed);
6666
currentQueueItem = currentFrame.GetNextQueueItem();
6767
}
6868

@@ -130,7 +130,7 @@ public void InternalMessagesSendAndFlush()
130130
InternalMessageSender.Send(clientId, NetworkConstants.ADD_OBJECT, queueItem.NetworkChannel, PoolStream);
131131
}
132132

133-
PerformanceDataManager.Increment(ProfilerConstants.NumberOfRPCsSent, queueItem.ClientNetworkIds.Length);
133+
PerformanceDataManager.Increment(ProfilerConstants.RpcSent, queueItem.ClientNetworkIds.Length);
134134
ProfilerStatManager.RpcsSent.Record(queueItem.ClientNetworkIds.Length);
135135
break;
136136
}
@@ -141,7 +141,7 @@ public void InternalMessagesSendAndFlush()
141141
InternalMessageSender.Send(clientId, NetworkConstants.DESTROY_OBJECT, queueItem.NetworkChannel, PoolStream);
142142
}
143143

144-
PerformanceDataManager.Increment(ProfilerConstants.NumberOfRPCsSent, queueItem.ClientNetworkIds.Length);
144+
PerformanceDataManager.Increment(ProfilerConstants.RpcSent, queueItem.ClientNetworkIds.Length);
145145
ProfilerStatManager.RpcsSent.Record(queueItem.ClientNetworkIds.Length);
146146
break;
147147
}
@@ -232,8 +232,8 @@ private void SendFrameQueueItem(RpcFrameQueueItem queueItem)
232232

233233
//For each packet sent, we want to record how much data we have sent
234234

235-
PerformanceDataManager.Increment(ProfilerConstants.NumberBytesSent, (int)queueItem.StreamSize);
236-
PerformanceDataManager.Increment(ProfilerConstants.NumberOfRPCsSent);
235+
PerformanceDataManager.Increment(ProfilerConstants.ByteSent, (int)queueItem.StreamSize);
236+
PerformanceDataManager.Increment(ProfilerConstants.RpcSent);
237237
ProfilerStatManager.BytesSent.Record((int)queueItem.StreamSize);
238238
ProfilerStatManager.RpcsSent.Record();
239239
break;
@@ -245,12 +245,12 @@ private void SendFrameQueueItem(RpcFrameQueueItem queueItem)
245245
NetworkManager.Singleton.NetworkConfig.NetworkTransport.Send(clientid, queueItem.MessageData, queueItem.NetworkChannel);
246246

247247
//For each packet sent, we want to record how much data we have sent
248-
PerformanceDataManager.Increment(ProfilerConstants.NumberBytesSent, (int)queueItem.StreamSize);
248+
PerformanceDataManager.Increment(ProfilerConstants.ByteSent, (int)queueItem.StreamSize);
249249
ProfilerStatManager.BytesSent.Record((int)queueItem.StreamSize);
250250
}
251251

252252
//For each client we send to, we want to record how many RPCs we have sent
253-
PerformanceDataManager.Increment(ProfilerConstants.NumberOfRPCsSent, queueItem.ClientNetworkIds.Length);
253+
PerformanceDataManager.Increment(ProfilerConstants.RpcSent, queueItem.ClientNetworkIds.Length);
254254
ProfilerStatManager.RpcsSent.Record(queueItem.ClientNetworkIds.Length);
255255

256256
break;

‎com.unity.multiplayer.mlapi/Runtime/Profiling/ProfilerConstants.cs‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@ public static class ProfilerConstants
55
public const string Connections = nameof(Connections);
66
public const string ReceiveTickRate = nameof(ReceiveTickRate);
77

8-
public const string NumberOfNamedMessages = nameof(NumberOfNamedMessages);
9-
public const string NumberOfUnnamedMessages = nameof(NumberOfUnnamedMessages);
10-
public const string NumberBytesSent = nameof(NumberBytesSent);
11-
public const string NumberBytesReceived = nameof(NumberBytesReceived);
12-
public const string NumberNetworkVarsReceived = nameof(NumberNetworkVarsReceived);
13-
public const string NumberOfRPCsSent = nameof(NumberOfRPCsSent);
14-
public const string NumberOfRPCsReceived = nameof(NumberOfRPCsReceived);
15-
public const string NumberOfRPCBatchesSent = nameof(NumberOfRPCBatchesSent);
16-
public const string NumberOfRPCBatchesReceived = nameof(NumberOfRPCBatchesReceived);
17-
public const string NumberOfRPCQueueProcessed = nameof(NumberOfRPCQueueProcessed);
18-
public const string NumberOfRPCsInQueueSize = nameof(NumberOfRPCsInQueueSize);
19-
public const string NumberOfRPCsOutQueueSize = nameof(NumberOfRPCsOutQueueSize);
8+
public const string NamedMessageReceived = nameof(NamedMessageReceived);
9+
public const string UnnamedMessageReceived = nameof(UnnamedMessageReceived);
10+
public const string ByteSent = nameof(ByteSent);
11+
public const string ByteReceived = nameof(ByteReceived);
12+
public const string NetworkVarReceived = nameof(NetworkVarReceived);
13+
public const string RpcSent = nameof(RpcSent);
14+
public const string RpcReceived = nameof(RpcReceived);
15+
public const string RpcBatchesSent = nameof(RpcBatchesSent);
16+
public const string RpcBatchesReceived = nameof(RpcBatchesReceived);
17+
public const string RpcQueueProcessed = nameof(RpcQueueProcessed);
18+
public const string RpcInQueueSize = nameof(RpcInQueueSize);
19+
public const string RpcOutQueueSize = nameof(RpcOutQueueSize);
2020
}
21-
}
21+
}

0 commit comments

Comments
 (0)