Initial version

2025-08-20 20:08:15 +02:00
parent d802217546
commit f08de22c70
21 changed files with 1680 additions and 42 deletions
--- a/README.md
+++ b/README.md
@@ -1,3 +1,178 @@
+
 # EonaCat.Connections
+.NET Framework 4.8+ / .NET (Core) compatible library providing high-throughput TCP/UDP
+servers and clients with optional TLS (for TCP) and optional application-layer encryption (TCP/UDP).

-EonaCat.Connections
+## Design goals:
+ - High performance and low latency
+ - Scalable to tens of thousands of concurrent connections
+ - Scalable socket I/O via SocketAsyncEventArgs (SAEA) for raw TCP and UDP
+ - TLS (SSL) over TCP using SslStream (built-in)
+ - Optional encryption (AES-CBC + PBKDF2_SHA256) for TCP/UDP payloads
+ - Minimal allocations, event-driven callbacks
+
+#### - For highest throughput, run x64, enable LargePage, set appropriate Socket options and OS registry tuning.
+
+## Generate self-signed certificate for TLS (TCP):
+### Run as Administrator
+	$cert = New-SelfSignedCertificate `
+	    -DnsName "localhost" `
+	    -CertStoreLocation "Cert:\LocalMachine\My" `
+	    -KeyExportPolicy Exportable `
+	    -NotAfter (Get-Date).AddYears(5) `
+	    -FriendlyName "EonaCat Connections Test Certificate"
+
+    $password = ConvertTo-SecureString -String "p@ss" -Force -AsPlainText
+
+    Export-PfxCertificate `
+        -Cert "Cert:\LocalMachine\My\$($cert.Thumbprint)" `
+        -FilePath "C:\temp\server.pfx" `
+        -Password $password
+        
+#### This will create a self-signed certificate with the password 'p@ss' in the folder C:\temp\server.pfx.
+
+
+## Server example:
+
+	using EonaCat.Connections;
+    using EonaCat.Connections.Models;
+
+    namespace EonaCat.Connections.Server.Example
+    {
+        public class Program
+        {
+            private static NetworkServer _server;
+
+            public static void Main(string[] args)
+            {
+                CreateServerAsync().ConfigureAwait(false);
+
+                while (true)
+                {
+                    Console.Write("Enter message to send (or 'exit' to quit): ");
+                    var message = Console.ReadLine();
+                    if (!string.IsNullOrEmpty(message) && message.Equals("exit", StringComparison.OrdinalIgnoreCase))
+                    {
+                        _server.Stop();
+                        _server.Dispose();
+                        Console.WriteLine("Server stopped.");
+                        break;
+                    }
+
+                    if (!string.IsNullOrEmpty(message))
+                    {
+                        _server.BroadcastAsync(message).ConfigureAwait(false);
+                    }
+                }
+            }
+
+            private static async Task CreateServerAsync()
+            {
+                var config = new Configuration
+                {
+                    Protocol = ProtocolType.TCP,
+                    Port = 8080,
+                    UseSsl = true,
+                    UseAesEncryption = true,
+                    MaxConnections = 100000,
+                    ServerCertificate = new System.Security.Cryptography.X509Certificates.X509Certificate2("server.pfx", "p@ss"),
+                };
+
+                _server = new NetworkServer(config);
+
+                // Subscribe to events
+                _server.OnConnected += (sender, e) =>
+                    Console.WriteLine($"Client {e.ClientId} connected from {e.RemoteEndPoint}");
+
+                _server.OnConnectedWithNickname += (sender, e) =>
+                    Console.WriteLine($"Client {e.ClientId} connected with nickname: {e.Nickname}");
+
+                _server.OnDataReceived += async (sender, e) =>
+                {
+                    Console.WriteLine($"Received from {e.ClientId}: {(e.IsBinary ? $"{e.Data.Length} bytes" : e.StringData)}");
+
+                    // Echo back the message
+                    if (e.IsBinary)
+                    {
+                        await _server.SendToClientAsync(e.ClientId, e.Data);
+                    }
+                    else
+                    {
+                        await _server.SendToClientAsync(e.ClientId, $"Echo: {e.StringData}");
+                    }
+                };
+
+                _server.OnDisconnected += (sender, e) =>
+                    Console.WriteLine($"Client {e.ClientId} disconnected");
+
+                await _server.StartAsync();
+            }
+        }
+    }
+
+## Client example:
+
+	using EonaCat.Connections;
+    using EonaCat.Connections.Models;
+
+    namespace EonaCat.Connections.Client.Example
+    {
+        public class Program
+        {
+            private static NetworkClient _client;
+
+            public static void Main(string[] args)
+            {
+                CreateClientAsync().ConfigureAwait(false);
+
+                while (true)
+                {
+                    Console.Write("Enter message to send (or 'exit' to quit): ");
+                    var message = Console.ReadLine();
+                    if (!string.IsNullOrEmpty(message) && message.Equals("exit", StringComparison.OrdinalIgnoreCase))
+                    {
+                        _client.DisconnectAsync().ConfigureAwait(false);
+                        break;
+                    }
+
+                    if (!string.IsNullOrEmpty(message))
+                    {
+                        _client.SendAsync(message).ConfigureAwait(false);
+                    }
+                }
+            }
+
+            private static async Task CreateClientAsync()
+            {
+                var config = new Configuration
+                {
+                    Protocol = ProtocolType.TCP,
+                    Host = "127.0.0.1",
+                    Port = 8080,
+                    UseSsl = true,
+                    UseAesEncryption = true,
+                    ServerCertificate = new System.Security.Cryptography.X509Certificates.X509Certificate2("client.pfx", "p@ss"),
+                };
+
+                _client = new NetworkClient(config);
+
+                // Subscribe to events
+                _client.OnConnected += (sender, e) =>
+                    Console.WriteLine($"Connected to server at {e.RemoteEndPoint}");
+
+                _client.OnDataReceived += (sender, e) =>
+                    Console.WriteLine($"Server says: {(e.IsBinary ? $"{e.Data.Length} bytes" : e.StringData)}");
+
+                _client.OnDisconnected += (sender, e) =>
+                    Console.WriteLine("Disconnected from server");
+
+                await _client.ConnectAsync();
+
+                // Send nickname
+                await _client.SendNicknameAsync("TestUser");
+
+                // Send a message
+                await _client.SendAsync("Hello server!");
+            }
+        }
+    }