h1or4dme8/osu-lazer
1
0
Fork 0
mirror of https://github.com/ppy/osu.git synced 2025-01-12 17:35:10 +08:00
Code Issues Releases Wiki Activity

Add extended xmldoc to DisconnectRequested()

Browse Source 
Just expounds on what the previous commit message said.
This commit is contained in:
Bartłomiej Dach 2024-02-16 13:06:58 +01:00
parent b4aa247032
commit 1049be7d72
No known key found for this signature in database
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
osu.Game/Online/IStatefulUserHubClient.cs
View File

@ -13,6 +13,18 @@ namespace osu.Game.Online
/// </summary> /// </summary>
public interface IStatefulUserHubClient public interface IStatefulUserHubClient
{ {
/// <summary>
/// Invoked when the server requests a client to disconnect.
/// </summary>
/// <remarks>
/// When this request is received, the client must presume any and all further requests to the server
/// will either fail or be ignored.
/// This method is ONLY to be used for the purposes of:
/// <list type="bullet">
/// <item>actually physically disconnecting from the server,</item>
/// <item>cleaning up / setting up any and all required local client state.</item>
/// </list>
/// </remarks>
Task DisconnectRequested(); Task DisconnectRequested();
} }
} }