RepoMirrors/osu
1
0
Fork 0
mirror of https://github.com/ppy/osu synced 2025-01-21 21:33:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add xmldoc notes about thread safety of api bindables

Browse Source
This commit is contained in:
Dean Herbert 2020-10-22 14:56:20 +09:00
parent 5a00a05a95
commit c6db832efa
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
osu.Game/Online/API/IAPIProvider.cs
View File

@ -11,11 +11,13 @@ namespace osu.Game.Online.API
{ {
/// <summary> /// <summary>
/// The local user. /// The local user.
/// This is not thread-safe and should be scheduled locally if consumed from a drawable component.
/// </summary> /// </summary>
Bindable<User> LocalUser { get; } Bindable<User> LocalUser { get; }
/// <summary> /// <summary>
/// The current user's activity. /// The current user's activity.
/// This is not thread-safe and should be scheduled locally if consumed from a drawable component.
/// </summary> /// </summary>
Bindable<UserActivity> Activity { get; } Bindable<UserActivity> Activity { get; }
@ -35,6 +37,10 @@ namespace osu.Game.Online.API
/// </summary> /// </summary>
string Endpoint { get; } string Endpoint { get; }
/// <summary>
/// The current connection state of the API.
/// This is not thread-safe and should be scheduled locally if consumed from a drawable component.
/// </summary>
IBindable<APIState> State { get; } IBindable<APIState> State { get; }
/// <summary> /// <summary>