first commit

timostamm · timostamm · commit d777c1cf0633 · 2019-10-30T18:59:48.000+01:00
diff --git a/README.md b/README.md
@@ -0,0 +1,31 @@
+websocket-controller
+====================
+
+Easy WebSockets for AspNetCore 3.0.
+
+
+Implement your websocket controller:
+````c#
+public class MyController : AWebsocketController
+{
+    public override async Task OnOpen(Client client)
+    {
+        await client.SendAsync("Hello there");
+    }
+    // OnTextMessage(Client client, string text)
+    // OnBinaryMessage(...)
+    // OnClose(...)
+}
+````
+
+And add it in your `Startup.cs`
+````c#
+public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
+{
+    app.UseWebSockets();
+    var myHandler = WebSocketHandler.CreateFor<MyController>(app.ApplicationServices);
+    app.Run(myHandler.HandleRequest);
+}
+````
+
+See example for a basic websocket chat. To run, `cd example` and `dotnet run`, then open http://localhost:5000/
diff --git a/aspnetcore-websocket-controller.sln b/aspnetcore-websocket-controller.sln
@@ -0,0 +1,22 @@
+﻿
+Microsoft Visual Studio Solution File, Format Version 12.00
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "src", "src\src.csproj", "{255700B0-36C9-4C82-A73B-35D18F7B8D31}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "example", "example\example.csproj", "{35212A5A-CD5A-4FA3-B40B-150BED908A97}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{255700B0-36C9-4C82-A73B-35D18F7B8D31}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{255700B0-36C9-4C82-A73B-35D18F7B8D31}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{255700B0-36C9-4C82-A73B-35D18F7B8D31}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{255700B0-36C9-4C82-A73B-35D18F7B8D31}.Release|Any CPU.Build.0 = Release|Any CPU
+		{35212A5A-CD5A-4FA3-B40B-150BED908A97}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{35212A5A-CD5A-4FA3-B40B-150BED908A97}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{35212A5A-CD5A-4FA3-B40B-150BED908A97}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{35212A5A-CD5A-4FA3-B40B-150BED908A97}.Release|Any CPU.Build.0 = Release|Any CPU
+	EndGlobalSection
+EndGlobal
diff --git a/example/.gitignore b/example/.gitignore
@@ -0,0 +1,2 @@
+/bin
+/obj
diff --git a/example/ChatController.cs b/example/ChatController.cs
@@ -0,0 +1,48 @@
+using System.Linq;
+using System.Net.WebSockets;
+using System.Threading.Tasks;
+using TimoStamm.WebSockets.Controller;
+
+namespace example
+{
+    public class ChatController : AWebsocketController
+    {
+        private readonly ClientCollection _clients;
+        private static int _clientCounter;
+
+        public ChatController(ClientCollection clients)
+        {
+            _clients = clients;
+        }
+
+
+        public override async Task OnOpen(Client client)
+        {
+            var nick = client.Context.Items["nick"] = ++_clientCounter;
+            var msg = $"{nick} has entered the chat.";
+            if (_clients.Count == 1)
+            {
+                msg += " You are alone. Open another browser window...";
+            }
+            await Task.WhenAll(_clients.Select(c => c.SendAsync(msg)));
+        }
+
+
+        public override async Task OnClose(Client client, WebSocketCloseStatus closeStatus,
+            string closeStatusDescription)
+        {
+            var nick = client.Context.Items["nick"];
+            var msg = $"{nick} has left the chat.";
+            await Task.WhenAll(_clients.Select(c => c.SendAsync(msg)));
+        }
+
+
+        public override async Task OnTextMessage(Client client, string text)
+        {
+            var nick = client.Context.Items["nick"];
+            var msg = $"{nick}: {text}";
+            await Task.WhenAll(_clients.Select(c => c.SendAsync(msg)));
+        }
+        
+    }
+}
diff --git a/example/MyController.cs b/example/MyController.cs
@@ -0,0 +1,15 @@
+using System.Threading.Tasks;
+using TimoStamm.WebSockets.Controller;
+
+namespace example
+{
+    public class MyController : AWebsocketController
+    {
+        
+        public override async Task OnOpen(Client client)
+        {
+            await client.SendAsync("Hello there");
+        }
+
+    }
+}
diff --git a/example/Program.cs b/example/Program.cs
@@ -0,0 +1,23 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Hosting;
+using Microsoft.Extensions.Logging;
+
+namespace example
+{
+    public class Program
+    {
+        public static void Main(string[] args)
+        {
+            CreateHostBuilder(args).Build().Run();
+        }
+
+        public static IHostBuilder CreateHostBuilder(string[] args) =>
+            Host.CreateDefaultBuilder(args)
+                .ConfigureWebHostDefaults(webBuilder => { webBuilder.UseStartup<Startup>(); });
+    }
+}
diff --git a/example/Properties/launchSettings.json b/example/Properties/launchSettings.json
@@ -0,0 +1,27 @@
+﻿{
+  "iisSettings": {
+    "windowsAuthentication": false, 
+    "anonymousAuthentication": true, 
+    "iisExpress": {
+      "applicationUrl": "http://localhost:13053",
+      "sslPort": 44318
+    }
+  },
+  "profiles": {
+    "IIS Express": {
+      "commandName": "IISExpress",
+      "launchBrowser": true,
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    },
+    "example": {
+      "commandName": "Project",
+      "launchBrowser": true,
+      "applicationUrl": "http://localhost:5000",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    }
+  }
+}
diff --git a/example/Startup.cs b/example/Startup.cs
@@ -0,0 +1,31 @@
+using Microsoft.AspNetCore.Builder;
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.Extensions.DependencyInjection;
+using TimoStamm.WebSockets.Controller;
+
+namespace example
+{
+    public class Startup
+    {
+        // This method gets called by the runtime. Use this method to add services to the container.
+        // For more information on how to configure your application, visit https://go.microsoft.com/fwlink/?LinkID=398940
+        public void ConfigureServices(IServiceCollection services)
+        {
+        }
+
+        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
+        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
+        {
+            app.UseDefaultFiles();
+            app.UseStaticFiles();
+
+            app.UseWebSockets();
+
+            app.Map("/ws-chat", a =>
+            {
+                var handler = WebSocketHandler.CreateFor<ChatController>(app.ApplicationServices);
+                a.Run(handler.HandleRequest);
+            });
+        }
+    }
+}
diff --git a/example/appsettings.Development.json b/example/appsettings.Development.json
@@ -0,0 +1,9 @@
+{
+  "Logging": {
+    "LogLevel": {
+      "Default": "Debug",
+      "System": "Information",
+      "Microsoft": "Information"
+    }
+  }
+}
diff --git a/example/appsettings.json b/example/appsettings.json
@@ -0,0 +1,10 @@
+{
+  "Logging": {
+    "LogLevel": {
+      "Default": "Information",
+      "Microsoft": "Warning",
+      "Microsoft.Hosting.Lifetime": "Information"
+    }
+  },
+  "AllowedHosts": "*"
+}
diff --git a/example/example.csproj b/example/example.csproj
@@ -0,0 +1,11 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+    <PropertyGroup>
+        <TargetFramework>netcoreapp3.0</TargetFramework>
+    </PropertyGroup>
+
+    <ItemGroup>
+      <ProjectReference Include="..\src\src.csproj" />
+    </ItemGroup>
+
+</Project>
diff --git a/example/wwwroot/index.html b/example/wwwroot/index.html
@@ -0,0 +1,47 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>Chat</title>
+    <style type="text/css">
+        input[name=text] {
+            font-size: 1.2rem;
+            width: 90%;
+            margin-bottom: 20px;
+        }
+
+        div#output {
+            white-space: pre-wrap;
+        }
+    </style>
+</head>
+<body>
+
+<form onsubmit="onSubmit(event)">
+    <input type="text" name="text" placeholder="enter message and hit enter" autocomplete="off">
+</form>
+
+<div id="output" style="">
+</div>
+
+
+<script type="application/javascript">
+
+    var webSocket = new WebSocket("ws://localhost:5000/ws-chat");
+
+    webSocket.onmessage = function (event) {
+        var output = document.getElementById('output');
+        output.textContent = event.data + "\n" + output.textContent;
+    };
+
+    function onSubmit(event) {
+        event.preventDefault();
+        var input = event.target.elements.namedItem('text');
+        webSocket.send(input.value);
+        input.value = "";
+    }
+
+</script>
+
+</body>
+</html>
diff --git a/src/.gitignore b/src/.gitignore
@@ -0,0 +1,2 @@
+/bin
+/obj
diff --git a/src/AWebsocketController.cs b/src/AWebsocketController.cs
@@ -0,0 +1,28 @@
+using System.Net.WebSockets;
+using System.Threading.Tasks;
+
+namespace TimoStamm.WebSockets.Controller
+{
+    public abstract class AWebsocketController : IWebsocketController
+    {
+        public virtual Task OnOpen(Client client)
+        {
+            return Task.CompletedTask;
+        }
+
+        public virtual async Task OnTextMessage(Client client, string text)
+        {
+            await client.CloseAsync(WebSocketCloseStatus.InvalidMessageType, "Cannot process text message.");
+        }
+
+        public virtual async Task OnBinaryMessage(Client client, byte[] bytes)
+        {
+            await client.CloseAsync(WebSocketCloseStatus.InvalidMessageType, "Cannot process binary message.");
+        }
+
+        public virtual Task OnClose(Client client, WebSocketCloseStatus closeStatus, string closeStatusDescription)
+        {
+            return Task.CompletedTask;
+        }
+    }
+}
diff --git a/src/Client.cs b/src/Client.cs
@@ -0,0 +1,64 @@
+using System;
+using System.Net.WebSockets;
+using System.Security.Claims;
+using System.Text;
+using System.Threading;
+using System.Threading.Tasks;
+using Microsoft.AspNetCore.Http;
+
+namespace TimoStamm.WebSockets.Controller
+{
+    public class Client
+    {
+
+        private readonly WebSocket _webSocket;
+
+        private readonly HttpContext _context;
+
+
+        public Client(WebSocket webSocket, HttpContext context)
+        {
+            _webSocket = webSocket;
+            _context = context;
+            
+        }
+
+        
+        public ClaimsPrincipal User => _context.User;
+
+        public WebSocket WebSocket => _webSocket;
+        
+        public HttpContext Context => _context;
+
+        public string Id => _context.TraceIdentifier;
+
+        
+        public Task CloseAsync(
+            WebSocketCloseStatus closeStatus = WebSocketCloseStatus.NormalClosure,
+            string statusDescription = "Closing",
+            CancellationToken cancellationToken = default)
+        {
+            return _webSocket.CloseAsync(closeStatus, statusDescription, cancellationToken);
+        }
+        
+
+        public Task SendAsync(byte[] bytes, CancellationToken cancellationToken = default)
+        {
+            return _webSocket.SendAsync(new ArraySegment<byte>(bytes), WebSocketMessageType.Text, true, cancellationToken);
+        }
+
+        
+        public Task SendAsync(string text, CancellationToken cancellationToken = default)
+        {
+            var bytes = Encoding.UTF8.GetBytes(text);
+            return _webSocket.SendAsync(new ArraySegment<byte>(bytes), WebSocketMessageType.Text, true, cancellationToken);
+        }
+
+
+        public override string ToString()
+        {
+            return $"{base.ToString()}[{Id}]";
+        }
+        
+    }
+}
diff --git a/src/ClientCollection.cs b/src/ClientCollection.cs
diff --git a/src/ClientDictionary.cs b/src/ClientDictionary.cs
diff --git a/src/IWebsocketController.cs b/src/IWebsocketController.cs
diff --git a/src/WebSocketHandler.cs b/src/WebSocketHandler.cs
diff --git a/src/src.csproj b/src/src.csproj
