diff --git a/Directory.Build.props b/Directory.Build.props index 114bea2a..e06af334 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -14,7 +14,7 @@ MIT © Meta Vens and contributors true - 1.0.23 + 1.0.24 true diff --git a/src/GameCult.Networking/CultNetDatabaseSubscriptionServer.cs b/src/GameCult.Networking/CultNetDatabaseSubscriptionServer.cs index 618f64df..75028899 100644 --- a/src/GameCult.Networking/CultNetDatabaseSubscriptionServer.cs +++ b/src/GameCult.Networking/CultNetDatabaseSubscriptionServer.cs @@ -20,6 +20,7 @@ namespace GameCult.Networking private readonly CultNetDatabase _database; private readonly Func _subscribe; private readonly Func _unsubscribe; + private readonly ICultNetSchemaServerPeerLifecycle? _peerLifecycle; private readonly ConcurrentDictionary _subscriptions = new ConcurrentDictionary(SubscriptionKeyComparer.Instance); private readonly ConcurrentDictionary _requests = @@ -35,6 +36,9 @@ namespace GameCult.Networking _unsubscribe = HandleUnsubscribeAsync; _server.OnCultNet(_subscribe); _server.OnCultNet(_unsubscribe); + _peerLifecycle = server as ICultNetSchemaServerPeerLifecycle; + if (_peerLifecycle != null) + _peerLifecycle.PeerDisconnected += HandlePeerDisconnected; } /// Raised when exact document subscriptions add or remove typed hot-body demand. @@ -47,6 +51,8 @@ namespace GameCult.Networking _disposed = true; _server.RemoveCultNetMessageListener(_subscribe); _server.RemoveCultNetMessageListener(_unsubscribe); + if (_peerLifecycle != null) + _peerLifecycle.PeerDisconnected -= HandlePeerDisconnected; foreach (var entry in _subscriptions) { entry.Value.Dispose(); @@ -57,6 +63,18 @@ namespace GameCult.Networking _requests.Clear(); } + private void HandlePeerDisconnected(ICultNetSchemaServerPeer peer) + { + foreach (var key in _subscriptions.Keys.Where(candidate => + SubscriptionKeyComparer.SamePeer(candidate.Peer, peer)).ToArray()) + { + if (_subscriptions.TryRemove(key, out var subscription)) + subscription.Dispose(); + if (_requests.TryRemove(key, out var request)) + PublishDemand(request, key, active: false); + } + } + private Task HandleSubscribeAsync(CultNetDatabaseSubscribeMessage request, ICultNetSchemaServerPeer peer) { var subscriptionId = string.IsNullOrWhiteSpace(request.SubscriptionId) @@ -245,7 +263,7 @@ namespace GameCult.Networking public int GetHashCode(SubscriptionKey value) => (PeerHash(value.Peer) * 397) ^ StringComparer.Ordinal.GetHashCode(value.Id); - private static bool SamePeer(ICultNetSchemaServerPeer left, ICultNetSchemaServerPeer right) + internal static bool SamePeer(ICultNetSchemaServerPeer left, ICultNetSchemaServerPeer right) { if (ReferenceEquals(left, right)) return true; if (left is RudpCultNetSchemaServerPeer leftRudp && right is RudpCultNetSchemaServerPeer rightRudp) diff --git a/src/GameCult.Networking/CultNetRudpSchemaServer.cs b/src/GameCult.Networking/CultNetRudpSchemaServer.cs index e6236943..bd8d96cd 100644 --- a/src/GameCult.Networking/CultNetRudpSchemaServer.cs +++ b/src/GameCult.Networking/CultNetRudpSchemaServer.cs @@ -104,7 +104,7 @@ namespace GameCult.Networking /// /// Multi-peer schema-v0 host over the native CultNet RUDP transport. /// - public sealed class RudpCultNetSchemaServer : ICultNetSchemaServer, IDisposable + public sealed class RudpCultNetSchemaServer : ICultNetSchemaServer, ICultNetSchemaServerPeerLifecycle, IDisposable { private readonly Socket _socket; private readonly CultNetRudpSocketTransportServer _transport; @@ -138,6 +138,7 @@ namespace GameCult.Networking MaxPendingReliablePackets = options.MaxPendingReliablePackets, AcceptPayload = options.AcceptPayload }); + _transport.PeerDisconnected += OnTransportPeerDisconnected; } /// @@ -160,6 +161,9 @@ namespace GameCult.Networking /// public IReadOnlyCollection Peers => _transport.Peers; + /// + public event Action? PeerDisconnected; + /// /// Registers a schema-v0 handler. /// @@ -302,7 +306,13 @@ namespace GameCult.Networking } _disposed = true; + _transport.PeerDisconnected -= OnTransportPeerDisconnected; _transport.Dispose(); } + + private void OnTransportPeerDisconnected(CultNetRudpSocketServerPeer peer) + { + PeerDisconnected?.Invoke(new RudpCultNetSchemaServerPeer(this, peer)); + } } } diff --git a/src/GameCult.Networking/CultNetSchemaServerPort.cs b/src/GameCult.Networking/CultNetSchemaServerPort.cs index 58ab2fdc..4d660071 100644 --- a/src/GameCult.Networking/CultNetSchemaServerPort.cs +++ b/src/GameCult.Networking/CultNetSchemaServerPort.cs @@ -32,4 +32,15 @@ namespace GameCult.Networking void RemoveCultNetMessageListener(Delegate callback) where TMessage : ICultNetSchemaMessage; } + + /// + /// Optional transport-neutral peer lifetime surface for stateful service bridges. + /// + public interface ICultNetSchemaServerPeerLifecycle + { + /// + /// Raised after a peer session is no longer able to receive service output. + /// + event Action PeerDisconnected; + } } diff --git a/src/GameCult.Networking/CultNetTransport.cs b/src/GameCult.Networking/CultNetTransport.cs index 8bdf020a..de4b15e2 100644 --- a/src/GameCult.Networking/CultNetTransport.cs +++ b/src/GameCult.Networking/CultNetTransport.cs @@ -2199,6 +2199,11 @@ namespace GameCult.Networking /// public IReadOnlyCollection Peers => _peers.Values.ToArray(); + /// + /// Raised when a tracked peer closes its RUDP session. + /// + public event Action? PeerDisconnected; + /// /// Gets a snapshot of the current transfer counters. /// @@ -2339,6 +2344,7 @@ namespace GameCult.Networking { existingPeer.DisconnectReason = result.DisconnectReason; _peers.Remove(peerKey); + PeerDisconnected?.Invoke(existingPeer); return true; } diff --git a/src/GameCult.Networking/Server.cs b/src/GameCult.Networking/Server.cs index 4400c95d..4d468f7e 100644 --- a/src/GameCult.Networking/Server.cs +++ b/src/GameCult.Networking/Server.cs @@ -17,7 +17,7 @@ namespace GameCult.Networking /// /// Hosts the server-side authentication, session, and message dispatch pipeline. /// - public class Server : ICultNetSchemaServer, IDisposable + public class Server : ICultNetSchemaServer, ICultNetSchemaServerPeerLifecycle, IDisposable { private const string EmailPattern = @"^([0-9a-zA-Z]([\+\-_\.][0-9a-zA-Z]+)*)+@(([0-9a-zA-Z][-\w]*[0-9a-zA-Z]*\.)+[a-zA-Z0-9]{2,17})$"; @@ -45,6 +45,9 @@ namespace GameCult.Networking private ILogger _logger = new NullLogger(); private bool _disposed; + /// + public event Action? PeerDisconnected; + /// /// Gets or sets the logger used by the server. /// @@ -378,7 +381,9 @@ namespace GameCult.Networking listener.PeerDisconnectedEvent += (peer, info) => { Logger.LogInfo($"User Disconnected: {peer.Address}"); + var context = GetPeerContext(peer); _users.TryRemove(peer.Id, out _); + PeerDisconnected?.Invoke(context); }; listener.NetworkLatencyUpdateEvent += (peer, latency) => diff --git a/tests/GameCult.Networking.Tests/NetworkingTests.cs b/tests/GameCult.Networking.Tests/NetworkingTests.cs index 30162445..e3da6029 100644 --- a/tests/GameCult.Networking.Tests/NetworkingTests.cs +++ b/tests/GameCult.Networking.Tests/NetworkingTests.cs @@ -1524,6 +1524,59 @@ namespace GameCult.Networking.Tests Assert.That(removed.Active, Is.False); } + [Test] + public async Task DatabaseSubscriptionServer_WithdrawsDemandWhenPeerDisconnects() + { + var database = new CultNetDatabase(new CultCache()); + using var server = new RudpCultNetSchemaServer(new RudpCultNetSchemaServerOptions + { + RuntimeId = "database-disconnect-demand-server", + Socket = BindUdpSocket() + }); + using var subscriptions = new CultNetDatabaseSubscriptionServer(server, database); + var active = new TaskCompletionSource( + TaskCreationOptions.RunContinuationsAsynchronously); + var withdrawn = new TaskCompletionSource( + TaskCreationOptions.RunContinuationsAsynchronously); + subscriptions.DemandChanged += demand => + { + if (demand.Active) active.TrySetResult(demand); + else withdrawn.TrySetResult(demand); + }; + using var cancellation = new CancellationTokenSource(); + var serverThread = new Thread(() => + { + while (!cancellation.IsCancellationRequested) + { + _ = server.PollOnceAsync().GetAwaiter().GetResult(); + Thread.Sleep(1); + } + }) { IsBackground = true }; + serverThread.Start(); + + using var client = CultNetSchemaClients.CreateRudp("database-disconnect-demand-client"); + client.Connect("127.0.0.1", server.LocalEndPoint.Port); + await WaitUntilAsync(() => client.Connected, TimeSpan.FromSeconds(2)); + client.SendCultNet(new CultNetDatabaseSubscribeMessage + { + MessageId = "subscribe-disconnect-body", + SubscriptionId = "disconnect-world-body", + ConsumerRuntimeId = "eve-unity", + BodyIds = ["world"], + SupportedBodyTransports = ["SharedMemory"], + IncludeSnapshot = false + }); + await AwaitWithTimeout(active.Task, TimeSpan.FromSeconds(2)); + + client.Dispose(); + var removed = await AwaitWithTimeout(withdrawn.Task, TimeSpan.FromSeconds(2)); + await WaitUntilAsync(() => server.Peers.Count == 0, TimeSpan.FromSeconds(2)); + cancellation.Cancel(); + + Assert.That(removed.SubscriptionId, Is.EqualTo("disconnect-world-body")); + Assert.That(removed.Active, Is.False); + } + [Test] public async Task DatabaseSubscriptionClient_ReplicatesInitialAndLiveTypedDocumentsOverRudp() { diff --git a/unity/org.gamecult.cultlib/README.md b/unity/org.gamecult.cultlib/README.md index 28c73612..74ecc835 100644 --- a/unity/org.gamecult.cultlib/README.md +++ b/unity/org.gamecult.cultlib/README.md @@ -7,8 +7,8 @@ CultCache, CultNet, and CultMesh assemblies consumed through NuGet by normal Build it with `scripts/build-unity-package.ps1`. Do not edit generated plugin assemblies in the package output. -Install version `1.0.23` through Unity Package Manager with: +Install version `1.0.24` through Unity Package Manager with: ```text -https://github.com/GameCult/CultLib.git?path=/unity/org.gamecult.cultlib#cultlib-unity-v1.0.23 +https://github.com/GameCult/CultLib.git?path=/unity/org.gamecult.cultlib#cultlib-unity-v1.0.24 ``` diff --git a/unity/org.gamecult.cultlib/package.json b/unity/org.gamecult.cultlib/package.json index 3e6da006..40cd7c06 100644 --- a/unity/org.gamecult.cultlib/package.json +++ b/unity/org.gamecult.cultlib/package.json @@ -1,7 +1,7 @@ { "name": "org.gamecult.cultlib", "displayName": "CultLib", - "version": "1.0.23", + "version": "1.0.24", "unity": "2021.3", "description": "CultCache, CultNet, and CultMesh managed runtime assemblies for Unity.", "license": "MIT",