mirror of
https://github.com/ppy/osu.git
synced 2024-11-13 16:47:46 +08:00
Add extended xmldoc to DisconnectRequested()
Just expounds on what the previous commit message said.
This commit is contained in:
parent
b4aa247032
commit
1049be7d72
@ -13,6 +13,18 @@ namespace osu.Game.Online
|
||||
/// </summary>
|
||||
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();
|
||||
}
|
||||
}
|
||||
|
Loading…
Reference in New Issue
Block a user