SignalR Hub Example Update to 7 plus add Hub Client Results

signalr/hubs/samples/7.x/SignalRHubsSample/Hubs/ChatHub.cs

@@ -0,0 +1,11 @@
+using Microsoft.AspNetCore.SignalR;
+
+namespace SignalRHubsSample.Hubs;
+
+// <snippet_Class>
+public class ChatHub : Hub
+{
+    public async Task SendMessage(string user, string message)
+        => await Clients.All.SendAsync("ReceiveMessage", user, message);
+}
+// </snippet_Class>

signalr/hubs/samples/7.x/SignalRHubsSample/Pages/Error.cshtml

@@ -0,0 +1,26 @@
+@page
+@model ErrorModel
+@{
+    ViewData["Title"] = "Error";
+}
+
+<h1 class="text-danger">Error.</h1>
+<h2 class="text-danger">An error occurred while processing your request.</h2>
+
+@if (Model.ShowRequestId)
+{
+    <p>
+        <strong>Request ID:</strong> <code>@Model.RequestId</code>
+    </p>
+}
+
+<h3>Development Mode</h3>
+<p>
+    Swapping to the <strong>Development</strong> environment displays detailed information about the error that occurred.
+</p>
+<p>
+    <strong>The Development environment shouldn't be enabled for deployed applications.</strong>
+    It can result in displaying sensitive information from exceptions to end users.
+    For local debugging, enable the <strong>Development</strong> environment by setting the <strong>ASPNETCORE_ENVIRONMENT</strong> environment variable to <strong>Development</strong>
+    and restarting the app.
+</p>

signalr/hubs/samples/7.x/SignalRHubsSample/Pages/Error.cshtml.cs

@@ -0,0 +1,27 @@
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.Mvc.RazorPages;
+using System.Diagnostics;
+
+namespace SignalRHubsSample.Pages
+{
+    [ResponseCache(Duration = 0, Location = ResponseCacheLocation.None, NoStore = true)]
+    [IgnoreAntiforgeryToken]
+    public class ErrorModel : PageModel
+    {
+        public string? RequestId { get; set; }
+
+        public bool ShowRequestId => !string.IsNullOrEmpty(RequestId);
+
+        private readonly ILogger<ErrorModel> _logger;
+
+        public ErrorModel(ILogger<ErrorModel> logger)
+        {
+            _logger = logger;
+        }
+
+        public void OnGet()
+        {
+            RequestId = Activity.Current?.Id ?? HttpContext.TraceIdentifier;
+        }
+    }
+}

signalr/hubs/samples/7.x/SignalRHubsSample/Pages/Index.cshtml

@@ -0,0 +1,32 @@
+@page
+@model IndexModel
+
+@{
+    ViewData["Title"] = "Home";
+}
+
+<div class="form-group row">
+    <label for="userInput" class="col-2 col-form-label">User</label>
+    <div class="col col-sm-6">
+        <input id="userInput" class="form-control" />
+    </div>
+</div>
+
+<div class="form-group row">
+    <label for="message" class="col-2 col-form-label">Message</label>
+    <div class="col col-sm-6">
+        <input id="messageInput" class="form-control" />
+    </div>
+</div>
+
+<button id="send" type="button" class="btn btn-primary">Send Message</button>
+
+<hr>
+
+<ul id="messageList"></ul>
+
+@section Scripts
+    {
+    <script src="~/js/signalr/dist/browser/signalr.js"></script>
+    <script src="~/js/chat.js"></script>
+}

signalr/hubs/samples/7.x/SignalRHubsSample/Pages/Index.cshtml.cs

@@ -0,0 +1,20 @@
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.Mvc.RazorPages;
+
+namespace SignalRHubsSample.Pages
+{
+    public class IndexModel : PageModel
+    {
+        private readonly ILogger<IndexModel> _logger;
+
+        public IndexModel(ILogger<IndexModel> logger)
+        {
+            _logger = logger;
+        }
+
+        public void OnGet()
+        {
+
+        }
+    }
+}

signalr/hubs/samples/7.x/SignalRHubsSample/Pages/Privacy.cshtml

@@ -0,0 +1,8 @@
+@page
+@model PrivacyModel
+@{
+    ViewData["Title"] = "Privacy Policy";
+}
+<h1>@ViewData["Title"]</h1>
+
+<p>Use this page to detail your site's privacy policy.</p>

signalr/hubs/samples/7.x/SignalRHubsSample/Pages/Privacy.cshtml.cs

@@ -0,0 +1,19 @@
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.Mvc.RazorPages;
+
+namespace SignalRHubsSample.Pages
+{
+    public class PrivacyModel : PageModel
+    {
+        private readonly ILogger<PrivacyModel> _logger;
+
+        public PrivacyModel(ILogger<PrivacyModel> logger)
+        {
+            _logger = logger;
+        }
+
+        public void OnGet()
+        {
+        }
+    }
+}

signalr/hubs/samples/7.x/SignalRHubsSample/Pages/Shared/_Layout.cshtml

@@ -0,0 +1,51 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>@ViewData["Title"] - SignalRHubsSample</title>
+    <link rel="stylesheet" href="~/lib/bootstrap/dist/css/bootstrap.min.css" />
+    <link rel="stylesheet" href="~/css/site.css" asp-append-version="true" />
+    <link rel="stylesheet" href="~/SignalRHubsSample.styles.css" asp-append-version="true" />
+</head>
+<body>
+    <header>
+        <nav class="navbar navbar-expand-sm navbar-toggleable-sm navbar-light bg-white border-bottom box-shadow mb-3">
+            <div class="container">
+                <a class="navbar-brand" asp-area="" asp-page="/Index">SignalRHubsSample</a>
+                <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target=".navbar-collapse" aria-controls="navbarSupportedContent"
+                        aria-expanded="false" aria-label="Toggle navigation">
+                    <span class="navbar-toggler-icon"></span>
+                </button>
+                <div class="navbar-collapse collapse d-sm-inline-flex justify-content-between">
+                    <ul class="navbar-nav flex-grow-1">
+                        <li class="nav-item">
+                            <a class="nav-link text-dark" asp-area="" asp-page="/Index">Home</a>
+                        </li>
+                        <li class="nav-item">
+                            <a class="nav-link text-dark" asp-area="" asp-page="/Privacy">Privacy</a>
+                        </li>
+                    </ul>
+                </div>
+            </div>
+        </nav>
+    </header>
+    <div class="container">
+        <main role="main" class="pb-3">
+            @RenderBody()
+        </main>
+    </div>
+
+    <footer class="border-top footer text-muted">
+        <div class="container">
+            &copy; 2023 - SignalRHubsSample - <a asp-area="" asp-page="/Privacy">Privacy</a>
+        </div>
+    </footer>
+
+    <script src="~/lib/jquery/dist/jquery.min.js"></script>
+    <script src="~/lib/bootstrap/dist/js/bootstrap.bundle.min.js"></script>
+    <script src="~/js/site.js" asp-append-version="true"></script>
+
+    @await RenderSectionAsync("Scripts", required: false)
+</body>
+</html>

signalr/hubs/samples/7.x/SignalRHubsSample/Pages/Shared/_Layout.cshtml.css

@@ -0,0 +1,48 @@
+/* Please see documentation at https://docs.microsoft.com/aspnet/core/client-side/bundling-and-minification
+for details on configuring this project to bundle and minify static web assets. */
+
+a.navbar-brand {
+  white-space: normal;
+  text-align: center;
+  word-break: break-all;
+}
+
+a {
+  color: #0077cc;
+}
+
+.btn-primary {
+  color: #fff;
+  background-color: #1b6ec2;
+  border-color: #1861ac;
+}
+
+.nav-pills .nav-link.active, .nav-pills .show > .nav-link {
+  color: #fff;
+  background-color: #1b6ec2;
+  border-color: #1861ac;
+}
+
+.border-top {
+  border-top: 1px solid #e5e5e5;
+}
+.border-bottom {
+  border-bottom: 1px solid #e5e5e5;
+}
+
+.box-shadow {
+  box-shadow: 0 .25rem .75rem rgba(0, 0, 0, .05);
+}
+
+button.accept-policy {
+  font-size: 1rem;
+  line-height: inherit;
+}
+
+.footer {
+  position: absolute;
+  bottom: 0;
+  width: 100%;
+  white-space: nowrap;
+  line-height: 60px;
+}

signalr/hubs/samples/7.x/SignalRHubsSample/Pages/Shared/_ValidationScriptsPartial.cshtml

@@ -0,0 +1,2 @@
+<script src="~/lib/jquery-validation/dist/jquery.validate.min.js"></script>
+<script src="~/lib/jquery-validation-unobtrusive/jquery.validate.unobtrusive.min.js"></script>

signalr/hubs/samples/7.x/SignalRHubsSample/Pages/_ViewImports.cshtml

@@ -0,0 +1,3 @@
+@using SignalRHubsSample
+@namespace SignalRHubsSample.Pages
+@addTagHelper *, Microsoft.AspNetCore.Mvc.TagHelpers

signalr/hubs/samples/7.x/SignalRHubsSample/Pages/_ViewStart.cshtml

@@ -0,0 +1,3 @@
+@{
+    Layout = "_Layout";
+}

signalr/hubs/samples/7.x/SignalRHubsSample/Program.cs

@@ -0,0 +1,30 @@
+using SignalRHubsSample.Hubs;
+
+// <snippet_AddSignalR>
+var builder = WebApplication.CreateBuilder(args);
+
+builder.Services.AddRazorPages();
+builder.Services.AddSignalR();
+// </snippet_AddSignalR>
+
+var app = builder.Build();
+
+if (!app.Environment.IsDevelopment())
+{
+    app.UseExceptionHandler("/Error");
+    app.UseHsts();
+}
+
+app.UseHttpsRedirection();
+app.UseStaticFiles();
+
+app.UseRouting();
+
+app.UseAuthorization();
+
+// <snippet_MapHub>
+app.MapRazorPages();
+app.MapHub<ChatHub>("/Chat");
+
+app.Run();
+// </snippet_MapHub>

signalr/hubs/samples/7.x/SignalRHubsSample/SignalRHubsSample.csproj

@@ -0,0 +1,9 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+  <PropertyGroup>
+    <TargetFramework>net7.0</TargetFramework>
+    <Nullable>enable</Nullable>
+    <ImplicitUsings>enable</ImplicitUsings>
+  </PropertyGroup>
+
+</Project>

signalr/hubs/samples/7.x/SignalRHubsSample/Snippets/Hubs/ChatHub.cs

@@ -0,0 +1,43 @@
+using Microsoft.AspNetCore.SignalR;
+
+namespace SignalRHubsSample.Snippets.Hubs;
+
+public class ChatHub : Hub
+{
+    // <snippet_OnConnectedAsync>
+    public override async Task OnConnectedAsync()
+    {
+        await Groups.AddToGroupAsync(Context.ConnectionId, "SignalR Users");
+        await base.OnConnectedAsync();
+    }
+    // </snippet_OnConnectedAsync>
+
+    // <snippet_OnDisconnectedAsync>
+    public override async Task OnDisconnectedAsync(Exception? exception)
+    {
+        await base.OnDisconnectedAsync(exception);
+    }
+    // </snippet_OnDisconnectedAsync>
+
+    // <snippet_Clients>
+    public async Task SendMessage(string user, string message)
+        => await Clients.All.SendAsync("ReceiveMessage", user, message);
+
+    public async Task SendMessageToCaller(string user, string message)
+        => await Clients.Caller.SendAsync("ReceiveMessage", user, message);
+
+    public async Task SendMessageToGroup(string user, string message)
+        => await Clients.Group("SignalR Users").SendAsync("ReceiveMessage", user, message);
+    // </snippet_Clients>
+
+    // <snippet_HubMethodName>
+    [HubMethodName("SendMessageToUser")]
+    public async Task DirectMessage(string user, string message)
+        => await Clients.User(user).SendAsync("ReceiveMessage", user, message);
+    // </snippet_HubMethodName>
+
+    // <snippet_ThrowException>
+    public Task ThrowException()
+        => throw new HubException("This error will be sent to the client!");
+    // </snippet_ThrowException>
+}

signalr/hubs/samples/7.x/SignalRHubsSample/Snippets/Hubs/ChatHubClientResults.cs

@@ -0,0 +1,28 @@
+using Microsoft.AspNetCore.SignalR;
+using static System.Runtime.InteropServices.JavaScript.JSType;
+
+namespace SignalRHubsSample.Hubs;
+// <snippet_HubClientReturn>
+public class ChatHubClientReturn : Hub
+{
+    public async Task<string> WaitForMessage(string connectionId)
+    {
+        using var cts = new CancellationTokenSource(TimeSpan.FromSeconds(30));
+        try
+        {
+            var message = await Clients.Client(connectionId).InvokeAsync<string>(
+                "GetMessage", cts.Token);
+            return message;
+        }
+        catch (OperationCanceledException ex)
+        {
+            // timeout occurred
+            return "Timed out waiting for client input";
+        }
+        catch (Exception ex)
+        {
+            return "Error waiting for client result";
+        }
+    }
+    // </snippet_HubClientReturn>
+}

signalr/hubs/samples/7.x/SignalRHubsSample/Snippets/Hubs/ChatHubClientResultsContext.cs

@@ -0,0 +1,14 @@
+using Microsoft.AspNetCore.SignalR;
+using static System.Runtime.InteropServices.JavaScript.JSType;
+
+namespace SignalRHubsSample.Hubs;
+// <snippet_HubClientReturnContext>
+public class ChatHubClientResultsContext : Hub
+{
+    async Task SomeMethod(IHubContext<ChatHubClientResultsContext> context)
+    {
+        string result = await context.Clients.Client(connectionID).InvokeAsync<string>(
+            "GetMessage");
+    }
+    // </snippet_HubClientReturnContext>
+}