Skip to content

[MTT-14843] Refactor sending and receiving of N4E RPCs in UnifiedNetcodeTransport to not use entities #3943

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ShadauxCat wants to merge 1 commit into
base: experimental/v3-x-x/unified
Choose a base branch
from
+65 −63
Open

[MTT-14843] Refactor sending and receiving of N4E RPCs in UnifiedNetcodeTransport to not use entities #3943

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion com.unity.netcode.gameobjects/Runtime/Core/NetworkManager.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -472,9 +472,10 @@ public void NetworkUpdate(NetworkUpdateStage updateStage)

// This should be invoked just prior to the MessageManager processes its outbound queue.
SceneManager.CheckForAndSendNetworkObjectSceneChanged();

#if !UNIFIED_NETCODE
// Process outbound messages
MessageManager.ProcessSendQueues();
Copy link
Copy Markdown
Member

@EmandM EmandM Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmmm, should we be also checking the transport here? Are we allowing users to still use UnityTransport as normal? Or are you forced into the UnifiedTransport?

#endif

// Metrics update needs to be driven by NetworkConnectionManager's update to assure metrics are dispatched after the send queue is processed.
MetricsManager.UpdateMetrics();
Expand Down
125 changes: 63 additions & 62 deletions com.unity.netcode.gameobjects/Runtime/Transports/Unified/UnifiedNetcodeTransport.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,37 +43,41 @@ public static NativeArray<byte> ToNativeArray(in FixedBytes1280 data)
}
}

internal struct TransportRpcData : IBufferElementData
{
public FixedBytes1280 Buffer;
}

[BurstCompile]
internal struct TransportRpc : IOutOfBandRpcCommand, IRpcCommandSerializer<TransportRpc>
{
public FixedBytes1280 Buffer;
public ulong Order;
public TransportRpcData Value;

public unsafe void Serialize(ref DataStreamWriter writer, in RpcSerializerState state, in TransportRpc data)
{
writer.WriteULong(data.Order);
writer.WriteInt(data.Buffer.Length);
var span = new Span<byte>(FixedBytes1280.GetUnsafePtr(data.Buffer), data.Buffer.Length);
writer.WriteInt(data.Value.Buffer.Length);
var span = new Span<byte>(FixedBytes1280.GetUnsafePtr(data.Value.Buffer), data.Value.Buffer.Length);
writer.WriteBytes(span);
}

public unsafe void Deserialize(ref DataStreamReader reader, in RpcDeserializerState state, ref TransportRpc data)
{
data.Order = reader.ReadULong();
var length = reader.ReadInt();
data.Buffer = new FixedBytes1280
data.Value.Buffer = new FixedBytes1280
{
Length = length
};

var span = new Span<byte>(FixedBytes1280.GetUnsafePtr(data.Buffer), length);
var span = new Span<byte>(FixedBytes1280.GetUnsafePtr(data.Value.Buffer), length);
reader.ReadBytes(span);
}

[BurstCompile(DisableDirectCall = true)]
private static void InvokeExecute(ref RpcExecutor.Parameters parameters)
{
RpcExecutor.ExecuteCreateRequestComponent<TransportRpc, TransportRpc>(ref parameters);
var element = new TransportRpc();
element.Deserialize(ref parameters.Reader, parameters.DeserializerState, ref element);
parameters.CommandBuffer.AppendToBuffer(parameters.JobIndex, parameters.Connection, element.Value);
}

private static readonly PortableFunctionPointer<RpcExecutor.ExecuteDelegate> k_InvokeExecuteFunctionPointer = new PortableFunctionPointer<RpcExecutor.ExecuteDelegate>(InvokeExecute);
Expand Down Expand Up @@ -115,33 +119,59 @@ public void OnUpdate(ref SystemState state)
}
}

[WorldSystemFilter(WorldSystemFilterFlags.ServerSimulation | WorldSystemFilterFlags.ClientSimulation | WorldSystemFilterFlags.ThinClientSimulation)]
[UpdateInGroup(typeof(SimulationSystemGroup), OrderLast = true)]
[UpdateBefore(typeof(RpcSystem))]
internal partial class UnifiedNetcodeUpdateSystem : SystemBase
{
public void OnCreate(ref SystemState state)
{
state.RequireForUpdate<RpcCollection>();
state.RequireForUpdate<NetworkId>();
}

public UnifiedNetcodeTransport Transport;
public NetworkManager NetworkManager;

public List<Connection> DisconnectQueue = new List<Connection>();

public void Disconnect(Connection connection)
{
DisconnectQueue.Add(connection);
}

public void SendRpc(TransportRpc rpc)
{
var rpcQueue = SystemAPI.GetSingleton<RpcCollection>().GetRpcQueue<TransportRpc, TransportRpc>();
var ghostInstance = GetComponentLookup<GhostInstance>();
foreach (var rpcDataStreamBuffer in SystemAPI.Query<DynamicBuffer<OutgoingRpcDataStreamBuffer>>())
{
rpcQueue.Schedule(rpcDataStreamBuffer, ghostInstance, rpc);
}
}

protected override void OnUpdate()
{
NetworkManager.MessageManager.ProcessSendQueues();

using var commandBuffer = new EntityCommandBuffer(Allocator.Temp);
foreach (var (request, rpc, entity) in SystemAPI.Query<RefRO<ReceiveRpcCommandRequest>, RefRO<TransportRpc>>().WithEntityAccess())
foreach(var (networkId, _, entity) in SystemAPI.Query<RefRO<NetworkId>, RefRO<NetworkStreamConnection>>().WithEntityAccess())
{
var connectionId = SystemAPI.GetComponent<NetworkId>(request.ValueRO.SourceConnection).Value;

var buffer = rpc.ValueRO.Buffer;
try
var connectionId = networkId.ValueRO.Value;
DynamicBuffer<TransportRpcData> rpcs = EntityManager.GetBuffer<TransportRpcData>(entity);
foreach (var rpc in rpcs)
{
Transport.DispatchMessage(connectionId, buffer, rpc.ValueRO.Order);
}
finally
{
commandBuffer.DestroyEntity(entity);
var buffer = rpc.Buffer;
try
{
Transport.DispatchMessage(connectionId, buffer);
}
catch(Exception e)
{
Debug.LogException(e);
}
}
rpcs.Clear();
}

foreach (var connection in DisconnectQueue)
Expand Down Expand Up @@ -171,34 +201,15 @@ private class ConnectionInfo
public BatchedSendQueue SendQueue;
public BatchedReceiveQueue ReceiveQueue;
public Connection Connection;
public ulong LastSent;
public ulong LastReceived;
public Dictionary<ulong, FixedBytes1280> DeferredMessages;
}

private Dictionary<int, ConnectionInfo> m_Connections;

internal void DispatchMessage(int connectionId, in FixedBytes1280 buffer, ulong order)
internal void DispatchMessage(int connectionId, in FixedBytes1280 buffer)
{
var connectionInfo = m_Connections[connectionId];

if (order <= connectionInfo.LastReceived)
{
Debug.LogWarning("Received duplicate message, ignoring.");
return;
}

if (order != connectionInfo.LastReceived + 1)
{
if (connectionInfo.DeferredMessages == null)
{
connectionInfo.DeferredMessages = new Dictionary<ulong, FixedBytes1280>();
}

connectionInfo.DeferredMessages[order] = buffer;
return;
}

using var arr = FixedBytes1280.ToNativeArray(buffer);
var reader = new DataStreamReader(arr);
if (connectionInfo.ReceiveQueue == null)
Expand All @@ -209,20 +220,7 @@ internal void DispatchMessage(int connectionId, in FixedBytes1280 buffer, ulong
{
connectionInfo.ReceiveQueue.PushReader(reader);
}

connectionInfo.LastReceived = order;
if (connectionInfo.DeferredMessages != null)
{
var next = order + 1;
while (connectionInfo.DeferredMessages.Remove(next, out var nextBuffer))
{
reader = new DataStreamReader(FixedBytes1280.ToNativeArray(nextBuffer));
connectionInfo.ReceiveQueue.PushReader(reader);
connectionInfo.LastReceived = next;
++next;
}
}


var message = connectionInfo.ReceiveQueue.PopMessage();
while (message.Count != 0)
{
Expand All @@ -243,18 +241,15 @@ public override unsafe void Send(ulong clientId, ArraySegment<byte> payload, Net

while (!connectionInfo.SendQueue.IsEmpty)
{
var rpc = new TransportRpc
{
Buffer = new FixedBytes1280(),
};
var rpc = new TransportRpc();

var writer = new DataStreamWriter(FixedBytes1280.GetUnsafePtr(rpc.Buffer), k_MaxPacketSize);
var writer = new DataStreamWriter(FixedBytes1280.GetUnsafePtr(rpc.Value.Buffer), k_MaxPacketSize);

var amount = connectionInfo.SendQueue.FillWriterWithBytes(ref writer, k_MaxPacketSize);
rpc.Buffer.Length = amount;
rpc.Order = ++connectionInfo.LastSent;

connectionInfo.Connection.SendOutOfBandMessage(rpc);
rpc.Value.Buffer.Length = amount;

var updateSystem = NetCode.Netcode.GetWorld(false).GetExistingSystemManaged<UnifiedNetcodeUpdateSystem>();
updateSystem.SendRpc(rpc);

connectionInfo.SendQueue.Consume(amount);
}
Expand All @@ -278,6 +273,8 @@ private void OnClientConnectedToServer(Connection connection, NetCodeConnectionE
};
m_ServerClientId = connection.NetworkId.Value;
InvokeOnTransportEvent(NetworkEvent.Connect, (ulong)connection.NetworkId.Value, default, m_RealTimeProvider.RealTimeSinceStartup);
var updateSystem = NetCode.Netcode.GetWorld(false).GetExistingSystemManaged<UnifiedNetcodeUpdateSystem>();
updateSystem.EntityManager.AddBuffer<TransportRpcData>(connection.ConnectionEntity);
}

private void OnServerNewClientConnection(Connection connection, NetCodeConnectionEvent connectionEvent)
Expand All @@ -289,6 +286,8 @@ private void OnServerNewClientConnection(Connection connection, NetCodeConnectio
Connection = connection
}; ;
InvokeOnTransportEvent(NetworkEvent.Connect, (ulong)connection.NetworkId.Value, default, m_RealTimeProvider.RealTimeSinceStartup);
var updateSystem = NetCode.Netcode.GetWorld(false).GetExistingSystemManaged<UnifiedNetcodeUpdateSystem>();
updateSystem.EntityManager.AddBuffer<TransportRpcData>(connection.ConnectionEntity);
}

private const string k_InvalidRpcMessage = "An invalid RPC was received";
Expand Down Expand Up @@ -376,6 +375,7 @@ public override bool StartClient()
NetCode.Netcode.Client.OnDisconnect = OnClientDisconnectFromServer;
var updateSystem = NetCode.Netcode.GetWorld(false).GetExistingSystemManaged<UnifiedNetcodeUpdateSystem>();
updateSystem.Transport = this;
updateSystem.NetworkManager = m_NetworkManager;
return true;
}

Expand All @@ -390,6 +390,7 @@ public override bool StartServer()
NetCode.Netcode.Server.OnDisconnect = OnServerClientDisconnected;
var updateSystem = NetCode.Netcode.GetWorld(true).GetExistingSystemManaged<UnifiedNetcodeUpdateSystem>();
updateSystem.Transport = this;
updateSystem.NetworkManager = m_NetworkManager;
return true;
}

Expand Down