LcuWebsocket rework

This commit is contained in:
SacredFloof committed 2026-11-15 12:27:36 +01:00
1 parent 383f05dfdc
commit 07ac3f5cfd
6 files changed
+166 -56

No files matched your search

+17 -6
View File
@@ -1,9 +1,8 @@
using System.Net.WebSockets; using System.Net.WebSockets;
using System.Runtime.CompilerServices;
namespace LeagueAPI; namespace LeagueAPI;
public record WebsocketMessageResult(byte[] Message, WebSocketMessageType MessageType); public readonly record struct WebsocketMessageResult(byte[] Message, WebSocketMessageType MessageType);
public static class Extensions public static class Extensions
{ {
@@ -18,7 +17,7 @@ public static class Extensions
return i; return i;
} }
public string AsFormatWith(params object?[] args) public string FormatWith(params object?[] args)
{ {
if (s is null) if (s is null)
{ {
@@ -26,6 +25,15 @@ public static class Extensions
} }
return string.Format(s, args); return string.Format(s, args);
} }
public string GetLcuEventName()
{
if (s is null)
{
return string.Empty;
}
return $"OnJsonApiEvent{s.Replace('/', '_')}";
}
} }
extension<TSource>(IEnumerable<TSource?> source) extension<TSource>(IEnumerable<TSource?> source)
@@ -80,8 +88,12 @@ public static class Extensions
do do
{ {
Memory<byte> memoryBuffer = new(buffer); receiveResult = await socket.ReceiveAsync(buffer.AsMemory(), cancellationToken);
receiveResult = await socket.ReceiveAsync(memoryBuffer, cancellationToken);
if (receiveResult.MessageType is WebSocketMessageType.Close)
{
break;
}
memoryStream.Write(buffer, 0, receiveResult.Count); memoryStream.Write(buffer, 0, receiveResult.Count);
} }
@@ -96,5 +108,4 @@ public static class Extensions
return new(fullMessageBytes, receiveResult.MessageType); return new(fullMessageBytes, receiveResult.MessageType);
} }
} }
} }
+16
View File
@@ -0,0 +1,16 @@
using System.Text.Json;
using System.Text.Json.Serialization;
namespace LeagueAPI;
public readonly record struct LcuApiEvent
{
[JsonPropertyName("data")]
public JsonElement Data { get; init; }
[JsonPropertyName("eventType")]
public required string EventType { get; init; }
[JsonPropertyName("uri")]
public required string Uri { get; init; }
}
+28
View File
@@ -0,0 +1,28 @@
namespace LeagueAPI;
public static class LcuRoutes
{
public static class Matchmaking
{
public const string READY_CHECK_URL = "/lol-matchmaking/v1/ready-check";
}
public static class ChampSelect
{
public const string ALL_GRID_CHAMPIONS_URL = "/lol-champ-select/v1/all-grid-champions";
public const string BANNABLE_CHAPIONIDS_URL = "/lol-champ-select/v1/bannable-champion-ids";
public const string CURRENT_CHAMPION_URL = "/lol-champ-select/v1/current-champion";
public const string DISABLED_CHAMPION_IDS_URL = "/lol-champ-select/v1/disabled-champion-ids";
public const string GRID_CHAMPIONS_URL = "/lol-champ-select/v1/grid-champions";
public const string MUTED_PLAYERS_URL = "/lol-champ-select/v1/muted-players";
public const string ONGOING_CHAMPION_SWAP_URL = "/lol-champ-select/v1/ongoing-champion-swap";
public const string PICKABLE_CHAMPION_IDS_URL = "/lol-champ-select/v1/pickable-champion-ids";
public const string PIN_DROP_NOTIFICATION_URL = "/lol-champ-select/v1/pin-drop-notification";
public const string SESSION_URL = "/lol-champ-select/v1/session";
public const string SFX_NOTIFICATIONS_URL = "/lol-champ-select/v1/sfx-notifications";
public const string SKIN_CAROUSEL_SKINS_URL = "/lol-champ-select/v1/skin-carousel-skins";
public const string SKIN_SELECTOR_INFO_URL = "/lol-champ-select/v1/skin-selector-info";
public const string SUMMONERS_URL = "/lol-champ-select/v1/summoners";
public const string TEAM_BOOST_URL = "/lol-champ-select/v1/team-boost";
}
}
+103 -32
View File
@@ -11,22 +11,22 @@ public class LcuWebsocket : IDisposable
private const int OPCODE_SUBSCRIBE = 5; private const int OPCODE_SUBSCRIBE = 5;
private const int OPCODE_UNSUBSCRIBE = 6; private const int OPCODE_UNSUBSCRIBE = 6;
private const int OPCODE_SEND = 8; private const int OPCODE_SEND = 8;
private static readonly IReadOnlyList<string> SUBSCRIBE_EVENTS =
[
"OnJsonApiEvent_lol-champ-select_v1_session",
"OnJsonApiEvent_lol-matchmaking_v1_ready-check",
];
private bool _isDisposed; private bool _isDisposed;
private readonly ClientWebSocket _socket = new(); private readonly ClientWebSocket _socket = new();
public bool IsConnected => _socket.State == WebSocketState.Open;
public event EventHandler? Connecting; public event EventHandler? Connecting;
public event EventHandler? Connected; public event EventHandler? Connected;
public event EventHandler? Disconnected; public event EventHandler? Disconnected;
public event EventHandler<LcuApiEvent>? LcuApiEvent; public event EventHandler<LcuApiEvent>? LcuApiEvent;
public event EventHandler<Exception>? LcuApiException; public event EventHandler<Exception>? LcuApiException;
private readonly HashSet<string> _subscribedEvents = [];
public IReadOnlyCollection<string> SubscribedEvents => _subscribedEvents;
[MemberNotNull(nameof(RiotAuthentication))] [MemberNotNull(nameof(RiotAuthentication))]
public ProcessInfo? ProcessInfo { get; internal set; } public ProcessInfo? ProcessInfo { get; internal set; }
public RiotAuthentication? RiotAuthentication public RiotAuthentication? RiotAuthentication
@@ -42,7 +42,7 @@ public class LcuWebsocket : IDisposable
} }
} }
public async Task Connect() public async Task ConnectAsync()
{ {
Connecting?.Invoke(this, EventArgs.Empty); Connecting?.Invoke(this, EventArgs.Empty);
try try
@@ -70,12 +70,9 @@ public class LcuWebsocket : IDisposable
{ {
await _socket.ConnectAsync(uri, CancellationToken.None); await _socket.ConnectAsync(uri, CancellationToken.None);
foreach (string eventName in SUBSCRIBE_EVENTS) foreach (string eventName in _subscribedEvents)
{ {
string message = $"[{OPCODE_SUBSCRIBE}, \"{eventName}\"]"; await SendSubscribeAsync(eventName);
byte[] buffer = Encoding.UTF8.GetBytes(message);
Memory<byte> memory = new(buffer);
await _socket.SendAsync(memory, WebSocketMessageType.Text, true, CancellationToken.None);
} }
Connected?.Invoke(this, EventArgs.Empty); Connected?.Invoke(this, EventArgs.Empty);
@@ -88,30 +85,44 @@ public class LcuWebsocket : IDisposable
if (result.MessageType is WebSocketMessageType.Close) if (result.MessageType is WebSocketMessageType.Close)
{ {
await _socket.CloseAsync(WebSocketCloseStatus.NormalClosure, string.Empty, CancellationToken.None); await _socket.CloseAsync(WebSocketCloseStatus.NormalClosure, string.Empty, CancellationToken.None);
break;
} }
else
if (result.Message.Length == 0)
{ {
if (result.Message.Length == 0) continue;
{
continue;
}
JsonElement response = JsonElement.Parse(result.Message);
if (response.ValueKind != JsonValueKind.Array
|| response.GetArrayLength() != 3
|| !response[0].TryGetInt32(out int value)
|| value != OPCODE_SEND)
{
continue;
}
LcuApiEvent? apiEvent = response[2].Deserialize<LcuApiEvent>();
if (apiEvent is null)
{
continue;
}
LcuApiEvent?.Invoke(this, apiEvent);
} }
ReadOnlySpan<byte> jsonSpan = result.Message;
Utf8JsonReader reader = new(jsonSpan);
// read array start
if (!reader.Read() || reader.TokenType is not JsonTokenType.StartArray)
{
continue;
}
// read first item: opcode
if (!reader.Read() || reader.TokenType is not JsonTokenType.Number || !reader.TryGetInt32(out int value) || value != OPCODE_SEND)
{
continue;
}
// skip second item (string api event name)
if (!reader.Read() || !reader.TrySkip())
{
continue;
}
// read third item: payload
if (!reader.Read())
{
continue;
}
LcuApiEvent? apiEvent = JsonSerializer.Deserialize<LcuApiEvent>(ref reader);
if (apiEvent is not LcuApiEvent lcuApiEvent)
{
continue;
}
LcuApiEvent?.Invoke(this, lcuApiEvent);
} }
catch (Exception ex) catch (Exception ex)
{ {
@@ -129,6 +140,66 @@ public class LcuWebsocket : IDisposable
} }
} }
public async Task DisconnectAsync()
{
if (_socket.State == WebSocketState.Open || _socket.State == WebSocketState.Connecting)
{
try
{
await _socket.CloseAsync(WebSocketCloseStatus.NormalClosure, string.Empty, CancellationToken.None);
}
catch (Exception ex)
{
LcuApiException?.Invoke(this, ex);
}
}
}
/// <summary>
/// Adds the event to <see cref="SubscribedEvents"/>.
/// If the websocket is connected, it actively subscribes to this event.
/// If it's not connected, it will subscribe the next time it connects.
/// </summary>
/// <param name="eventName">The LCU event name.</param>
public async Task SubscribeAsync(string eventName)
{
bool isAdded = _subscribedEvents.Add(eventName);
if (!IsConnected || !isAdded)
{
return;
}
await SendSubscribeAsync(eventName);
}
private async Task SendSubscribeAsync(string eventName)
{
string message = $"[{OPCODE_SUBSCRIBE}, \"{eventName}\"]";
byte[] buffer = Encoding.UTF8.GetBytes(message);
await _socket.SendAsync(buffer, WebSocketMessageType.Text, true, CancellationToken.None);
}
/// <summary>
/// Removes the event from <see cref="SubscribedEvents"/>.
/// If the websocket is connected, it actively unsubscribes from this event.
/// If it's not connected, it will no longer subscribe to it the next time it connects.
/// </summary>
/// <param name="eventName">The LCU event name.</param>
public async Task UnsubscribeAsync(string eventName)
{
bool isRemoved = _subscribedEvents.Remove(eventName);
if (!IsConnected || !isRemoved)
{
return;
}
string message = $"[{OPCODE_UNSUBSCRIBE}, \"{eventName}\"]";
byte[] buffer = Encoding.UTF8.GetBytes(message);
await _socket.SendAsync(buffer, WebSocketMessageType.Text, true, CancellationToken.None);
}
#region IDisposable #region IDisposable
protected virtual void Dispose(bool disposing) protected virtual void Dispose(bool disposing)
{ {
-16
View File
@@ -1,16 +0,0 @@
using System.Text.Json.Nodes;
using System.Text.Json.Serialization;
namespace LeagueAPI;
public record class LcuApiEvent
{
[JsonPropertyName("data")]
public JsonNode? Data { get; init; }
[JsonPropertyName("eventType")]
public string? EventType { get; init; }
[JsonPropertyName("uri")]
public string? Uri { get; init; }
}
+2 -2
View File
@@ -22,14 +22,14 @@ public static class ResourceService
public static async Task<string> GetChampionIconPathAsync(int championId = -1) public static async Task<string> GetChampionIconPathAsync(int championId = -1)
{ {
FileInfo assetFile = new(Path.Combine(AssetDirectory.FullName, CHAMPION_FILENAME_FORMAT.AsFormatWith(championId))); FileInfo assetFile = new(Path.Combine(AssetDirectory.FullName, CHAMPION_FILENAME_FORMAT.FormatWith(championId)));
if (assetFile.Exists) if (assetFile.Exists)
{ {
return assetFile.FullName; return assetFile.FullName;
} }
using HttpClient client = new(); using HttpClient client = new();
HttpResponseMessage response = await client.GetAsync(DDRAGON_CHAMPION_URL.AsFormatWith(championId)); HttpResponseMessage response = await client.GetAsync(DDRAGON_CHAMPION_URL.FormatWith(championId));
if (!response.IsSuccessStatusCode) if (!response.IsSuccessStatusCode)
{ {
return string.Empty; return string.Empty;