├── README.md
├── wsweb2
    ├── wsweb2.csproj
    ├── web.config
    ├── Program.cs
    ├── Properties
    │   └── launchSettings.json
    ├── wwwroot
    │   ├── index.html
    │   └── loop.html
    ├── Startup.cs
    └── SocketHandler.cs
├── LICENSE
├── wsweb.sln
└── .gitignore


/README.md:
--------------------------------------------------------------------------------
1 | # wsweb
2 | An minimal example of using WebSockets in ASP.NET Core
3 | 
4 | [A more detailed description of the example is available here](http://zbrad.github.io)
5 | 
6 | Updated for .Net Core 2.1


--------------------------------------------------------------------------------
/wsweb2/wsweb2.csproj:
--------------------------------------------------------------------------------
 1 | <Project Sdk="Microsoft.NET.Sdk.Web">
 2 | 
 3 |   <PropertyGroup>
 4 |     <TargetFramework>netcoreapp2.1</TargetFramework>
 5 |   </PropertyGroup>
 6 | 
 7 |   <ItemGroup>
 8 |     <PackageReference Include="Microsoft.AspNetCore.App" />
 9 |     <PackageReference Include="Microsoft.AspNetCore.Razor.Design" Version="2.1.2" PrivateAssets="All" />
10 |   </ItemGroup>
11 | 
12 | </Project>
13 | 


--------------------------------------------------------------------------------
/wsweb2/web.config:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <configuration>
 3 | 
 4 |   <!--
 5 |     Configure your application settings in appsettings.json. Learn more at http://go.microsoft.com/fwlink/?LinkId=786380
 6 |   -->
 7 | 
 8 |   <system.webServer>
 9 |     <handlers>
10 |       <add name="aspNetCore" path="*" verb="*" modules="AspNetCoreModule" resourceType="Unspecified"/>
11 |     </handlers>
12 |     <aspNetCore processPath="%LAUNCHER_PATH%" arguments="%LAUNCHER_ARGS%" stdoutLogEnabled="false" stdoutLogFile=".\logs\stdout" forwardWindowsAuthToken="false"/>
13 |   </system.webServer>
14 | </configuration>
15 | 


--------------------------------------------------------------------------------
/wsweb2/Program.cs:
--------------------------------------------------------------------------------
 1 | using System;
 2 | using System.Collections.Generic;
 3 | using System.IO;
 4 | using System.Linq;
 5 | using System.Threading.Tasks;
 6 | using Microsoft.AspNetCore;
 7 | using Microsoft.AspNetCore.Hosting;
 8 | using Microsoft.Extensions.Configuration;
 9 | using Microsoft.Extensions.Logging;
10 | 
11 | namespace wsweb2
12 | {
13 |     public class Program
14 |     {
15 |         public static void Main(string[] args)
16 |         {
17 |             var host = new WebHostBuilder()
18 |                 .UseKestrel()
19 |                 .UseContentRoot(Directory.GetCurrentDirectory())
20 |                 .UseIISIntegration()
21 |                 .UseStartup<Startup>()
22 |                 .Build();
23 | 
24 |             host.Run();
25 |         }
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/wsweb2/Properties/launchSettings.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "iisSettings": {
 3 |     "windowsAuthentication": false,
 4 |     "anonymousAuthentication": true,
 5 |     "iisExpress": {
 6 |       "applicationUrl": "http://localhost:51094/",
 7 |       "sslPort": 44377
 8 |     }
 9 |   },
10 |   "profiles": {
11 |     "IIS Express": {
12 |       "commandName": "IISExpress",
13 |       "launchBrowser": true,
14 |       "environmentVariables": {
15 |         "ASPNETCORE_ENVIRONMENT": "Development"
16 |       }
17 |     },
18 |     "wsweb2": {
19 |       "commandName": "Project",
20 |       "launchBrowser": true,
21 |       "environmentVariables": {
22 |         "ASPNETCORE_ENVIRONMENT": "Development"
23 |       },
24 |       "applicationUrl": "https://localhost:5001;http://localhost:5000"
25 |     }
26 |   }
27 | }


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | 
 3 | Copyright (c) 2016 Brad Merrill
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/wsweb.sln:
--------------------------------------------------------------------------------
 1 | 
 2 | Microsoft Visual Studio Solution File, Format Version 12.00
 3 | # Visual Studio Version 16
 4 | VisualStudioVersion = 16.0.28711.60
 5 | MinimumVisualStudioVersion = 10.0.40219.1
 6 | Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "wsweb2", "wsweb2\wsweb2.csproj", "{210CDBA3-0CD0-45B1-AC28-C2FA1A85BA2F}"
 7 | EndProject
 8 | Global
 9 | 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
10 | 		Debug|Any CPU = Debug|Any CPU
11 | 		Release|Any CPU = Release|Any CPU
12 | 	EndGlobalSection
13 | 	GlobalSection(ProjectConfigurationPlatforms) = postSolution
14 | 		{210CDBA3-0CD0-45B1-AC28-C2FA1A85BA2F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
15 | 		{210CDBA3-0CD0-45B1-AC28-C2FA1A85BA2F}.Debug|Any CPU.Build.0 = Debug|Any CPU
16 | 		{210CDBA3-0CD0-45B1-AC28-C2FA1A85BA2F}.Release|Any CPU.ActiveCfg = Release|Any CPU
17 | 		{210CDBA3-0CD0-45B1-AC28-C2FA1A85BA2F}.Release|Any CPU.Build.0 = Release|Any CPU
18 | 	EndGlobalSection
19 | 	GlobalSection(SolutionProperties) = preSolution
20 | 		HideSolutionNode = FALSE
21 | 	EndGlobalSection
22 | 	GlobalSection(ExtensibilityGlobals) = postSolution
23 | 		SolutionGuid = {960B372D-4461-4F1A-A44C-63C541AE6989}
24 | 	EndGlobalSection
25 | EndGlobal
26 | 


--------------------------------------------------------------------------------
/wsweb2/wwwroot/index.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | <html>
 3 | <head>
 4 |     <meta charset="utf-8" />
 5 |     <title>websocket loop test</title>
 6 |     <script language="javascript" type="text/javascript">
 7 |         var socket;
 8 |         var uri = "wss://" + window.location.host + "/ws";
 9 |         var output;
10 |         var text = "test echo";
11 | 
12 |         function write(s) {
13 |             var p = document.createElement("p");
14 |             p.innerHTML = s;
15 |             output.appendChild(p);
16 |         }
17 | 
18 |         function doConnect() {
19 |             socket = new WebSocket(uri);
20 |             socket.onopen = function (e) { write("opened " + uri); doSend(); };
21 |             socket.onclose = function (e) { write("closed"); };
22 |             socket.onmessage = function (e) { write("Received: " + e.data); socket.close(); };
23 |             socket.onerror = function (e) { write("Error: " + e.data); };
24 |         }
25 | 
26 |         function doSend() {
27 |             write("Sending: " + text);
28 |             socket.send(text);
29 |         }
30 | 
31 |         function onInit() {
32 |             output = document.getElementById("output");
33 |             doConnect();
34 |         }
35 | 
36 |         window.onload = onInit;
37 |     </script>
38 | </head>
39 | <body>
40 |     <div id="output"></div>
41 | </body>
42 | </html>


--------------------------------------------------------------------------------
/wsweb2/Startup.cs:
--------------------------------------------------------------------------------
 1 | using System;
 2 | using System.Collections.Generic;
 3 | using System.Linq;
 4 | using System.Threading.Tasks;
 5 | using Microsoft.AspNetCore.Builder;
 6 | using Microsoft.AspNetCore.Hosting;
 7 | using Microsoft.AspNetCore.Http;
 8 | using Microsoft.Extensions.DependencyInjection;
 9 | using Microsoft.Extensions.Logging;
10 | 
11 | namespace wsweb2
12 | {
13 |     public class Startup
14 |     {
15 |         // This method gets called by the runtime. Use this method to add services to the container.
16 |         // For more information on how to configure your application, visit https://go.microsoft.com/fwlink/?LinkID=398940
17 |         public void ConfigureServices(IServiceCollection services)
18 |         {
19 |         }
20 | 
21 |         // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
22 |         public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
23 |         {
24 |             loggerFactory.AddConsole();
25 | 
26 |             if (env.IsDevelopment())
27 |             {
28 |                 app.UseDeveloperExceptionPage();
29 |             }
30 | 
31 |             app.UseDefaultFiles(new DefaultFilesOptions
32 |             {
33 |                 DefaultFileNames = new List<string> { "index.html" }
34 |             });
35 |             app.UseStaticFiles();
36 | 
37 |             app.Map("/ws", SocketHandler.Map);
38 |         }
39 |     }
40 | }
41 | 


--------------------------------------------------------------------------------
/wsweb2/SocketHandler.cs:
--------------------------------------------------------------------------------
 1 | using System;
 2 | using System.Threading.Tasks;
 3 | using System.Text;
 4 | using System.Net.WebSockets;
 5 | using System.Threading;
 6 | using Microsoft.AspNetCore.Builder;
 7 | using Microsoft.AspNetCore.Http;
 8 | 
 9 | 
10 | namespace wsweb2
11 | {
12 |     public class SocketHandler
13 |     {
14 |         public const int BufferSize = 4096;
15 | 
16 |         WebSocket socket;
17 |         static readonly Encoding utf8 = Encoding.UTF8;
18 | 
19 |         SocketHandler(WebSocket socket)
20 |         {
21 |             this.socket = socket;
22 |         }
23 | 
24 |         async Task EchoLoop()
25 |         {
26 |             var buffer = new byte[BufferSize];
27 |             var seg = new ArraySegment<byte>(buffer);
28 | 
29 |             while (this.socket.State == WebSocketState.Open)
30 |             {
31 |                 var incoming = await this.socket.ReceiveAsync(seg, CancellationToken.None);
32 | 
33 |                 // show how to use the input and change the response
34 |                 var input = utf8.GetString(buffer, 0, incoming.Count);  // convert buffer to string
35 |                 var s = $"echo: {input}";            // add echo prefix
36 |                 var b = utf8.GetBytes(s);            // create outgoing bytes
37 | 
38 |                 var outgoing = new ArraySegment<byte>(b);
39 |                 await this.socket.SendAsync(outgoing, WebSocketMessageType.Text, true, CancellationToken.None);
40 |             }
41 |         }
42 | 
43 |         static async Task Acceptor(HttpContext hc, Func<Task> n)
44 |         {
45 |             if (!hc.WebSockets.IsWebSocketRequest)
46 |                 return;
47 | 
48 |             var socket = await hc.WebSockets.AcceptWebSocketAsync();
49 |             var h = new SocketHandler(socket);
50 |             await h.EchoLoop();
51 |         }
52 | 
53 |         /// <summary>
54 |         /// branches the request pipeline for this SocketHandler usage
55 |         /// </summary>
56 |         /// <param name="app"></param>
57 |         public static void Map(IApplicationBuilder app)
58 |         {
59 |             app.UseWebSockets();
60 |             app.Use(SocketHandler.Acceptor);
61 |         }
62 |     }
63 | }
64 | 


--------------------------------------------------------------------------------
/wsweb2/wwwroot/loop.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | <html>
 3 | <head>
 4 |     <meta charset="utf-8" />
 5 |     <title>websocket loop test</title>
 6 |     <script language="javascript" type="text/javascript">
 7 |         var socket = null;
 8 |         var uri = "wss://" + window.location.host + "/ws";
 9 |         var output;
10 | 
11 |         function write(s) {
12 |             var p = document.createElement("p");
13 |             p.innerHTML = s;
14 |             output.appendChild(p);
15 |         }
16 | 
17 |         function doConnect() {
18 |             socket = new WebSocket(uri);
19 |             socket.onopen = function (e) {
20 |                 write("opened " + uri);
21 |             };
22 |             socket.onclose = function (e) {
23 |                 write("closed");
24 |                 socket = null;
25 |             };
26 |             socket.onmessage = function (e) {
27 |                 write("Received: " + e.data);
28 |             };
29 |             socket.onerror = function (e) {
30 |                 if (e.data)
31 |                     write("Error: " + e.data);
32 |             };
33 |         }
34 | 
35 |         function doSendInput() {
36 |             if (socket == null) {
37 |                 write("socket is not connected");
38 |                 return;
39 |             }
40 | 
41 |             var text = document.getElementById("sendInput").value;
42 |             write("Sending: " + text);
43 |             socket.send(text);
44 |         }
45 | 
46 |         function onInit() {
47 |             output = document.getElementById("output");
48 |         }
49 | 
50 |         function doDisconnect() {
51 |             socket.close();
52 |         }
53 | 
54 |         window.onload = onInit;
55 |     </script>
56 | </head>
57 | <body>
58 | 
59 |         <table>
60 |             <tr>
61 |                 <td>
62 |                     <button onclick="doConnect()">Connect</button>
63 |                 </td>
64 |                 <td></td>
65 |                 <td>
66 |                     <button onclick="doDisconnect()">Disconnect</button>
67 |                 </td>
68 |             </tr>
69 |             <tr />
70 |             <tr>
71 |                 <td>
72 |                     Text
73 |                 </td>
74 |                 <td><input type="text" id="sendInput" value="echo this" /></td>
75 |                 <td>
76 |                     <button onclick="doSendInput()">Send</button>
77 |                 </td>
78 |             </tr>
79 |         </table>
80 | 
81 |     <hr/>
82 |     <div id="output"></div>
83 | </body>
84 | </html>
85 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
  1 | ## Ignore Visual Studio temporary files, build results, and
  2 | ## files generated by popular Visual Studio add-ons.
  3 | 
  4 | # User-specific files
  5 | *.suo
  6 | *.user
  7 | *.userosscache
  8 | *.sln.docstates
  9 | 
 10 | # User-specific files (MonoDevelop/Xamarin Studio)
 11 | *.userprefs
 12 | 
 13 | # Build results
 14 | [Dd]ebug/
 15 | [Dd]ebugPublic/
 16 | [Rr]elease/
 17 | [Rr]eleases/
 18 | x64/
 19 | x86/
 20 | bld/
 21 | [Bb]in/
 22 | [Oo]bj/
 23 | [Ll]og/
 24 | 
 25 | # Visual Studio 2015 cache/options directory
 26 | .vs/
 27 | # Uncomment if you have tasks that create the project's static files in wwwroot
 28 | #wwwroot/
 29 | 
 30 | # MSTest test Results
 31 | [Tt]est[Rr]esult*/
 32 | [Bb]uild[Ll]og.*
 33 | 
 34 | # NUNIT
 35 | *.VisualState.xml
 36 | TestResult.xml
 37 | 
 38 | # Build Results of an ATL Project
 39 | [Dd]ebugPS/
 40 | [Rr]eleasePS/
 41 | dlldata.c
 42 | 
 43 | # DNX
 44 | project.lock.json
 45 | artifacts/
 46 | 
 47 | *_i.c
 48 | *_p.c
 49 | *_i.h
 50 | *.ilk
 51 | *.meta
 52 | *.obj
 53 | *.pch
 54 | *.pdb
 55 | *.pgc
 56 | *.pgd
 57 | *.rsp
 58 | *.sbr
 59 | *.tlb
 60 | *.tli
 61 | *.tlh
 62 | *.tmp
 63 | *.tmp_proj
 64 | *.log
 65 | *.vspscc
 66 | *.vssscc
 67 | .builds
 68 | *.pidb
 69 | *.svclog
 70 | *.scc
 71 | 
 72 | # Chutzpah Test files
 73 | _Chutzpah*
 74 | 
 75 | # Visual C++ cache files
 76 | ipch/
 77 | *.aps
 78 | *.ncb
 79 | *.opendb
 80 | *.opensdf
 81 | *.sdf
 82 | *.cachefile
 83 | *.VC.db
 84 | *.VC.VC.opendb
 85 | 
 86 | # Visual Studio profiler
 87 | *.psess
 88 | *.vsp
 89 | *.vspx
 90 | *.sap
 91 | 
 92 | # TFS 2012 Local Workspace
 93 | $tf/
 94 | 
 95 | # Guidance Automation Toolkit
 96 | *.gpState
 97 | 
 98 | # ReSharper is a .NET coding add-in
 99 | _ReSharper*/
100 | *.[Rr]e[Ss]harper
101 | *.DotSettings.user
102 | 
103 | # JustCode is a .NET coding add-in
104 | .JustCode
105 | 
106 | # TeamCity is a build add-in
107 | _TeamCity*
108 | 
109 | # DotCover is a Code Coverage Tool
110 | *.dotCover
111 | 
112 | # NCrunch
113 | _NCrunch_*
114 | .*crunch*.local.xml
115 | nCrunchTemp_*
116 | 
117 | # MightyMoose
118 | *.mm.*
119 | AutoTest.Net/
120 | 
121 | # Web workbench (sass)
122 | .sass-cache/
123 | 
124 | # Installshield output folder
125 | [Ee]xpress/
126 | 
127 | # DocProject is a documentation generator add-in
128 | DocProject/buildhelp/
129 | DocProject/Help/*.HxT
130 | DocProject/Help/*.HxC
131 | DocProject/Help/*.hhc
132 | DocProject/Help/*.hhk
133 | DocProject/Help/*.hhp
134 | DocProject/Help/Html2
135 | DocProject/Help/html
136 | 
137 | # Click-Once directory
138 | publish/
139 | 
140 | # Publish Web Output
141 | *.[Pp]ublish.xml
142 | *.azurePubxml
143 | # TODO: Comment the next line if you want to checkin your web deploy settings
144 | # but database connection strings (with potential passwords) will be unencrypted
145 | *.pubxml
146 | *.publishproj
147 | 
148 | # Microsoft Azure Web App publish settings. Comment the next line if you want to
149 | # checkin your Azure Web App publish settings, but sensitive information contained
150 | # in these scripts will be unencrypted
151 | PublishScripts/
152 | 
153 | # NuGet Packages
154 | *.nupkg
155 | # The packages folder can be ignored because of Package Restore
156 | **/packages/*
157 | # except build/, which is used as an MSBuild target.
158 | !**/packages/build/
159 | # Uncomment if necessary however generally it will be regenerated when needed
160 | #!**/packages/repositories.config
161 | # NuGet v3's project.json files produces more ignoreable files
162 | *.nuget.props
163 | *.nuget.targets
164 | 
165 | # Microsoft Azure Build Output
166 | csx/
167 | *.build.csdef
168 | 
169 | # Microsoft Azure Emulator
170 | ecf/
171 | rcf/
172 | 
173 | # Windows Store app package directories and files
174 | AppPackages/
175 | BundleArtifacts/
176 | Package.StoreAssociation.xml
177 | _pkginfo.txt
178 | 
179 | # Visual Studio cache files
180 | # files ending in .cache can be ignored
181 | *.[Cc]ache
182 | # but keep track of directories ending in .cache
183 | !*.[Cc]ache/
184 | 
185 | # Others
186 | ClientBin/
187 | ~$*
188 | *~
189 | *.dbmdl
190 | *.dbproj.schemaview
191 | *.pfx
192 | *.publishsettings
193 | node_modules/
194 | orleans.codegen.cs
195 | 
196 | # Since there are multiple workflows, uncomment next line to ignore bower_components
197 | # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
198 | #bower_components/
199 | 
200 | # RIA/Silverlight projects
201 | Generated_Code/
202 | 
203 | # Backup & report files from converting an old project file
204 | # to a newer Visual Studio version. Backup files are not needed,
205 | # because we have git ;-)
206 | _UpgradeReport_Files/
207 | Backup*/
208 | UpgradeLog*.XML
209 | UpgradeLog*.htm
210 | 
211 | # SQL Server files
212 | *.mdf
213 | *.ldf
214 | 
215 | # Business Intelligence projects
216 | *.rdl.data
217 | *.bim.layout
218 | *.bim_*.settings
219 | 
220 | # Microsoft Fakes
221 | FakesAssemblies/
222 | 
223 | # GhostDoc plugin setting file
224 | *.GhostDoc.xml
225 | 
226 | # Node.js Tools for Visual Studio
227 | .ntvs_analysis.dat
228 | 
229 | # Visual Studio 6 build log
230 | *.plg
231 | 
232 | # Visual Studio 6 workspace options file
233 | *.opt
234 | 
235 | # Visual Studio LightSwitch build output
236 | **/*.HTMLClient/GeneratedArtifacts
237 | **/*.DesktopClient/GeneratedArtifacts
238 | **/*.DesktopClient/ModelManifest.xml
239 | **/*.Server/GeneratedArtifacts
240 | **/*.Server/ModelManifest.xml
241 | _Pvt_Extensions
242 | 
243 | # Paket dependency manager
244 | .paket/paket.exe
245 | paket-files/
246 | 
247 | # FAKE - F# Make
248 | .fake/
249 | 
250 | # JetBrains Rider
251 | .idea/
252 | *.sln.iml
253 | 


--------------------------------------------------------------------------------