Skip to content

fix: Network Object ownership state machine #814

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

Draft
mriise wants to merge 2 commits into
base: developer
Choose a base branch
from
Draft

fix: Network Object ownership state machine #814

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f47a5b5
fix: Network Object ownership state machine
mriise May 8, 2026
5165507
chore: wording
mriise May 8, 2026
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
20 changes: 0 additions & 20 deletions Basis/Packages/com.basis.framework/Interactions/BasisPlayerInteract.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -717,26 +717,6 @@ public static void DrawAll()
}
}

public bool ForceSetInteracting(BasisInteractableObject interactableObject, BasisInput input)
{
if (input.TryGetRole(out BasisBoneTrackedRole role) && interactableObject.Inputs.ChangeStateByRole(role, BasisInteractInputState.Hovering))
{
for (int i = 0; i < InteractInputs.Length; i++)
{
if (InteractInputs[i].IsInput(input))
{
BasisDebug.Log("Stole ownership, starting interact", BasisDebug.LogTag.Networking);
interactableObject.OnInteractStart(input);
InteractInputs[i].lastTarget = interactableObject;
}
}

return true;
}

return false;
}

public static bool IsDesktopCenterEye(BasisInput input)
{
return BasisDeviceManagement.IsUserInDesktop() &&
Expand Down
166 changes: 129 additions & 37 deletions Basis/Packages/com.basis.framework/Networking/BasisNetworkBehaviour/BasisNetworkBehaviour.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,35 @@
using System;
using System.Collections;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using UnityEngine;
using static BasisNetworkCommon;

public enum NetworkOwnershipState
{
/// <summary>
/// Ownership state is unknown/uninitialized or server-owned.
/// </summary>
Unknown,
/// <summary>
/// Owned by a remote source.
/// </summary>
Remote,
/// <summary>
/// Ownership request sent, awaiting confirmation.
/// </summary>
PendingClaim,
/// <summary>
/// Owned locally.
/// </summary>
Local,
/// <summary>
/// Ownership release requested, awaiting confirmation.
/// </summary>
PendingRelease,
}

namespace Basis
{
public abstract class BasisNetworkBehaviour : BasisNetworkContentBase
Expand All @@ -19,16 +45,25 @@ public ushort NetworkID
get => networkID;
private set => networkID = value;
}
public NetworkOwnershipState OwnershipState = NetworkOwnershipState.Unknown;
/// <summary>
/// only set true when the server approves our ownership
/// True after server has confirmed ownership.
/// Equivalent to OwnershipState == Local.
/// </summary>
public bool IsOwnedLocallyOnServer = false;
public bool IsOwnedLocallyOnServer => OwnershipState == NetworkOwnershipState.Local;
/// <summary>
/// this is instantly set when we request ownership.
/// True from claim ownership start (PendingClaim) and
/// while the server agrees (Local).
/// </summary>
public bool IsOwnedLocallyOnClient = false;
public bool IsOwnedLocallyOnClient =>
OwnershipState == NetworkOwnershipState.Local
|| OwnershipState == NetworkOwnershipState.PendingClaim;

public ushort CurrentOwnerId;
public BasisNetworkPlayer currentOwnedPlayer;
private Task<BasisOwnershipResult> _pendingClaim;
private Task<BasisOwnershipResult> _pendingRelease;
private readonly CancellationTokenSource _destroyCts = new();

/// <summary>
/// the reason its start instead of awake is to make sure progation occurs to everything no matter the net connect
Expand All @@ -48,6 +83,7 @@ public virtual void Start()
}
public virtual void OnDestroy()
{
_destroyCts.Cancel();
if (HasNetworkID)
{
BasisNetworkGenericMessages.UnregisterHandler(NetworkID);
Expand Down Expand Up @@ -127,26 +163,36 @@ private void LowLevelOwnershipReleased(string uniqueEntityID)
}
private void LowLevelOwnershipTransfer(string uniqueEntityID, ushort NetIdNewOwner, bool isOwner)
{

if (uniqueEntityID == clientIdentifier)
if (uniqueEntityID != clientIdentifier) return;
Transition(isOwner ? NetworkOwnershipState.Local : NetworkOwnershipState.Remote);
CurrentOwnerId = NetIdNewOwner;
if (BasisNetworkPlayers.GetPlayerById(CurrentOwnerId, out currentOwnedPlayer))
{
IsOwnedLocallyOnServer = isOwner;
IsOwnedLocallyOnClient = isOwner;
CurrentOwnerId = NetIdNewOwner;
if (BasisNetworkPlayers.GetPlayerById(CurrentOwnerId, out currentOwnedPlayer))
{
OnOwnershipTransfer(currentOwnedPlayer);
}
else
{
BasisUnInitalizedPlayer UnInitalizedPlayer = new BasisUnInitalizedPlayer(CurrentOwnerId);
BasisDebug.LogError($"No Owner for Id {CurrentOwnerId} Creating Fake {nameof(BasisUnInitalizedPlayer)} this should only occur rarely");
UnInitalizedPlayer.Initialize();
OnOwnershipTransfer(UnInitalizedPlayer);
}
OnOwnershipTransfer(currentOwnedPlayer);
}
else
{
BasisUnInitalizedPlayer UnInitalizedPlayer = new BasisUnInitalizedPlayer(CurrentOwnerId);
BasisDebug.LogError($"No Owner for Id {CurrentOwnerId} Creating Fake {nameof(BasisUnInitalizedPlayer)} this should only occur rarely");
UnInitalizedPlayer.Initialize();
OnOwnershipTransfer(UnInitalizedPlayer);
}
}

private void Transition(NetworkOwnershipState newState)
{
if (OwnershipState == newState) return;
BasisDebug.Log($"[ownership] {clientIdentifier}: {OwnershipState} -> {newState}", BasisDebug.LogTag.Networking);
OwnershipState = newState;
OnOwnershipStateChanged();
}
/// <summary>
/// Called whenever <see cref="OwnershipState"/> changes (including optimistic
/// transitions and rollbacks on failed requests). Subclasses override to react
/// without depending on the server-driven <see cref="OnOwnershipTransfer"/>.
/// </summary>
protected virtual void OnOwnershipStateChanged() { }
/// <summary>
/// this is used for sending Network Messages
/// very much a data sync that can be used more like a traditional sync method
/// </summary>
Expand Down Expand Up @@ -276,32 +322,78 @@ private static string SiblingIndexIfNeeded(Transform t)
}
public async void TakeOwnership()
{
//no need to use await ownership will get back here from lower level.
await TakeOwnershipAsync();
await ClaimOwnership();
}
/// <summary>
/// actively takes ownership from another player
/// </summary>
/// <param name="Timout"></param>
/// <returns></returns>
public async Task<BasisOwnershipResult> TakeOwnershipAsync(int Timout = 5000)

public Task<BasisOwnershipResult> ClaimOwnership(int timeoutMs = 5000)
{
IsOwnedLocallyOnClient = true;
if (OwnershipState == NetworkOwnershipState.Local)
return Task.FromResult(new BasisOwnershipResult(true, BasisNetworkPlayer.LocalPlayer.playerId));
if (_pendingClaim != null)
return _pendingClaim;
return _pendingClaim = InternalClaim(timeoutMs);
}

private async Task<BasisOwnershipResult> InternalClaim(int timeoutMs)
{
var prev = OwnershipState;
Transition(NetworkOwnershipState.PendingClaim);
CurrentOwnerId = BasisNetworkPlayer.LocalPlayer.playerId;
currentOwnedPlayer = BasisNetworkPlayer.LocalPlayer;
BasisOwnershipResult Result = await BasisNetworkOwnership.TakeOwnershipAsync(clientIdentifier, BasisNetworkConnection.LocalPlayerPeer.RemoteId, Timout);
return Result;
try
{
var result = await BasisNetworkOwnership.TakeOwnershipAsync(
clientIdentifier,
BasisNetworkConnection.LocalPlayerPeer.RemoteId,
timeoutMs,
_destroyCts.Token);
// On failure, the server-driven OnOwnershipTransfer never fires, so revert
// the optimistic transition. Caller is responsible for any retry.
if (!result.Success && OwnershipState == NetworkOwnershipState.PendingClaim)
{
Transition(prev);
}
return result;
}
finally { _pendingClaim = null; }
}

public Task<BasisOwnershipResult> ReleaseOwnership(int timeoutMs = 5000)
{
if (OwnershipState == NetworkOwnershipState.Unknown || OwnershipState == NetworkOwnershipState.Remote)
return Task.FromResult(new BasisOwnershipResult(true, CurrentOwnerId));
if (_pendingRelease != null)
return _pendingRelease;
return _pendingRelease = InternalRelease(timeoutMs);
}

private async Task<BasisOwnershipResult> InternalRelease(int timeoutMs)
{
var prev = OwnershipState;
Transition(NetworkOwnershipState.PendingRelease);
try
{
var result = await BasisNetworkOwnership.RemoveOwnershipAsync(
clientIdentifier,
timeoutMs,
_destroyCts.Token);
if (!result.Success && OwnershipState == NetworkOwnershipState.PendingRelease)
{
Transition(prev);
}
return result;
}
finally { _pendingRelease = null; }
}

/// <summary>
/// requests who is the owner
/// Polls ownership state from the server. Triggers OnOwnershipTransfer.
/// </summary>
/// <param name="Timout"></param>
/// <returns></returns>
public async Task<BasisOwnershipResult> RequestWhoIsOwnershipAsync(int Timout = 5000)
public async Task<BasisOwnershipResult> PollOwnership(int timeoutMs = 5000)
{
BasisOwnershipResult Result = await BasisNetworkOwnership.RequestCurrentOwnershipAsync(clientIdentifier, Timout);
return Result;
return await BasisNetworkOwnership.RequestCurrentOwnershipAsync(clientIdentifier, timeoutMs, _destroyCts.Token);
}

public virtual void OnNetworkReady()
{

Expand Down
28 changes: 14 additions & 14 deletions Basis/Packages/com.basis.framework/Networking/BasisNetworkOwnership.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@

public static partial class BasisNetworkOwnership
{
public static async Task<BasisOwnershipResult> RemoveOwnershipAsync(string UniqueNetworkId, int timeoutMs = 5000)
public static async Task<BasisOwnershipResult> RemoveOwnershipAsync(string UniqueNetworkId, int timeoutMs = 5000, CancellationToken externalToken = default)
{
var tcs = new TaskCompletionSource<BasisOwnershipResult>();
using var cancellationTokenSource = new CancellationTokenSource();
using var cts = CancellationTokenSource.CreateLinkedTokenSource(externalToken);

void OnOwnershipTransferred(string ownershipID, ushort playerID, bool isLocalOwner)
{
Expand All @@ -24,7 +24,7 @@ void OnOwnershipTransferred(string ownershipID, ushort playerID, bool isLocalOwn
}
}

cancellationTokenSource.Token.Register(() =>
cts.Token.Register(() =>
{
BasisNetworkPlayer.OnOwnershipTransfer -= OnOwnershipTransferred;
tcs.TrySetResult(BasisOwnershipResult.Failed);
Expand Down Expand Up @@ -56,17 +56,17 @@ void OnOwnershipTransferred(string ownershipID, ushort playerID, bool isLocalOwn
return BasisOwnershipResult.Failed;
}

cancellationTokenSource.CancelAfter(timeoutMs);
cts.CancelAfter(timeoutMs);
return await tcs.Task;
}
public static async Task<BasisOwnershipResult> TakeOwnershipAsync(string UniqueNetworkId, int NewOwner, int timeoutMs = 5000)
public static async Task<BasisOwnershipResult> TakeOwnershipAsync(string UniqueNetworkId, int NewOwner, int timeoutMs = 5000, CancellationToken externalToken = default)
{
return await TakeOwnershipAsync(UniqueNetworkId, (ushort)NewOwner, timeoutMs);
return await TakeOwnershipAsync(UniqueNetworkId, (ushort)NewOwner, timeoutMs, externalToken);
}
public static async Task<BasisOwnershipResult> TakeOwnershipAsync(string UniqueNetworkId, ushort NewOwner, int timeoutMs = 5000)
public static async Task<BasisOwnershipResult> TakeOwnershipAsync(string UniqueNetworkId, ushort NewOwner, int timeoutMs = 5000, CancellationToken externalToken = default)
{
var tcs = new TaskCompletionSource<BasisOwnershipResult>();
using var cancellationTokenSource = new CancellationTokenSource();
using var cts = CancellationTokenSource.CreateLinkedTokenSource(externalToken);

void OnOwnershipTransferred(string ownershipID, ushort playerID, bool isLocalOwner)
{
Expand All @@ -77,7 +77,7 @@ void OnOwnershipTransferred(string ownershipID, ushort playerID, bool isLocalOwn
}
}

cancellationTokenSource.Token.Register(() =>
cts.Token.Register(() =>
{
BasisNetworkPlayer.OnOwnershipTransfer -= OnOwnershipTransferred;
tcs.TrySetResult(BasisOwnershipResult.Failed);
Expand Down Expand Up @@ -109,7 +109,7 @@ void OnOwnershipTransferred(string ownershipID, ushort playerID, bool isLocalOwn
return BasisOwnershipResult.Failed;
}

cancellationTokenSource.CancelAfter(timeoutMs);
cts.CancelAfter(timeoutMs);
return await tcs.Task;
}
/// <summary>
Expand All @@ -127,7 +127,7 @@ public static bool IsOwnerLocalValidation(string OwnershipId)
}
return false;
}
public static async Task<BasisOwnershipResult> RequestCurrentOwnershipAsync(string UniqueNetworkId, int timeoutMs = 5000)
public static async Task<BasisOwnershipResult> RequestCurrentOwnershipAsync(string UniqueNetworkId, int timeoutMs = 5000, CancellationToken externalToken = default)
{
if (BasisNetworkPlayers.OwnershipPairing.TryGetValue(UniqueNetworkId, out ushort Unique))
{
Expand All @@ -141,7 +141,7 @@ public static async Task<BasisOwnershipResult> RequestCurrentOwnershipAsync(stri
}

var tcs = new TaskCompletionSource<BasisOwnershipResult>();
using var cancellationTokenSource = new CancellationTokenSource();
using var cts = CancellationTokenSource.CreateLinkedTokenSource(externalToken);

void OnOwnershipTransferred(string ownershipID, ushort playerID, bool isLocalOwner)
{
Expand All @@ -152,7 +152,7 @@ void OnOwnershipTransferred(string ownershipID, ushort playerID, bool isLocalOwn
}
}

cancellationTokenSource.Token.Register(() =>
cts.Token.Register(() =>
{
BasisNetworkPlayer.OnOwnershipTransfer -= OnOwnershipTransferred;
tcs.TrySetResult(BasisOwnershipResult.Failed);
Expand Down Expand Up @@ -184,7 +184,7 @@ void OnOwnershipTransferred(string ownershipID, ushort playerID, bool isLocalOwn
return BasisOwnershipResult.Failed;
}

cancellationTokenSource.CancelAfter(timeoutMs);
cts.CancelAfter(timeoutMs);
return await tcs.Task;
}
}
Loading
Loading