-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
338 additions
and
243 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,180 @@ | ||
| using System.Diagnostics; | ||
| using System.Net.WebSockets; | ||
|
|
||
| using Google.Protobuf; | ||
|
|
||
| using RustPlusContracts; | ||
|
|
||
| using static System.GC; | ||
| // ReSharper disable MemberCanBeProtected.Global | ||
| // ReSharper disable MemberCanBePrivate.Global | ||
|
|
||
| namespace RustPlusApi | ||
| { | ||
| /// <summary> | ||
| /// A Rust+ API client made in C#. | ||
| /// </summary> | ||
| /// <param name="server">The IP address of the Rust+ server.</param> | ||
| /// <param name="port">The port dedicated for the Rust+ companion app (not the one used to connect in-game).</param> | ||
| /// <param name="playerId">Your Steam ID.</param> | ||
| /// <param name="playerToken">Your player token acquired with FCM.</param> | ||
| /// <param name="useFacepunchProxy">Specifies whether to use the Facepunch proxy.</param> | ||
| public abstract class RustPlusBase(string server, int port, ulong playerId, int playerToken, bool useFacepunchProxy = false) : IDisposable | ||
| { | ||
| private ClientWebSocket? _webSocket; | ||
| private uint _seq; | ||
| private readonly Dictionary<int, TaskCompletionSource<AppMessage>> _seqCallbacks = []; | ||
|
|
||
| public event EventHandler? Connecting; | ||
| public event EventHandler? Connected; | ||
| public event EventHandler<AppMessage>? MessageReceived; | ||
| public event EventHandler<AppRequest>? RequestSent; | ||
| public event EventHandler? Disconnected; | ||
| public event EventHandler<Exception>? ErrorOccurred; | ||
|
|
||
| /// <summary> | ||
| /// Connects to the Rust+ server asynchronously. | ||
| /// </summary> | ||
| public async Task ConnectAsync() | ||
| { | ||
| _webSocket = new ClientWebSocket(); | ||
| _webSocket.Options.KeepAliveInterval = TimeSpan.FromSeconds(20); | ||
| var address = useFacepunchProxy | ||
| ? new Uri($"wss://companion-rust.facepunch.com/game/{server}/{port}") | ||
| : new Uri($"ws://{server}:{port}"); | ||
|
|
||
| Connecting?.Invoke(this, EventArgs.Empty); | ||
|
|
||
| try | ||
| { | ||
| await _webSocket.ConnectAsync(address, CancellationToken.None); | ||
| Connected?.Invoke(this, EventArgs.Empty); | ||
| await ReceiveMessagesAsync(); | ||
| } | ||
| catch (Exception ex) | ||
| { | ||
| ErrorOccurred?.Invoke(this, ex); | ||
| Dispose(); | ||
| } | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Receives messages from the Rust+ server asynchronously. | ||
| /// </summary> | ||
| /// <returns>A task representing the asynchronous operation.</returns> | ||
| protected async Task ReceiveMessagesAsync() | ||
| { | ||
| const int bufferSize = 1024; | ||
| var buffer = new byte[bufferSize]; | ||
|
|
||
| try | ||
| { | ||
| while (_webSocket!.State == WebSocketState.Open) | ||
| { | ||
| var receiveBuffer = new List<byte>(); | ||
| WebSocketReceiveResult result; | ||
|
|
||
| do | ||
| { | ||
| result = await _webSocket.ReceiveAsync(new ArraySegment<byte>(buffer), CancellationToken.None); | ||
| receiveBuffer.AddRange(buffer.Take(result.Count)); | ||
| } while (!result.EndOfMessage); | ||
|
|
||
| var messageData = receiveBuffer.ToArray(); | ||
| var message = AppMessage.Parser.ParseFrom(messageData); | ||
| HandleResponse(message); | ||
| } | ||
| } | ||
| catch (WebSocketException ex) | ||
| { | ||
| Debug.WriteLine($"Disconnected from the Rust+ socket due to a WebSocketException: {ex}"); | ||
| ErrorOccurred?.Invoke(this, ex); | ||
| } | ||
| catch (Exception ex) | ||
| { | ||
| Debug.WriteLine($"Disconnected from the Rust+ socket due to an Exception: {ex}"); | ||
| ErrorOccurred?.Invoke(this, ex); | ||
| } | ||
| finally | ||
| { | ||
| Dispose(); | ||
| } | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Handles the response received from the Rust+ server. | ||
| /// </summary> | ||
| /// <param name="message">The AppMessage received from the server.</param> | ||
| protected void HandleResponse(AppMessage message) | ||
| { | ||
| if (message.Response != null | ||
| && message.Response.Seq != 0 | ||
| && _seqCallbacks.ContainsKey((int)message.Response.Seq)) | ||
| { | ||
| var tcs = _seqCallbacks[(int)message.Response.Seq]; | ||
| tcs.SetResult(message); | ||
| _seqCallbacks.Remove((int)message.Response.Seq); | ||
| return; | ||
| } | ||
| MessageReceived?.Invoke(this, message); | ||
| ParseNotification(message.Broadcast); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Parses the notification received from the Rust+ server. | ||
| /// </summary> | ||
| /// <param name="broadcast">The AppBroadcast received from the server.</param> | ||
| protected virtual void ParseNotification(AppBroadcast? broadcast) { } | ||
|
|
||
| /// <summary> | ||
| /// Sends a request to the Rust+ server asynchronously. | ||
| /// </summary> | ||
| /// <param name="request">The request to send.</param> | ||
| /// <return>A task representing the asynchronous operation.</return> | ||
| public async Task<AppMessage> SendRequestAsync(AppRequest request) | ||
| { | ||
| var seq = ++_seq; | ||
| var tcs = new TaskCompletionSource<AppMessage>(); | ||
| _seqCallbacks[(int)seq] = tcs; | ||
|
|
||
| request.Seq = seq; | ||
| request.PlayerId = playerId; | ||
| request.PlayerToken = playerToken; | ||
|
|
||
| var requestData = request.ToByteArray(); | ||
| var buffer = new ArraySegment<byte>(requestData); | ||
| await _webSocket!.SendAsync(buffer, WebSocketMessageType.Binary, true, CancellationToken.None); | ||
| RequestSent?.Invoke(this, request); | ||
|
|
||
| return await tcs.Task; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Disposes the Rust+ API client and disconnects from the Rust+ server. | ||
| /// </summary> | ||
| public void Dispose() | ||
| { | ||
| if (_webSocket is not { State: WebSocketState.Open }) return; | ||
|
|
||
| _webSocket.CloseAsync(WebSocketCloseStatus.NormalClosure, "Connection closed by client.", CancellationToken.None).Wait(); | ||
| _webSocket.Dispose(); | ||
|
|
||
| Disconnected?.Invoke(this, EventArgs.Empty); | ||
|
|
||
| SuppressFinalize(this); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Checks if the client is connected to the Rust+ socket. | ||
| /// </summary> | ||
| /// <returns>True if the client is connected; otherwise, false.</returns> | ||
| public bool IsConnected() => _webSocket is { State: WebSocketState.Open }; | ||
|
|
||
| /// <summary> | ||
| /// Checks if the given response is an error. | ||
| /// </summary> | ||
| /// <param name="response">The AppMessage response to check.</param> | ||
| /// <returns>True if the response is an error; otherwise, false.</returns> | ||
| protected static bool IsError(AppMessage response) => response.Response.Error is not null; | ||
| } | ||
| } |
Oops, something went wrong.