working

Directory.Build.props

@@ -2,7 +2,7 @@
   <PropertyGroup>
     <TargetFramework>net9.0</TargetFramework>
     <VersionPrefix>0.0.1</VersionPrefix>
-    <VersionSuffix>beta1</VersionSuffix>
+    <VersionSuffix>beta2</VersionSuffix>
     <Authors>Paul Bleess</Authors>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <RepositoryUrl>https://github.com/pableess/yamux-dotnet</RepositoryUrl>

src/Yamux/Session.cs

@@ -16,6 +16,9 @@ namespace Yamux;
 /// A yamux session represents a multiplexed connection between two peers.  This can be used to create multiple logical streams over a single connection using the yamux protocol defined by hanshicorp.
 /// https://github.com/hashicorp/yamux/blob/master/spec.md
 /// </summary>
+/// <remarks>
+/// A Yamux session allows multiple logical streams over a single connection using the Yamux protocol.
+/// </remarks>
 public class Session : IChannelSessionAdapter, IDisposable,  IAsyncDisposable
 {
     private readonly static TraceSource SessionTracer = new TraceSource("Yamux.Session");

src/Yamux/SessionChannelOptions.cs

@@ -10,6 +10,12 @@
 
 namespace Yamux;
 
+/// <summary>
+/// Options for configuring a Yamux session channel.
+/// </summary>
+/// <remarks>
+/// Includes settings for window size, frame size, and automatic tuning.
+/// </remarks>
 public class SessionChannelOptions
 {
     public SessionChannelOptions() { }

src/Yamux/SessionException.cs

@@ -10,12 +10,12 @@ namespace Yamux
     public enum SessionErrorCode 
     {
         /// <summary>
-        /// Invalid fram
+        /// Invalid frame
         /// </summary>
         InvalidVersion,
 
         /// <summary>
-        /// Invaid frame message type
+        /// Invalid frame message type
         /// </summary>
         InvalidMsgType,
 

src/Yamux/Statistics.cs

@@ -8,6 +8,12 @@
 
 namespace Yamux
 {
+    /// <summary>
+    /// Tracks bandwidth and byte statistics for a Yamux session.
+    /// </summary>
+    /// <remarks>
+    /// Provides methods to update and sample statistics.
+    /// </remarks>
     /// <summary>
     /// Class to track the current send and receive bandwidth and the total bytes sent and received.
     /// </summary>

src/Yamux/StreamExtensions.cs

@@ -10,7 +10,7 @@ namespace Yamux
     public static class StreamExtensions
     {
         /// <summary>
-        /// Craetes a yamux session from the raw stream
+        /// Creates a yamux session from the raw stream
         /// </summary>
         /// <param name="stream"></param>
         /// <returns></returns>

test/Yamux.Tests/DataWindowTests.cs

@@ -41,7 +41,7 @@ public void TryConsumeTest_Partial()
 
         [System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "xUnit1031:Do not use blocking task operations in test method", Justification = "Thread synchronization testing")]
         [Fact]
-        public void WaitConsumeTest_UnBlockedSuccess()
+        public async Task WaitConsumeTest_UnBlockedSuccess()
         {
             var dw = new RemoteDataWindow();
             dw.TryConsume(dw.Available);
@@ -57,7 +57,7 @@ public void WaitConsumeTest_UnBlockedSuccess()
 
             consumed.Should().Be(0);
             dw.Extend(24 * 1024);
-            task.Wait(100);
+            await task;
             consumed.Should().Be(24 * 1024);
         }