release v1.0.3

- [change] modified NetMiddleware to an interface

Author: JasonXuDeveloper

Miku.Core/NetMiddleware.cs renamed to Miku.Core/INetMiddleware.cs

@@ -5,21 +5,22 @@ namespace Miku.Core
     /// <summary>
     /// Middleware for processing data before sending or receiving
     /// </summary>
-    public abstract class NetMiddleware
+    public interface INetMiddleware
     {
         /// <summary>
         /// Process data before sending
         /// </summary>
         /// <param name="input">A data to be sent (might be processed by other middleware)</param>
         /// <param name="output">A processed data to be sent</param>
-        public abstract void ProcessSend(ref ReadOnlyMemory<byte> input, out ReadOnlyMemory<byte> output);
-        
+        void ProcessSend(ref ReadOnlyMemory<byte> input, out ReadOnlyMemory<byte> output);
+
         /// <summary>
         /// Process data after receiving
         /// </summary>
         /// <param name="input">A received data (might be processed by other middleware)</param>
         /// <param name="output">A processed data to be passed to the next middleware</param>
         /// <returns>Whether to halt the processing and how many bytes are consumed</returns>
-        public abstract (bool halt, int consumedFromOrigin) ProcessReceive(ref ReadOnlyMemory<byte> input, out ReadOnlyMemory<byte> output);
+        (bool halt, int consumedFromOrigin) ProcessReceive(ref ReadOnlyMemory<byte> input,
+            out ReadOnlyMemory<byte> output);
     }
 }

Miku.Core/NetClient.cs

@@ -48,7 +48,7 @@ public class NetClient
         /// </summary>
         public string Ip { get; private set; }
 
-        private readonly List<NetMiddleware> _middlewares = new();
+        private readonly List<INetMiddleware> _middlewares = new();
         private Socket _socket;
         private bool _isConnected;
         private int _sending;
@@ -80,7 +80,7 @@ public NetClient(int bufferSize = 1024)
         /// Add a middleware to the client
         /// </summary>
         /// <param name="middleware"></param>
-        public void AddMiddleware(NetMiddleware middleware)
+        public void AddMiddleware(INetMiddleware middleware)
         {
             _middlewares.Add(middleware);
         }
@@ -89,7 +89,7 @@ public void AddMiddleware(NetMiddleware middleware)
         /// Remove a middleware from the client
         /// </summary>
         /// <param name="middleware"></param>
-        public void RemoveMiddleware(NetMiddleware middleware)
+        public void RemoveMiddleware(INetMiddleware middleware)
         {
             _middlewares.Remove(middleware);
         }

Miku.UnitTest/Lz4CompressionMiddleware.cs

@@ -7,18 +7,19 @@ namespace Miku.UnitTest;
 /// <summary>
 /// Middleware that compresses and decompresses data using the LZ4 algorithm.
 /// </summary>
-public class Lz4CompressionMiddleware: NetMiddleware
+public class Lz4CompressionMiddleware : INetMiddleware
 {
     private readonly ArrayBufferWriter<byte> _buffer = new ArrayBufferWriter<byte>();
 
-    public override void ProcessSend(ref ReadOnlyMemory<byte> input, out ReadOnlyMemory<byte> output)
+    public void ProcessSend(ref ReadOnlyMemory<byte> input, out ReadOnlyMemory<byte> output)
     {
         _buffer.Clear();
         LZ4Pickler.Pickle(input.Span, _buffer);
         output = _buffer.WrittenMemory;
     }
 
-    public override (bool halt, int consumedFromOrigin) ProcessReceive(ref ReadOnlyMemory<byte> input, out ReadOnlyMemory<byte> output)
+    public (bool halt, int consumedFromOrigin) ProcessReceive(ref ReadOnlyMemory<byte> input,
+        out ReadOnlyMemory<byte> output)
     {
         try
         {

Miku.UnitTest/PacketFrameMiddleware.cs

@@ -7,11 +7,11 @@ namespace Miku.UnitTest;
 /// <summary>
 /// Middleware for processing packets. Prevent framing due to tcp.
 /// </summary>
-public class PacketFrameMiddleware : NetMiddleware
+public class PacketFrameMiddleware : INetMiddleware
 {
     private readonly ArrayBufferWriter<byte> _buffer = new ArrayBufferWriter<byte>();
 
-    public override void ProcessSend(ref ReadOnlyMemory<byte> input, out ReadOnlyMemory<byte> output)
+    public void ProcessSend(ref ReadOnlyMemory<byte> input, out ReadOnlyMemory<byte> output)
     {
         _buffer.Clear();
         var memory = _buffer.GetMemory(input.Length + 4);
@@ -24,7 +24,7 @@ public override void ProcessSend(ref ReadOnlyMemory<byte> input, out ReadOnlyMem
         Console.WriteLine($"Send: {string.Join(',', output.ToArray())}");
     }
 
-    public override (bool halt, int consumedFromOrigin) ProcessReceive(ref ReadOnlyMemory<byte> input,
+    public (bool halt, int consumedFromOrigin) ProcessReceive(ref ReadOnlyMemory<byte> input,
         out ReadOnlyMemory<byte> output)
     {
         // If we don't have enough data to read the length of the packet, we need to wait for more data.