Added helper methods, convenience WaitForEvent methods and common filter settings types

Author: Agash

ObsWebSocket.Core/Networking/IWebSocketConnection .cs

@@ -8,32 +8,93 @@ namespace ObsWebSocket.Core.Networking;
 /// </summary>
 public interface IWebSocketConnection : IDisposable
 {
+    /// <summary>
+    /// Gets the current state of the WebSocket connection.
+    /// </summary>
     WebSocketState State { get; }
+
+    /// <summary>
+    /// Gets the current close status of the WebSocket connection, if available.
+    /// </summary>
     WebSocketCloseStatus? CloseStatus { get; }
+
+    /// <summary>
+    /// Gets the close status description of the WebSocket connection, if available.
+    /// </summary>
     string? CloseStatusDescription { get; }
+
+    /// <summary>
+    /// Gets the Subprotocol used for the WebSocket connection.
+    /// </summary>
     string? SubProtocol { get; }
+
+    /// <summary>
+    /// Gets the options used to configure the WebSocket connection.
+    /// </summary>
     ClientWebSocketOptions Options { get; }
 
+    /// <summary>
+    /// Connects to the WebSocket server using the specified URI.
+    /// </summary>
+    /// <param name="uri"></param>
+    /// <param name="cancellationToken"></param>
+    /// <returns></returns>
     Task ConnectAsync(Uri uri, CancellationToken cancellationToken);
+
+    /// <summary>
+    /// Sends a message to the WebSocket connection.
+    /// </summary>
+    /// <param name="buffer"></param>
+    /// <param name="messageType"></param>
+    /// <param name="endOfMessage"></param>
+    /// <param name="cancellationToken"></param>
+    /// <returns></returns>
     ValueTask SendAsync(
         ReadOnlyMemory<byte> buffer,
         WebSocketMessageType messageType,
         bool endOfMessage,
         CancellationToken cancellationToken
     );
+
+    /// <summary>
+    /// Receives a message from the WebSocket connection and returns the result.
+    /// </summary>
+    /// <param name="buffer"></param>
+    /// <param name="cancellationToken"></param>
+    /// <returns></returns>
     ValueTask<ValueWebSocketReceiveResult> ReceiveAsync(
         Memory<byte> buffer,
         CancellationToken cancellationToken
     );
+
+    /// <summary>
+    /// Closes the WebSocket connection and sends a close frame to the server.
+    /// </summary>
+    /// <param name="closeStatus"></param>
+    /// <param name="statusDescription"></param>
+    /// <param name="cancellationToken"></param>
+    /// <returns></returns>
     Task CloseAsync(
         WebSocketCloseStatus closeStatus,
         string? statusDescription,
         CancellationToken cancellationToken
     );
+
+    /// <summary>
+    /// Closes the output stream of the WebSocket connection without closing the connection itself.
+    /// </summary>
+    /// <param name="closeStatus"></param>
+    /// <param name="statusDescription"></param>
+    /// <param name="cancellationToken"></param>
+    /// <returns></returns>
     Task CloseOutputAsync(
         WebSocketCloseStatus closeStatus,
         string? statusDescription,
         CancellationToken cancellationToken
     );
+
+    /// <summary>
+    /// Aborts the WebSocket connection without sending a close frame.
+    /// </summary>
     void Abort();
 }

ObsWebSocket.Core/ObsWebSocket.Core.csproj

@@ -28,10 +28,7 @@
     <SymbolPackageFormat>snupkg</SymbolPackageFormat>
   </PropertyGroup>
   <ItemGroup>
-    <PackageReference
-      Include="Microsoft.Extensions.DependencyInjection.Abstractions"
-      Version="9.0.4"
-    />
+    <PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="9.0.4" />
     <PackageReference Include="Microsoft.Extensions.Logging" Version="9.0.4" />
     <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="9.0.4" />
     <PackageReference Include="MessagePack" Version="3.1.3" />
@@ -49,11 +46,7 @@
     <AdditionalFiles Include="..\protocol.json" Link="protocol.json" />
   </ItemGroup>
   <ItemGroup>
-    <ProjectReference
-      Include="..\ObsWebSocket.SourceGenerators\ObsWebSocket.SourceGenerators.csproj"
-      OutputItemType="Analyzer"
-      ReferenceOutputAssembly="false"
-    />
+    <ProjectReference Include="..\ObsWebSocket.SourceGenerators\ObsWebSocket.SourceGenerators.csproj" OutputItemType="Analyzer" ReferenceOutputAssembly="false" />
   </ItemGroup>
   <ItemGroup>
     <None Include="..\LICENSE.txt" Pack="true" PackagePath="" />