feature: handle unix socket (#38)

PR by [philippseith](chronoxor/NetCoreServer#250)

Author: stratdev3

documentation/docs/.vitepress/config.mjs

@@ -72,6 +72,7 @@ export default defineConfig({
                         { text: 'Json Web Token', link: '/guide/api-json-web-token' },
                         { text: 'Cross-Origin Resource Sharing', link: '/guide/api-cors' },
                         { text: 'SSL Certificate', link: '/guide/ssl-certificate' },
+                        { text: 'Unix Sockets', link: '/guide/unix-sockets' },
                     ]
                 },
                 {

documentation/docs/guide/ssl-certificate.md

@@ -2,7 +2,7 @@
 
 The HTTPS protocol is supported and you can bring your own certificate in `PKCS#12` format.
 
-With a little change the [basic static example](./static-files) can serve HTTPS.
+With just a small change, the [basic static example](./static-files) can serve HTTPS.
 
 ::: code-group
 

documentation/docs/guide/unix-sockets.md

@@ -0,0 +1,23 @@
+# Unix Sockets
+
+[Unix Domain Socket](https://en.wikipedia.org/wiki/Unix_domain_socket) (UDS) can also be used as an entrypoint for the server.
+They are supported on : **Linux**, **MacOS**, **Android**... and even **Windows** !
+
+With just a small change, the [basic api example](./api-basic) can also be served over a Unix socket.
+
+::: code-group
+
+<<< @/snippets/unix-sockets.cs#snippet{13 csharp:line-numbers} [program.cs]
+
+:::
+
+You can use `curl` to test :
+
+```
+$ curl --unix-socket C:\www\test.sock http://localhost/api/test
+> { "message" : "Hello World !" }
+```
+
+There only one change :
+- L13 : use the `SimpleWServer()` constructor with `UnixDomainSocketEndPoint` argument.
+

documentation/docs/reference/simplewserver.md

@@ -31,6 +31,14 @@ public SimpleWServer(DnsEndPoint endpoint)
 public SimpleWServer(IPEndPoint endpoint)
 ```
 
+```csharp
+/// <summary>
+/// Initialize HTTP server with a given Unix domain socket endpoint
+/// </summary>
+/// <param name="endpoint">Unix domain socket endpoint</param>
+public WsServer(UnixDomainSocketEndPoint endpoint)
+```
+
 ### HTTPS
 
 ```csharp

documentation/docs/snippets/unix-sockets.cs

@@ -0,0 +1,51 @@
+using System;
+using System.Net;
+using System.Net.Sockets;
+using SimpleW;
+
+namespace Sample {
+    class Program {
+
+        static void Main() {
+
+            // unix socket
+            string unixSocketPath = @"C:\www\server.sock";
+            var server = new SimpleWServer(new UnixDomainSocketEndPoint(unixSocketPath));
+
+            // find all Controllers classes and serve on the "/api" endpoint
+            server.AddDynamicContent("/api");
+
+            // start non blocking background server
+            server.Start();
+
+            Console.WriteLine(@"server available on : unix:C:\www\server.sock");
+
+            // block console for debug
+            Console.ReadKey();
+
+        }
+    }
+
+    // inherit from Controller
+    public class SomeController : Controller {
+
+        // use the Route attribute to target a public method
+        [Route("GET", "/test")]
+        public object SomePublicMethod() {
+
+            // the Request property contains all data (Url, Headers...) from the client Request
+            var url = Request.Url;
+
+            // the return will be serialized to json and sent as response to client
+            return new {
+                message = Message()
+            };
+        }
+
+        private string Message() {
+            return "Hello World !";
+        }
+
+    }
+
+}

src/SimpleW/NetCoreServer/HttpServer.cs

@@ -1,6 +1,7 @@
 using System;
-using System.Net;
 using System.IO;
+using System.Net;
+using System.Net.Sockets;
 
 namespace NetCoreServer
 {
@@ -32,6 +33,11 @@ public class HttpServer : TcpServer
         /// </summary>
         /// <param name="endpoint">IP endpoint</param>
         public HttpServer(IPEndPoint endpoint) : base(endpoint) { Cache = new FileCache(); }
+        /// <summary>
+        /// Initialize HTTP server with a given Unix domain socket endpoint
+        /// </summary>
+        /// <param name="endpoint">Unix domain socket endpoint</param>
+        public HttpServer(UnixDomainSocketEndPoint endpoint) : base(endpoint) { Cache = new FileCache(); }
 
         /// <summary>
         /// Get the static content cache

src/SimpleW/NetCoreServer/TcpServer.cs

@@ -49,6 +49,11 @@ private TcpServer(EndPoint endpoint, string address, int port)
             Port = port;
             Endpoint = endpoint;
         }
+        /// <summary>
+        /// Initialize TCP server with a given Unix domain socket endpoint
+        /// </summary>
+        /// <param name="endpoint">Unix domain socket endpoint</param>
+        public TcpServer(UnixDomainSocketEndPoint endpoint) : this(endpoint, endpoint.ToString(), 0) {}
 
         /// <summary>
         /// Server Id
@@ -187,7 +192,8 @@ private TcpServer(EndPoint endpoint, string address, int port)
         /// <returns>Socket object</returns>
         protected virtual Socket CreateSocket()
         {
-            return new Socket(Endpoint.AddressFamily, SocketType.Stream, ProtocolType.Tcp);
+            ProtocolType protocolType = Endpoint is UnixDomainSocketEndPoint ? ProtocolType.IP : ProtocolType.Tcp;
+            return new Socket(Endpoint.AddressFamily, SocketType.Stream, protocolType);
         }
 
         /// <summary>

src/SimpleW/NetCoreServer/WsServer.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Net;
+using System.Net.Sockets;
 using System.Text;
 
 namespace NetCoreServer
@@ -34,7 +35,11 @@ public class WsServer : HttpServer, IWebSocket
         /// </summary>
         /// <param name="endpoint">IP endpoint</param>
         public WsServer(IPEndPoint endpoint) : base(endpoint) { WebSocket = new WebSocket(this); }
-
+        /// <summary>
+        /// Initialize HTTP server with a given Unix domain socket endpoint
+        /// </summary>
+        /// <param name="endpoint">Unix domain socket endpoint</param>
+        public WsServer(UnixDomainSocketEndPoint endpoint) : base(endpoint) { WebSocket = new WebSocket(this); }
         #region Session management
 
         public virtual bool CloseAll() => CloseAll(0, Span<byte>.Empty);

src/SimpleW/SimpleW/SimpleWServer.cs

@@ -51,6 +51,12 @@ public SimpleWServer(DnsEndPoint endpoint) : base(endpoint) { }
         /// <param name="endpoint">IP endpoint</param>
         public SimpleWServer(IPEndPoint endpoint) : base(endpoint) { }
 
+        /// <summary>
+        /// Initialize server with a given Unix domain socket endpoint
+        /// </summary>
+        /// <param name="endpoint">Unix domain socket endpoint</param>
+        public SimpleWServer(UnixDomainSocketEndPoint endpoint) : base(endpoint) { }
+
         /// <summary>
         /// Herited mandatory factory http/ws session builder
         /// </summary>